Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_ContentBrowserEditorComponent Class Reference
Editor » Entities » Editor Components
Inheritance diagram for SCR_ContentBrowserEditorComponent:
SCR_BaseEditorComponent

Protected Member Functions

ResourceName GetResourceNamePrefabID (int prefabID)
int GetFilteredPrefabID (int index)
bool IsPrefabIDAvailable (int prefabID)
int GetFilteredPrefabCount ()
bool AreFactionsShownOnContentCards ()
int FilterExtendedSlots ()
 Filters all prefab IDs that match the extended entity.
bool IsExtendedEntity (notnull SCR_EditableEntityComponent entity)
int GetValidBlackListedLabels (out notnull array< EEditableEntityLabel > validBlackListLabels)
SCR_EditableEntityCache FindExtendedEntityCache (ResourceName extendedEntityResource)
void FilterEntries ()
bool isMatchingToggledLabelsOfState (int savedStateIndex)
bool IsMatchingToggledLabels (notnull array< EEditableEntityLabel > entityLabels)
bool IsLabelActive (EEditableEntityLabel entityLabel)
bool IsAnyLabelActive ()
void SetLabel (EEditableEntityLabel entityLabel, bool active)
void ResetAllLabels (bool setConfigData=true)
void GetActiveLabels (out notnull array< EEditableEntityLabel > activeLabels)
int GetActiveLabelCount ()
void GetLabelGroups (out notnull array< ref SCR_EditableEntityCoreLabelGroupSetting > labelGroups)
bool GetLabelGroupType (EEditableEntityLabel entityLabel, out EEditableEntityLabelGroup groupLabel)
int GetLabelGroupOrder (EEditableEntityLabelGroup groupLabel)
bool GetLabelsOfGroup (EEditableEntityLabelGroup labelGroupType, out notnull array< SCR_EditableEntityCoreLabelSetting > labels)
bool GetLabelUIInfo (EEditableEntityLabel entityLabel, out SCR_UIInfo uiInfo)
bool GetLabelUIInfoIfValid (EEditableEntityLabel entityLabel, EEditorMode currentMode, out SCR_UIInfo uiInfo)
void OrderLabels (inout notnull array< EEditableEntityLabel > activeLabels)
int GetLabelOrderInGroup (EEditableEntityLabel entityLabel)
string GetLabelName (EEditableEntityLabel entityLabel)
void SetPageIndex (int pageIndex)
int GetPageIndex ()
void SetPageEntryCount (int pageEntryCount)
int GetPageEntryCount ()
void SetBrowserStateIndex (int index)
int GetBrowserStateIndex ()
void GetHiddenStateTabs (out notnull array< int > hiddenStateTabs)
void SetStateTabVisible (int tabIndex, bool setVisible)
int GetContentBrowserTabStates (out notnull array< SCR_EditorContentBrowserSaveStateDataUI > contentBrowserStates)
SCR_EditorContentBrowserSaveStateData GetContentBrowserTabState (int index=-1)
string GetLastSearch ()
string GetCurrentSearch ()
void SetCurrentSearch (string searchText)
void SetSaveStateTabsEnabled (bool enabled)
bool CanSavePersistentBrowserStates ()
ScriptInvoker GetOnLabelChanged ()
ScriptInvoker GetOnBrowserStatesSaved ()
ScriptInvoker GetOnBrowserStatePreload ()
ScriptInvoker GetOnBrowserStateLoaded ()
ScriptInvoker GetOnBrowserEntriesFiltered ()
ScriptInvoker GetOnBrowserStateCleared ()
ScriptInvoker GetOnEnableSaveStateTabs ()
ScriptInvoker GetOnSearchConfirm ()
ScriptInvoker GetOnStateTabVisibilityChanged ()
void SetExtendedEntity (SCR_EditableEntityComponent extendedEntity)
SCR_EditableEntityComponent GetExtendedEntity ()
int GetInfoCount ()
SCR_EditableEntityUIInfo GetInfo (int index)
int FindIndexOfInfo (SCR_EditableEntityUIInfo info)
bool GetFirstAvailabeBudgetCost (int prefabID, out SCR_EntityBudgetValue budgetCost)
bool CanPlace (int prefabID, out notnull array< ref SCR_EntityBudgetValue > budgetCosts, out SCR_UIInfo blockingBudgetInfo, bool showNotification=false, out EEditableEntityBudget blockingBudget=-1)
bool CanPlace (notnull array< ResourceName > prefabs, EEditableEntityType fallbackBudgetType=-1)
bool RefreshPreviewCost (int prefabID=-1)
bool OpenBrowserExtended (SCR_EditableEntityComponent extendedEntity, SCR_EditorContentBrowserDisplayConfig contentBrowserConfig=null)
bool OpenBrowser (int browserStateIndex=-1)
bool OpenBrowserState (SCR_EditorContentBrowserSaveStateData saveState, SCR_EditorContentBrowserDisplayConfig displayConfig=null)
bool OpenBrowserLabelConfig (SCR_EditorContentBrowserDisplayConfig contentBrowserConfig)
void SetBrowserState (int browserStateIndex=-1, bool saveCurrentState=false, bool clearConfigData=true)
void SetCustomBrowserState (SCR_EditorContentBrowserSaveStateData state, bool clearConfigData=true)
void SetBrowserState (SCR_EditorContentBrowserDisplayConfig contentBrowserConfig, bool saveCurrentState=false)
bool SaveBrowserState ()
void AddRemoveLabelOfPersistentBrowserState (EEditableEntityLabel label, bool addLabel, int stateIndex=-1)
void ResetBrowserState (bool clearConfigData)
void OnPlaceEntityServer (int prefabID, SCR_EditableEntityComponent entity)
void OnMenuClosed ()
bool OpenBrowserMenu ()
void ClearBrowserState (bool clearConfigData)
void LoadBrowserState (int stateIndex, bool clearConfigData)
void LoadBrowserState (SCR_EditorContentBrowserSaveStateData state, bool clearConfigData)
bool GetConfigState (SCR_EditorContentBrowserDisplayConfig browserConfig, out SCR_EditorContentBrowserSaveStateData state)
void SetConfigLabels ()
SCR_EditorContentBrowserDisplayConfig GetContentBrowserDisplayConfig ()
void SaveAllPersistentBrowserState ()
void LoadAllPersistentBrowserState ()
override void EOnEditorInit ()
override void EOnEditorActivateServer ()
override void EOnEditorDeactivateServer ()
override void EOnEditorActivate ()
override bool EOnEditorActivateAsync (int attempt)
override void EOnEditorDeactivate ()

