Multilist catalog for ease of use for developers. More...

Inheritance diagram for SCR_EntityCatalogMultiList:

Public Member Functions
int	GetMultiList (notnull out array< SCR_EntityCatalogMultiListEntry > multiLists)
	Only valid before init.

override void	ClearCatalogOnMerge ()
	Clear the catalog only executed on merge.

Public Member Functions inherited from SCR_EntityCatalog
EEntityCatalogType	GetCatalogType ()
	Get Data type.

int	GetEntityList (notnull out array< SCR_EntityCatalogEntry > entityList)
	Get list of entities witin Catalog Ignores Disabled Entries Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

SCR_EntityCatalogEntry	GetEntryWithPrefab (ResourceName prefabToFind)
	Return entry with specific prefab Ignores Disabled Entries.

SCR_EntityCatalogEntry	GetCatalogEntry (int index)
	Get Catalog Entry of index.

int	GetEntityListWithLabel (EEditableEntityLabel label, notnull out array< SCR_EntityCatalogEntry > filteredEntityList)
	Get list of entities witin Catalog which have a specific Label Ignores Disabled Entries and disabled Data types Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

int	GetEntityListExcludingLabel (EEditableEntityLabel excludinglabel, notnull out array< SCR_EntityCatalogEntry > filteredEntityList)
	Get list of entities witin Catalog EXCLUDING those with specific label Ignores Disabled Entries as well Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

int	GetFullFilteredEntityListWithLabels (notnull out array< SCR_EntityCatalogEntry > filteredEntityList, array< EEditableEntityLabel > includedLabels=null, array< EEditableEntityLabel > excludedLabels=null, bool needsAllIncluded=true)
	Get list of entities that all contain all/any the included labels and NONE exclude labels Ignores Disabled Entries as well Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

int	GetEntityListWithData (TypeName dataClass, notnull out array< SCR_EntityCatalogEntry > filteredEntityList, out array< SCR_BaseEntityCatalogData > dataList=null)
	Get list of entities witin Catalog which have a specific Data type (Needs to be inherent from SCR_BaseEntityCatalogData) Ignores Disabled Entries and disabled Data types Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

int	GetEntityListExcludingData (TypeName excludingDataClass, notnull out array< SCR_EntityCatalogEntry > filteredEntityList)
	Get list of entities witin Catalog EXCLUDING those with specific Data type (Needs to be inherent from SCR_BaseEntityCatalogData) Ignores Disabled Entries as well Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

int	GetFullFilteredEntityListWithData (notnull out array< SCR_EntityCatalogEntry > filteredEntityList, array< TypeName > includedDataClasses=null, array< TypeName > excludedDataClasses=null, bool needsAllIncluded=true)
	Get list of entities that all contain all/any the included Data classes and NONE exclude data classes Ignores Disabled Entries as well Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

int	GetFullFilteredEntityList (notnull out array< SCR_EntityCatalogEntry > filteredEntityList, array< EEditableEntityLabel > includedLabels=null, array< EEditableEntityLabel > excludedLabels=null, array< TypeName > includedDataClasses=null, array< TypeName > excludedDataClasses=null, bool needsAllIncludedLabels=true, bool needsAllIncludedClasses=true)
	Get list of entities that all contain all/any the included labels and/or Data classes and NONE exclude labels and/or data classes Ignores Disabled Entries as well Sometimes it is quicker to get the index (entityList[i].GetCatalogIndex()) and use the GetCatalogEntry() directly as it saves looping through the list and you don't need to save a ref to the list you got.

void	MergeCatalogs (notnull SCR_EntityCatalog catalogToMerge)
	Merge the given catalog into this catalog.

Protected Member Functions
override void	InitCatalog ()

Protected Member Functions inherited from SCR_EntityCatalog
void	PostInitCatalog ()

Protected Attributes
ref array< ref SCR_EntityCatalogMultiListEntry >	m_aMultiLists

Protected Attributes inherited from SCR_EntityCatalog
EEntityCatalogType	m_eEntityCatalogType

ref array< ref SCR_EntityCatalogEntry >	m_aEntityEntryList

ref map< ResourceName, int >	m_mPrefabIndexes = new map<ResourceName, int>()

Detailed Description

Multilist catalog for ease of use for developers.

This will still merge all lists into the m_aEntityEntryList on init and set m_aMultiLists to null

Member Function Documentation

◆ ClearCatalogOnMerge()

override void SCR_EntityCatalogMultiList.ClearCatalogOnMerge ( )

Clear the catalog only executed on merge.

Implements SCR_EntityCatalog.

◆ GetMultiList()

int SCR_EntityCatalogMultiList.GetMultiList ( notnull out array< SCR_EntityCatalogMultiListEntry > multiLists )

Only valid before init.

Used when merging entity lists param[in] multiLists Return list of all the multilists return Count of multiLists

◆ InitCatalog()

override void SCR_EntityCatalogMultiList.InitCatalog ( )

protected

Implements SCR_EntityCatalog.

Member Data Documentation

◆ m_aMultiLists

ref array<ref SCR_EntityCatalogMultiListEntry> SCR_EntityCatalogMultiList.m_aMultiLists

protected

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

Game/EntityCatalog/SCR_EntityCatalogMultiList.c

Public Member Functions

Protected Member Functions