SCR_EditorContentBrowserDisplayConfig Interface Reference

Config that allows the editor content browser to only show specific labels and groups. More...

Public Member Functions
LocalizedString	GetHeader ()
	Get the header to set in the content browser.
bool	CanShowLabelGroup (EEditableEntityLabelGroup groupLabel)
	Returns if given label group can be showin in content browser.
bool	CanShowLabel (EEditableEntityLabel label)
	Returns if given label can be showin in content browser.
void	GetAlwaysActiveLabels (out notnull array< EEditableEntityLabel > alwaysActiveLabels)
	Get list of labels that are always active in content browser.
void	GetWhiteListeLabels (out notnull array< EEditableEntityLabel > whitelistLabels)
	Get list of labels that are always active in content browser.
void	GetWhiteListeLabelGroups (out notnull array< EEditableEntityLabelGroup > whitelistLabelGroups)
	Get list of labels that are always active in content browser.
bool	IsAlwaysActiveLabel (EEditableEntityLabel label)
	Check if given label is always active.
bool	CanShowLabelInActiveFilters (EEditableEntityLabel label)
	Check if given label can be shown as active filters.
bool	GetSaveContentBrowserState ()
	Check if content browser can save the state on close if using the config.
void	SCR_EditorContentBrowserDisplayConfig (array< EEditableEntityLabelGroup > whiteListGroupLabels=null, array< EEditableEntityLabel > whiteListLabels=null, array< EEditableEntityLabel > alwaysActiveLabels=null, bool saveContentBrowserState=false, LocalizedString browserHeader=string.Empty)
	Create new Display config.

Protected Attributes
LocalizedString	m_sContentBrowserHeader
ref array< ref SCR_EditorContentBrowserDisplayGroupLabel >	m_aWhiteListLabelGroups
ref array< ref SCR_EditorContentBrowserActiveDisplayLabel >	m_aAlwaysActiveLabels
ref array< ref SCR_EditorContentBrowserDisplayLabel >	m_aWhiteListLabels
bool	m_bSaveContentBrowserState

Detailed Description

Config that allows the editor content browser to only show specific labels and groups.

Constructor & Destructor Documentation

SCR_EditorContentBrowserDisplayConfig()

void SCR_EditorContentBrowserDisplayConfig.SCR_EditorContentBrowserDisplayConfig	(	array< EEditableEntityLabelGroup >	whiteListGroupLabels = null,
		array< EEditableEntityLabel >	whiteListLabels = null,
		array< EEditableEntityLabel >	alwaysActiveLabels = null,
		bool	saveContentBrowserState = false,
		LocalizedString	browserHeader = string::Empty
	)

Create new Display config.

Parameters

whiteListGroupLabels	List of white list label groups
whiteListLabels	List of white list label
alwaysActiveLabels	List of labels that should always be active if opening content browser with this config
saveContentBrowserState	If this config allows for saving of the Content Browser state. If this config is temporarly created then keep it false

Returns

self (Created config)

Member Function Documentation

CanShowLabel()

bool SCR_EditorContentBrowserDisplayConfig.CanShowLabel

(

EEditableEntityLabel

label

)

Returns if given label can be showin in content browser.

Parameters

label

to check

Returns

false if it cannot be displayed

CanShowLabelGroup()

bool SCR_EditorContentBrowserDisplayConfig.CanShowLabelGroup

(

EEditableEntityLabelGroup

groupLabel

)

Returns if given label group can be showin in content browser.

Parameters

Group

label to check

Returns

false if it cannot be displayed

CanShowLabelInActiveFilters()

bool SCR_EditorContentBrowserDisplayConfig.CanShowLabelInActiveFilters

(

EEditableEntityLabel

label

)

Check if given label can be shown as active filters.

Parameters

label

to check

Returns

false if given label is an always active label

GetAlwaysActiveLabels()

void SCR_EditorContentBrowserDisplayConfig.GetAlwaysActiveLabels

(

out notnull array< EEditableEntityLabel >

alwaysActiveLabels

)

Get list of labels that are always active in content browser.

Parameters

[out]

alwaysActiveLabels

list of always active labels

GetHeader()

LocalizedString SCR_EditorContentBrowserDisplayConfig.GetHeader

(

)

Get the header to set in the content browser.

Returns

Header string

GetSaveContentBrowserState()

bool SCR_EditorContentBrowserDisplayConfig.GetSaveContentBrowserState

(

)

Check if content browser can save the state on close if using the config.

Returns

true if it allows it

GetWhiteListeLabelGroups()

void SCR_EditorContentBrowserDisplayConfig.GetWhiteListeLabelGroups

(

out notnull array< EEditableEntityLabelGroup >

whitelistLabelGroups

)

Get list of labels that are always active in content browser.

Parameters

[out]

alwaysActiveLabels

list of always active labels

GetWhiteListeLabels()

void SCR_EditorContentBrowserDisplayConfig.GetWhiteListeLabels

(

out notnull array< EEditableEntityLabel >

whitelistLabels

)

Get list of labels that are always active in content browser.

Parameters

[out]

alwaysActiveLabels

list of always active labels

IsAlwaysActiveLabel()

bool SCR_EditorContentBrowserDisplayConfig.IsAlwaysActiveLabel

(

EEditableEntityLabel

label

)

Check if given label is always active.

Parameters

label

to check

Returns

true if label is always active (And can be shown if checked

Member Data Documentation

m_aAlwaysActiveLabels

ref array<ref SCR_EditorContentBrowserActiveDisplayLabel> SCR_EditorContentBrowserDisplayConfig.m_aAlwaysActiveLabels

protected

m_aWhiteListLabelGroups

ref array<ref SCR_EditorContentBrowserDisplayGroupLabel> SCR_EditorContentBrowserDisplayConfig.m_aWhiteListLabelGroups

protected

m_aWhiteListLabels

ref array<ref SCR_EditorContentBrowserDisplayLabel> SCR_EditorContentBrowserDisplayConfig.m_aWhiteListLabels

protected

m_bSaveContentBrowserState

bool SCR_EditorContentBrowserDisplayConfig.m_bSaveContentBrowserState

protected

m_sContentBrowserHeader

LocalizedString SCR_EditorContentBrowserDisplayConfig.m_sContentBrowserHeader

protected

---

The documentation for this interface was generated from the following file:

• Game/Editor/Containers/Root/SCR_EditorContentBrowserDisplayConfig.c