Static Protected Member Functions

static bool OpenBrowserInstance (int browserStateIndex=-1)
static bool OpenBrowserInstance (SCR_EditorContentBrowserSaveStateData saveState)
static bool OpenBrowserLabelConfigInstance (SCR_EditorContentBrowserDisplayConfig contentBrowserConfig=null)

Protected Attributes

bool m_bShowFactionOnContentBrowserCards
const int ASYNC_TICK_LENGTH = 16
bool m_bUsePersistentBrowserStates
ref array< ref SCR_EditorContentBrowserSaveStateDataUI > m_aContentBrowserTabStates
ref array< EEditableEntityLabel > m_eBlackListedLabels
ref map< ref SCR_EditorContentBrowserDisplayConfig, ref SCR_EditorContentBrowserSaveStateData > m_mContentBrowserConfigStates = new map<ref SCR_EditorContentBrowserDisplayConfig, ref SCR_EditorContentBrowserSaveStateData>
ref set< ref SCR_EditableEntityCache > m_aExtendedEntitiesCache = new set<ref SCR_EditableEntityCache>()
ref SCR_EditorContentBrowserDisplayConfig m_ContentBrowserConfig
ref array< ref SCR_EditableEntityCoreLabelGroupSetting > m_LabelGroups = {}
ref array< int > m_aHiddenStateTabs = {}
ref array< int > m_aFilteredPrefabIDs = {}
ref array< string > m_aLocalizationKeys = {}
int m_iFilteredPrefabIDsCount
SCR_MenuEditorComponent m_EditorMenuManager
SCR_PlacingEditorComponent m_PlacingManager
SCR_PlacingEditorComponentClass m_PlacingManagerData
SCR_BudgetEditorComponent m_BudgetManager
SCR_PrefabsCacheEditorComponent m_PrefabsCache
ref array< ref SCR_EditableEntityUIInfo > m_aInfos
ref array< ResourceName > m_aAsyncPrefabs
int m_iAsyncIndex
int m_iBrowserStateIndex = 0
int m_iPageIndex
int m_iPageEntryCount = 15
string m_sCurrentSearchText
string m_sLastSearchText
bool m_bShowEntityBudgetCost
SCR_EditableEntityComponent m_ExtendedEntity
SCR_EditableEntityCore m_EntityCore
ref ScriptInvoker Event_OnLabelChanged = new ScriptInvoker
ref ScriptInvoker Event_OnSearchConfirm = new ScriptInvoker
ref ScriptInvoker Event_OnBrowserStatesSaved = new ScriptInvoker
ref ScriptInvoker Event_OnBrowserStatePreload = new ScriptInvoker
ref ScriptInvoker Event_OnBrowserStateLoaded = new ScriptInvoker
ref ScriptInvoker Event_OnBrowserEntriesFiltered = new ScriptInvoker
ref ScriptInvoker Event_OnBrowserStateCleared = new ScriptInvoker
ref ScriptInvoker Event_OnEnableSaveStateTabs = new ScriptInvoker
ref ScriptInvoker Event_OnStateTabVisibilityChanged = new ScriptInvoker

Detailed Description

Management of placeable entities.

Definition at line 16 of file SCR_ContentBrowserEditorComponent.c.

Member Function Documentation

◆ AddRemoveLabelOfPersistentBrowserState()

void SCR_ContentBrowserEditorComponent::AddRemoveLabelOfPersistentBrowserState ( EEditableEntityLabel label,
bool addLabel,
int stateIndex = -1 )
inlineprotected

Add or remove the given label

Parameters
labelLabel to add or remove
addLabelIf true will add the label. Else will remove
stateIndexIndex of state to add/remove label off. Set to -1 to add/remove label of all states

Definition at line 1207 of file SCR_ContentBrowserEditorComponent.c.

◆ AreFactionsShownOnContentCards()

bool SCR_ContentBrowserEditorComponent::AreFactionsShownOnContentCards ( )
inlineprotected
Returns
Returns if faction should be shown on contentbrowser cards

Definition at line 138 of file SCR_ContentBrowserEditorComponent.c.

◆ CanPlace() [1/2]

bool SCR_ContentBrowserEditorComponent::CanPlace ( int prefabID,
out notnull array< ref SCR_EntityBudgetValue > budgetCosts,
out SCR_UIInfo blockingBudgetInfo,
bool showNotification = false,
out EEditableEntityBudget blockingBudget = -1 )
inlineprotected

Definition at line 843 of file SCR_ContentBrowserEditorComponent.c.

◆ CanPlace() [2/2]

bool SCR_ContentBrowserEditorComponent::CanPlace ( notnull array< ResourceName > prefabs,
EEditableEntityType fallbackBudgetType = -1 )
inlineprotected

If there is enough budget for the given list or Prefabs to spawn

Parameters
prefabsPrefabs to get budget of
fallbackBudgetTypeIf the system fails to get the budget then if fallbackBudgetType is not -1 it will fall back and get the default budget of the given type
Returns
Returns true if can place, else returns false

Definition at line 869 of file SCR_ContentBrowserEditorComponent.c.

◆ CanSavePersistentBrowserStates()

bool SCR_ContentBrowserEditorComponent::CanSavePersistentBrowserStates ( )
inlineprotected

Get can save persistent browser states.

Definition at line 677 of file SCR_ContentBrowserEditorComponent.c.

◆ ClearBrowserState()

void SCR_ContentBrowserEditorComponent::ClearBrowserState ( bool clearConfigData)
inlineprotected

Definition at line 1264 of file SCR_ContentBrowserEditorComponent.c.

◆ EOnEditorActivate()

override void SCR_ContentBrowserEditorComponent::EOnEditorActivate ( )
inlineprotected

Definition at line 1444 of file SCR_ContentBrowserEditorComponent.c.

◆ EOnEditorActivateAsync()

override bool SCR_ContentBrowserEditorComponent::EOnEditorActivateAsync ( int attempt)
inlineprotected

Definition at line 1454 of file SCR_ContentBrowserEditorComponent.c.

◆ EOnEditorActivateServer()

override void SCR_ContentBrowserEditorComponent::EOnEditorActivateServer ( )
inlineprotected

Definition at line 1426 of file SCR_ContentBrowserEditorComponent.c.

◆ EOnEditorDeactivate()

override void SCR_ContentBrowserEditorComponent::EOnEditorDeactivate ( )
inlineprotected

Definition at line 1493 of file SCR_ContentBrowserEditorComponent.c.

◆ EOnEditorDeactivateServer()

override void SCR_ContentBrowserEditorComponent::EOnEditorDeactivateServer ( )
inlineprotected

Definition at line 1438 of file SCR_ContentBrowserEditorComponent.c.

◆ EOnEditorInit()

override void SCR_ContentBrowserEditorComponent::EOnEditorInit ( )
inlineprotected

Definition at line 1414 of file SCR_ContentBrowserEditorComponent.c.

◆ FilterEntries()

void SCR_ContentBrowserEditorComponent::FilterEntries ( )
inlineprotected

Filter entries cached on component with current filters

Returns
bool True when provided labels match active labels

Definition at line 243 of file SCR_ContentBrowserEditorComponent.c.

◆ FilterExtendedSlots()

int SCR_ContentBrowserEditorComponent::FilterExtendedSlots ( )
inlineprotected

Filters all prefab IDs that match the extended entity.

Returns
int Amount of Prefab IDs that got filtered.

Definition at line 148 of file SCR_ContentBrowserEditorComponent.c.

◆ FindExtendedEntityCache()

SCR_EditableEntityCache SCR_ContentBrowserEditorComponent::FindExtendedEntityCache ( ResourceName extendedEntityResource)
inlineprotected

Definition at line 207 of file SCR_ContentBrowserEditorComponent.c.

◆ FindIndexOfInfo()

int SCR_ContentBrowserEditorComponent::FindIndexOfInfo ( SCR_EditableEntityUIInfo info)
inlineprotected

Find index of given editable entity (info), used for find in content browser

Parameters
infoEditableEntityInfo of the entity
Returns
int index of editable entity in content browser, -1 if not found

Definition at line 813 of file SCR_ContentBrowserEditorComponent.c.

◆ GetActiveLabelCount()

int SCR_ContentBrowserEditorComponent::GetActiveLabelCount ( )
inlineprotected

Definition at line 437 of file SCR_ContentBrowserEditorComponent.c.

◆ GetActiveLabels()

void SCR_ContentBrowserEditorComponent::GetActiveLabels ( out notnull array< EEditableEntityLabel > activeLabels)
inlineprotected

Definition at line 432 of file SCR_ContentBrowserEditorComponent.c.

◆ GetBrowserStateIndex()

int SCR_ContentBrowserEditorComponent::GetBrowserStateIndex ( )
inlineprotected

Get the index of the Browser state (which is set by tabs in content browser)

Returns
Current Browser state index

Definition at line 567 of file SCR_ContentBrowserEditorComponent.c.

◆ GetConfigState()

bool SCR_ContentBrowserEditorComponent::GetConfigState ( SCR_EditorContentBrowserDisplayConfig browserConfig,
out SCR_EditorContentBrowserSaveStateData state )
inlineprotected

Definition at line 1321 of file SCR_ContentBrowserEditorComponent.c.

◆ GetContentBrowserDisplayConfig()

SCR_EditorContentBrowserDisplayConfig SCR_ContentBrowserEditorComponent::GetContentBrowserDisplayConfig ( )
inlineprotected

Get the set content browser config

Returns
SCR_EditorContentBrowserDisplayConfig config

Definition at line 1351 of file SCR_ContentBrowserEditorComponent.c.

◆ GetContentBrowserTabState()

SCR_EditorContentBrowserSaveStateData SCR_ContentBrowserEditorComponent::GetContentBrowserTabState ( int index = -1)
inlineprotected

Get Browser content browser state by index

Parameters
Indexof state, use -1 to get current tab state
Returns
State

Definition at line 619 of file SCR_ContentBrowserEditorComponent.c.

◆ GetContentBrowserTabStates()

int SCR_ContentBrowserEditorComponent::GetContentBrowserTabStates ( out notnull array< SCR_EditorContentBrowserSaveStateDataUI > contentBrowserStates)
inlineprotected

Get list of all Browser content browser states

Parameters
[out]Listof all states
Returns
Count of states

Definition at line 606 of file SCR_ContentBrowserEditorComponent.c.

◆ GetCurrentSearch()

string SCR_ContentBrowserEditorComponent::GetCurrentSearch ( )
inlineprotected

Get current search string

Returns
Current search string

Definition at line 650 of file SCR_ContentBrowserEditorComponent.c.

◆ GetExtendedEntity()

SCR_EditableEntityComponent SCR_ContentBrowserEditorComponent::GetExtendedEntity ( )
inlineprotected

Get extended entity. The value gets erased during retrieval.

Returns
Extended entity

Definition at line 777 of file SCR_ContentBrowserEditorComponent.c.

◆ GetFilteredPrefabCount()

int SCR_ContentBrowserEditorComponent::GetFilteredPrefabCount ( )
inlineprotected

Get prefab ID of item at given index

Parameters
indexIndex of entry in filtered list/grid
Returns
int Prefab ID of entity at index

Definition at line 129 of file SCR_ContentBrowserEditorComponent.c.

◆ GetFilteredPrefabID()

int SCR_ContentBrowserEditorComponent::GetFilteredPrefabID ( int index)
inlineprotected

Get prefab ID of item at given index

Parameters
indexIndex of entry in filtered list/grid
Returns
int Prefab ID of entity at index

Definition at line 103 of file SCR_ContentBrowserEditorComponent.c.

◆ GetFirstAvailabeBudgetCost()

bool SCR_ContentBrowserEditorComponent::GetFirstAvailabeBudgetCost ( int prefabID,
out SCR_EntityBudgetValue budgetCost )
inlineprotected

Definition at line 828 of file SCR_ContentBrowserEditorComponent.c.

◆ GetHiddenStateTabs()

void SCR_ContentBrowserEditorComponent::GetHiddenStateTabs ( out notnull array< int > hiddenStateTabs)
inlineprotected

Get an array of all currently hidden state tabs

Parameters
[out]hiddenStateTabsArray of hidden state tabs

Definition at line 578 of file SCR_ContentBrowserEditorComponent.c.

◆ GetInfo()

SCR_EditableEntityUIInfo SCR_ContentBrowserEditorComponent::GetInfo ( int index)
inlineprotected

Get info for placeaable prefab with given index. Infos are store dint he same order as prefabs from SCR_PlacingEditorComponentClass.

Parameters
Prefabindex
Returns
UI info

Definition at line 800 of file SCR_ContentBrowserEditorComponent.c.

◆ GetInfoCount()

int SCR_ContentBrowserEditorComponent::GetInfoCount ( )
inlineprotected

Get info for placeaable prefab with given index.

Returns
Total UI info count

Definition at line 786 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelGroupOrder()

int SCR_ContentBrowserEditorComponent::GetLabelGroupOrder ( EEditableEntityLabelGroup groupLabel)
inlineprotected

Get the order of the given group type

Parameters
groupLabelgiven group type
Returns
order

Definition at line 457 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelGroups()

void SCR_ContentBrowserEditorComponent::GetLabelGroups ( out notnull array< ref SCR_EditableEntityCoreLabelGroupSetting > labelGroups)
inlineprotected

Definition at line 442 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelGroupType()

bool SCR_ContentBrowserEditorComponent::GetLabelGroupType ( EEditableEntityLabel entityLabel,
out EEditableEntityLabelGroup groupLabel )
inlineprotected

Definition at line 447 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelName()

string SCR_ContentBrowserEditorComponent::GetLabelName ( EEditableEntityLabel entityLabel)
inlineprotected

Get label name of given Label type

Returns
Label name

Definition at line 516 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelOrderInGroup()

int SCR_ContentBrowserEditorComponent::GetLabelOrderInGroup ( EEditableEntityLabel entityLabel)
inlineprotected

Get order of given label type in it's label group

Returns
Label order

Definition at line 490 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelsOfGroup()

bool SCR_ContentBrowserEditorComponent::GetLabelsOfGroup ( EEditableEntityLabelGroup labelGroupType,
out notnull array< SCR_EditableEntityCoreLabelSetting > labels )
inlineprotected

Definition at line 462 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelUIInfo()

bool SCR_ContentBrowserEditorComponent::GetLabelUIInfo ( EEditableEntityLabel entityLabel,
out SCR_UIInfo uiInfo )
inlineprotected

Definition at line 467 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLabelUIInfoIfValid()

bool SCR_ContentBrowserEditorComponent::GetLabelUIInfoIfValid ( EEditableEntityLabel entityLabel,
EEditorMode currentMode,
out SCR_UIInfo uiInfo )
inlineprotected

Definition at line 472 of file SCR_ContentBrowserEditorComponent.c.

◆ GetLastSearch()

string SCR_ContentBrowserEditorComponent::GetLastSearch ( )
inlineprotected

Get Last search string

Returns
Last search string

Definition at line 641 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnBrowserEntriesFiltered()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnBrowserEntriesFiltered ( )
inlineprotected

Event send when browser state done loading

Returns
Script invoker

Definition at line 722 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnBrowserStateCleared()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnBrowserStateCleared ( )
inlineprotected

Event send when browser state is cleared

Returns
Script invoker

Definition at line 731 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnBrowserStateLoaded()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnBrowserStateLoaded ( )
inlineprotected

Event send when browser state is loaded

Returns
Script invoker

Definition at line 713 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnBrowserStatePreload()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnBrowserStatePreload ( )
inlineprotected

Event send just before browser state is loaded

Returns
Script invoker

Definition at line 704 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnBrowserStatesSaved()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnBrowserStatesSaved ( )
inlineprotected

Event send when browser states are saved

Returns
Script invoker

Definition at line 695 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnEnableSaveStateTabs()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnEnableSaveStateTabs ( )
inlineprotected

Event send when browser state is cleared

Returns
Script invoker

Definition at line 740 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnLabelChanged()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnLabelChanged ( )
inlineprotected

Get on label changed event

Returns
OnLabelChanged ScriptInvoker

Definition at line 686 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnSearchConfirm()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnSearchConfirm ( )
inlineprotected

Get on search confirm, sends over current search string

Returns
Script invoker

Definition at line 749 of file SCR_ContentBrowserEditorComponent.c.

◆ GetOnStateTabVisibilityChanged()

ScriptInvoker SCR_ContentBrowserEditorComponent::GetOnStateTabVisibilityChanged ( )
inlineprotected

Called when state tab visibility is changed

Returns
Script invoker

Definition at line 758 of file SCR_ContentBrowserEditorComponent.c.

◆ GetPageEntryCount()

int SCR_ContentBrowserEditorComponent::GetPageEntryCount ( )
inlineprotected

Definition at line 549 of file SCR_ContentBrowserEditorComponent.c.

◆ GetPageIndex()

int SCR_ContentBrowserEditorComponent::GetPageIndex ( )
inlineprotected

Get current page index

Returns
Current page index

Definition at line 539 of file SCR_ContentBrowserEditorComponent.c.

◆ GetResourceNamePrefabID()

ResourceName SCR_ContentBrowserEditorComponent::GetResourceNamePrefabID ( int prefabID)
inlineprotected

Get prefab Resourcename of item with prefabID

Parameters
PrefabIDof item
Returns
ResourceName prefab of given ID

Definition at line 90 of file SCR_ContentBrowserEditorComponent.c.

◆ GetValidBlackListedLabels()

int SCR_ContentBrowserEditorComponent::GetValidBlackListedLabels ( out notnull array< EEditableEntityLabel > validBlackListLabels)
inlineprotected

Returns a list of lables that are currently blacklisted and any enity with the label will not be displayed in the list nor will the filter show

Parameters
[out]validBlackListLabelsList of blacklisted labels
Returns
int Count of blacklisted labels

Definition at line 185 of file SCR_ContentBrowserEditorComponent.c.

◆ IsAnyLabelActive()

bool SCR_ContentBrowserEditorComponent::IsAnyLabelActive ( )
inlineprotected

Get if any label is currently active

Returns
bool True when at least one label is active

Definition at line 395 of file SCR_ContentBrowserEditorComponent.c.

◆ IsExtendedEntity()

bool SCR_ContentBrowserEditorComponent::IsExtendedEntity ( notnull SCR_EditableEntityComponent entity)
inlineprotected

Definition at line 174 of file SCR_ContentBrowserEditorComponent.c.

◆ IsLabelActive()

bool SCR_ContentBrowserEditorComponent::IsLabelActive ( EEditableEntityLabel entityLabel)
inlineprotected

Get if passed entity label currently active

Parameters
EEditableEntityLabelenum value
Returns
bool True when label is active

Definition at line 386 of file SCR_ContentBrowserEditorComponent.c.

◆ IsMatchingToggledLabels()

bool SCR_ContentBrowserEditorComponent::IsMatchingToggledLabels ( notnull array< EEditableEntityLabel > entityLabels)
inlineprotected

Get if provided (entity) labels match current active selection, according to rules defined in config

Returns
bool True when provided labels match active labels

Definition at line 328 of file SCR_ContentBrowserEditorComponent.c.

◆ isMatchingToggledLabelsOfState()

bool SCR_ContentBrowserEditorComponent::isMatchingToggledLabelsOfState ( int savedStateIndex)
inlineprotected

Definition at line 313 of file SCR_ContentBrowserEditorComponent.c.

◆ IsPrefabIDAvailable()

bool SCR_ContentBrowserEditorComponent::IsPrefabIDAvailable ( int prefabID)
inlineprotected

Client method for checking if given prefab is currently available to him

Parameters
[in]prefabID
Returns
true if it is available, otherwise false

Definition at line 116 of file SCR_ContentBrowserEditorComponent.c.

◆ LoadAllPersistentBrowserState()

void SCR_ContentBrowserEditorComponent::LoadAllPersistentBrowserState ( )
inlineprotected

Definition at line 1381 of file SCR_ContentBrowserEditorComponent.c.

◆ LoadBrowserState() [1/2]

void SCR_ContentBrowserEditorComponent::LoadBrowserState ( int stateIndex,
bool clearConfigData )
inlineprotected

Definition at line 1278 of file SCR_ContentBrowserEditorComponent.c.

◆ LoadBrowserState() [2/2]

void SCR_ContentBrowserEditorComponent::LoadBrowserState ( SCR_EditorContentBrowserSaveStateData state,
bool clearConfigData )
inlineprotected

Definition at line 1291 of file SCR_ContentBrowserEditorComponent.c.

◆ OnMenuClosed()

void SCR_ContentBrowserEditorComponent::OnMenuClosed ( )
inlineprotected

Definition at line 1235 of file SCR_ContentBrowserEditorComponent.c.

◆ OnPlaceEntityServer()

void SCR_ContentBrowserEditorComponent::OnPlaceEntityServer ( int prefabID,
SCR_EditableEntityComponent entity )
inlineprotected

Definition at line 1230 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowser()

bool SCR_ContentBrowserEditorComponent::OpenBrowser ( int browserStateIndex = -1)
inlineprotected

Open content browser with preset labels

Parameters
browserStateIndexThe state that needs to be loaded upon opening. -1 to use lasted saved state
Returns
True if opened

Definition at line 1059 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserExtended()

bool SCR_ContentBrowserEditorComponent::OpenBrowserExtended ( SCR_EditableEntityComponent extendedEntity,
SCR_EditorContentBrowserDisplayConfig contentBrowserConfig = null )
inlineprotected

Start extending given entity. Content browser will be opened, showing only entities which fir the extended entity. Selecting one will instantly place it.

Parameters
extendedEntityExtended entity
configwith label data
Returns
True if opened

Definition at line 991 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserInstance() [1/2]

bool SCR_ContentBrowserEditorComponent::OpenBrowserInstance ( int browserStateIndex = -1)
inlinestaticprotected

Open content browser.

Parameters
browserStateIndexThe state that needs to be loaded upon opening. -1 to use lasted saved state
Returns
True if opened

Definition at line 945 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserInstance() [2/2]

bool SCR_ContentBrowserEditorComponent::OpenBrowserInstance ( SCR_EditorContentBrowserSaveStateData saveState)
inlinestaticprotected

Open content browser with state

Parameters
browserStateIndexThe state that needs to be loaded upon opening. -1 to use lasted saved state
Returns
True if opened

Definition at line 959 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserLabelConfig()

bool SCR_ContentBrowserEditorComponent::OpenBrowserLabelConfig ( SCR_EditorContentBrowserDisplayConfig contentBrowserConfig)
inlineprotected

Open content browser with label config Allows labels to be active on opening and label groups/labels to be hidden

Parameters
configwith label data
Returns
True if opened

Definition at line 1106 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserLabelConfigInstance()

bool SCR_ContentBrowserEditorComponent::OpenBrowserLabelConfigInstance ( SCR_EditorContentBrowserDisplayConfig contentBrowserConfig = null)
inlinestaticprotected

Open content browser with label config Allows labels to be active on opening and label groups/labels to be hidden

Parameters
configwith label data
Returns
True if opened

Definition at line 974 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserMenu()

bool SCR_ContentBrowserEditorComponent::OpenBrowserMenu ( )
inlineprotected

Definition at line 1254 of file SCR_ContentBrowserEditorComponent.c.

◆ OpenBrowserState()

bool SCR_ContentBrowserEditorComponent::OpenBrowserState ( SCR_EditorContentBrowserSaveStateData saveState,
SCR_EditorContentBrowserDisplayConfig displayConfig = null )
inlineprotected

Open content browser with external state

Parameters
browserStateIndexThe state that needs to be loaded upon opening. -1 to use lasted saved state
Returns
True if opened

Definition at line 1081 of file SCR_ContentBrowserEditorComponent.c.

◆ OrderLabels()

void SCR_ContentBrowserEditorComponent::OrderLabels ( inout notnull array< EEditableEntityLabel > activeLabels)
inlineprotected

Order given labels. Using group order and label order

Parameters
[in,out]labelsthat need to be ordered

Definition at line 481 of file SCR_ContentBrowserEditorComponent.c.

◆ RefreshPreviewCost()

bool SCR_ContentBrowserEditorComponent::RefreshPreviewCost ( int prefabID = -1)
inlineprotected

Definition at line 916 of file SCR_ContentBrowserEditorComponent.c.

◆ ResetAllLabels()

void SCR_ContentBrowserEditorComponent::ResetAllLabels ( bool setConfigData = true)
inlineprotected

Reset the set labels

Parameters
setConfigDataif true and applicable will set config data hidding certain labels and setting labels active

Definition at line 424 of file SCR_ContentBrowserEditorComponent.c.

◆ ResetBrowserState()

void SCR_ContentBrowserEditorComponent::ResetBrowserState ( bool clearConfigData)
inlineprotected

Definition at line 1224 of file SCR_ContentBrowserEditorComponent.c.

◆ SaveAllPersistentBrowserState()

void SCR_ContentBrowserEditorComponent::SaveAllPersistentBrowserState ( )
inlineprotected

Definition at line 1357 of file SCR_ContentBrowserEditorComponent.c.

◆ SaveBrowserState()

bool SCR_ContentBrowserEditorComponent::SaveBrowserState ( )
inlineprotected

Save the current browser state eg: Active filter labels, search string and current page

Parameters
clearBrowserStateif should also clear the browser for when the browser stays open and a new state is given
Returns
True if succesfully saved

Definition at line 1171 of file SCR_ContentBrowserEditorComponent.c.

◆ SetBrowserState() [1/2]

void SCR_ContentBrowserEditorComponent::SetBrowserState ( int browserStateIndex = -1,
bool saveCurrentState = false,
bool clearConfigData = true )
inlineprotected

Set Browser State

Parameters
browserStateIndexindex of state to set
saveCurrentStatewether or not the current state should be saved

Definition at line 1128 of file SCR_ContentBrowserEditorComponent.c.

◆ SetBrowserState() [2/2]

void SCR_ContentBrowserEditorComponent::SetBrowserState ( SCR_EditorContentBrowserDisplayConfig contentBrowserConfig,
bool saveCurrentState = false )
inlineprotected

Set Browser State

Parameters
contentBrowserConfigconfig of state to set
saveCurrentStatewether or not the current state should be saved

Definition at line 1156 of file SCR_ContentBrowserEditorComponent.c.

◆ SetBrowserStateIndex()

void SCR_ContentBrowserEditorComponent::SetBrowserStateIndex ( int index)
inlineprotected

Set the index of the Browser state (which is set by tabs in content browser)

Parameters
NewIndex

Definition at line 558 of file SCR_ContentBrowserEditorComponent.c.

◆ SetConfigLabels()

void SCR_ContentBrowserEditorComponent::SetConfigLabels ( )
inlineprotected

Definition at line 1334 of file SCR_ContentBrowserEditorComponent.c.

◆ SetCurrentSearch()

void SCR_ContentBrowserEditorComponent::SetCurrentSearch ( string searchText)
inlineprotected

Set current search string

Parameters
searchTextsearch string to save

Definition at line 659 of file SCR_ContentBrowserEditorComponent.c.

◆ SetCustomBrowserState()

void SCR_ContentBrowserEditorComponent::SetCustomBrowserState ( SCR_EditorContentBrowserSaveStateData state,
bool clearConfigData = true )
inlineprotected

Definition at line 1146 of file SCR_ContentBrowserEditorComponent.c.

◆ SetExtendedEntity()

void SCR_ContentBrowserEditorComponent::SetExtendedEntity ( SCR_EditableEntityComponent extendedEntity)
inlineprotected

Set extended entity. Upon next opening, the asset browser will show only prefabs which extend the entity.

Parameters
extendedEntityExtended entity

Definition at line 768 of file SCR_ContentBrowserEditorComponent.c.

◆ SetLabel()

void SCR_ContentBrowserEditorComponent::SetLabel ( EEditableEntityLabel entityLabel,
bool active )
inlineprotected

Set label active

Parameters
EEditableEntityLabelenum value
boolset active state

Definition at line 405 of file SCR_ContentBrowserEditorComponent.c.

◆ SetPageEntryCount()

void SCR_ContentBrowserEditorComponent::SetPageEntryCount ( int pageEntryCount)
inlineprotected

Definition at line 544 of file SCR_ContentBrowserEditorComponent.c.

◆ SetPageIndex()

void SCR_ContentBrowserEditorComponent::SetPageIndex ( int pageIndex)
inlineprotected

Set current page index

Parameters
NewIndex

Definition at line 530 of file SCR_ContentBrowserEditorComponent.c.

◆ SetSaveStateTabsEnabled()

void SCR_ContentBrowserEditorComponent::SetSaveStateTabsEnabled ( bool enabled)
inlineprotected

Set save state tabs enabled

Parameters
trueto set enabled

Definition at line 669 of file SCR_ContentBrowserEditorComponent.c.

◆ SetStateTabVisible()

void SCR_ContentBrowserEditorComponent::SetStateTabVisible ( int tabIndex,
bool setVisible )
inlineprotected

Makes sure that certain state tabs are shown or hidden

Parameters
tabIndexindex of state tab
setVisibleIf should be hidden or not

Definition at line 588 of file SCR_ContentBrowserEditorComponent.c.

Member Data Documentation

◆ ASYNC_TICK_LENGTH

const int SCR_ContentBrowserEditorComponent::ASYNC_TICK_LENGTH = 16
protected

Definition at line 21 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnBrowserEntriesFiltered

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnBrowserEntriesFiltered = new ScriptInvoker
protected

Definition at line 80 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnBrowserStateCleared

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnBrowserStateCleared = new ScriptInvoker
protected

Definition at line 81 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnBrowserStateLoaded

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnBrowserStateLoaded = new ScriptInvoker
protected

Definition at line 79 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnBrowserStatePreload

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnBrowserStatePreload = new ScriptInvoker
protected

Definition at line 78 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnBrowserStatesSaved

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnBrowserStatesSaved = new ScriptInvoker
protected

Definition at line 77 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnEnableSaveStateTabs

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnEnableSaveStateTabs = new ScriptInvoker
protected

Definition at line 82 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnLabelChanged

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnLabelChanged = new ScriptInvoker
protected

Definition at line 75 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnSearchConfirm

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnSearchConfirm = new ScriptInvoker
protected

Definition at line 76 of file SCR_ContentBrowserEditorComponent.c.

◆ Event_OnStateTabVisibilityChanged

ref ScriptInvoker SCR_ContentBrowserEditorComponent::Event_OnStateTabVisibilityChanged = new ScriptInvoker
protected

Definition at line 83 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aAsyncPrefabs

ref array<ResourceName> SCR_ContentBrowserEditorComponent::m_aAsyncPrefabs
protected

Definition at line 62 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aContentBrowserTabStates

ref array<ref SCR_EditorContentBrowserSaveStateDataUI> SCR_ContentBrowserEditorComponent::m_aContentBrowserTabStates
protected

Definition at line 33 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aExtendedEntitiesCache

ref set<ref SCR_EditableEntityCache> SCR_ContentBrowserEditorComponent::m_aExtendedEntitiesCache = new set<ref SCR_EditableEntityCache>()
protected

Definition at line 41 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aFilteredPrefabIDs

ref array<int> SCR_ContentBrowserEditorComponent::m_aFilteredPrefabIDs = {}
protected

Definition at line 52 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aHiddenStateTabs

ref array<int> SCR_ContentBrowserEditorComponent::m_aHiddenStateTabs = {}
protected

Definition at line 50 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aInfos

ref array<ref SCR_EditableEntityUIInfo> SCR_ContentBrowserEditorComponent::m_aInfos
protected

Definition at line 61 of file SCR_ContentBrowserEditorComponent.c.

◆ m_aLocalizationKeys

ref array<string> SCR_ContentBrowserEditorComponent::m_aLocalizationKeys = {}
protected

Definition at line 53 of file SCR_ContentBrowserEditorComponent.c.

◆ m_bShowEntityBudgetCost

bool SCR_ContentBrowserEditorComponent::m_bShowEntityBudgetCost
protected

Definition at line 70 of file SCR_ContentBrowserEditorComponent.c.

◆ m_bShowFactionOnContentBrowserCards

bool SCR_ContentBrowserEditorComponent::m_bShowFactionOnContentBrowserCards
protected

Definition at line 19 of file SCR_ContentBrowserEditorComponent.c.

◆ m_BudgetManager

SCR_BudgetEditorComponent SCR_ContentBrowserEditorComponent::m_BudgetManager
protected

Definition at line 59 of file SCR_ContentBrowserEditorComponent.c.

◆ m_bUsePersistentBrowserStates

bool SCR_ContentBrowserEditorComponent::m_bUsePersistentBrowserStates
protected

Definition at line 30 of file SCR_ContentBrowserEditorComponent.c.

◆ m_ContentBrowserConfig

ref SCR_EditorContentBrowserDisplayConfig SCR_ContentBrowserEditorComponent::m_ContentBrowserConfig
protected

Definition at line 43 of file SCR_ContentBrowserEditorComponent.c.

◆ m_eBlackListedLabels

ref array<EEditableEntityLabel> SCR_ContentBrowserEditorComponent::m_eBlackListedLabels
protected

Definition at line 36 of file SCR_ContentBrowserEditorComponent.c.

◆ m_EditorMenuManager

SCR_MenuEditorComponent SCR_ContentBrowserEditorComponent::m_EditorMenuManager
protected

Definition at line 56 of file SCR_ContentBrowserEditorComponent.c.

◆ m_EntityCore

SCR_EditableEntityCore SCR_ContentBrowserEditorComponent::m_EntityCore
protected

Definition at line 73 of file SCR_ContentBrowserEditorComponent.c.

◆ m_ExtendedEntity

SCR_EditableEntityComponent SCR_ContentBrowserEditorComponent::m_ExtendedEntity
protected

Definition at line 72 of file SCR_ContentBrowserEditorComponent.c.

◆ m_iAsyncIndex

int SCR_ContentBrowserEditorComponent::m_iAsyncIndex
protected

Definition at line 63 of file SCR_ContentBrowserEditorComponent.c.

◆ m_iBrowserStateIndex

int SCR_ContentBrowserEditorComponent::m_iBrowserStateIndex = 0
protected

Definition at line 65 of file SCR_ContentBrowserEditorComponent.c.

◆ m_iFilteredPrefabIDsCount

int SCR_ContentBrowserEditorComponent::m_iFilteredPrefabIDsCount
protected

Definition at line 54 of file SCR_ContentBrowserEditorComponent.c.

◆ m_iPageEntryCount

int SCR_ContentBrowserEditorComponent::m_iPageEntryCount = 15
protected

Definition at line 67 of file SCR_ContentBrowserEditorComponent.c.

◆ m_iPageIndex

int SCR_ContentBrowserEditorComponent::m_iPageIndex
protected

Definition at line 66 of file SCR_ContentBrowserEditorComponent.c.

◆ m_LabelGroups

ref array<ref SCR_EditableEntityCoreLabelGroupSetting> SCR_ContentBrowserEditorComponent::m_LabelGroups = {}
protected

Definition at line 47 of file SCR_ContentBrowserEditorComponent.c.

◆ m_mContentBrowserConfigStates

ref map<ref SCR_EditorContentBrowserDisplayConfig, ref SCR_EditorContentBrowserSaveStateData> SCR_ContentBrowserEditorComponent::m_mContentBrowserConfigStates = new map<ref SCR_EditorContentBrowserDisplayConfig, ref SCR_EditorContentBrowserSaveStateData>
protected

Definition at line 39 of file SCR_ContentBrowserEditorComponent.c.

◆ m_PlacingManager

SCR_PlacingEditorComponent SCR_ContentBrowserEditorComponent::m_PlacingManager
protected

Definition at line 57 of file SCR_ContentBrowserEditorComponent.c.

◆ m_PlacingManagerData

SCR_PlacingEditorComponentClass SCR_ContentBrowserEditorComponent::m_PlacingManagerData
protected

Definition at line 58 of file SCR_ContentBrowserEditorComponent.c.

◆ m_PrefabsCache

SCR_PrefabsCacheEditorComponent SCR_ContentBrowserEditorComponent::m_PrefabsCache
protected

Definition at line 60 of file SCR_ContentBrowserEditorComponent.c.

◆ m_sCurrentSearchText

string SCR_ContentBrowserEditorComponent::m_sCurrentSearchText
protected

Definition at line 68 of file SCR_ContentBrowserEditorComponent.c.

◆ m_sLastSearchText

string SCR_ContentBrowserEditorComponent::m_sLastSearchText
protected

Definition at line 69 of file SCR_ContentBrowserEditorComponent.c.

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