SCR_EntityCatalog Class Reference

Inheritance diagram for SCR_EntityCatalog:

Protected Member Functions
Get Data type return Returns Catalog type of holder *EEntityCatalogType	GetCatalogType ()
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 \param[out] entityList Array of enabled entity list \return List size */int GetEntityList(notnull out array< SCR_EntityCatalogEntry > entityList)
SCR_EntityCatalogEntry	GetEntryWithPrefab (ResourceName prefabToFind)
Get Catalog Entry of index Can ignores disabled entries param Index of entry within list return Catalog Entry Null if entry is disabled *SCR_EntityCatalogEntry	GetCatalogEntry (int index)
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 \param label Label you want the entry to have \param[out] filteredEntityList Array of enabled entity list with the specific label \return List size */int GetEntityListWithLabel(EEditableEntityLabel label
	foreach (SCR_EntityCatalogEntry entityEntry:m_aEntityEntryList)
return filteredEntityList	Count ()
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 \param excludinglabel Label you want the entry NOT have \param[out] filteredEntityList Array of enabled entity list without the specific label \return List size */int GetEntityListExcludingLabel(EEditableEntityLabel excludinglabel
	foreach (SCR_EntityCatalogEntry entityEntry:m_aEntityEntryList)
return filteredEntityList	Count ()
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 \param[out] filteredEntityList Filltered array of enabled entity \param includedLabels A list of labels the entity needs all/any to have. Can be null if exclusive is filled \param excludedLabels A list of labels the entity CANNOT have ANY of. Can be null if inclusive is filled \param needsAllIncluded If true included List all needs to be 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 if false any needs to be true return List size *int	GetFullFilteredEntityListWithLabels (notnull out array< SCR_EntityCatalogEntry > filteredEntityList, array< EEditableEntityLabel > includedLabels=null, array< EEditableEntityLabel > excludedLabels=null, bool needsAllIncluded=true)
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 \param dataClass class of Data type you want the data to have in order to be added to the list(Needs to be inherent from SCR_BaseEntityCatalogData) \param[out] filteredEntityList Array of enabled entity list with specific Data type \param[out] dataList optionally you can directly get the data list if array given \return List size */int GetEntityListWithData(typename dataClass

Protected Attributes
EEntityCatalogType	m_eEntityCatalogType
ref array< ref SCR_EntityCatalogEntry >	m_aEntityEntryList
ref map< ResourceName, int >	m_mPrefabIndexes = new map<ResourceName, int>()
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 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 notnull out array< SCR_EntityCatalogEntry >	filteredEntityList
Get list of entities witin Catalog which have a specific Data notnull out array< SCR_EntityCatalogEntry >	filteredEntityList

Detailed Description

Catalog that holds faction entity lists of a specific entity type

Definition at line 181 of file SCR_EntityCatalog.c.

Member Function Documentation

Count() [1/2]

return filteredEntityList SCR_EntityCatalog::Count ( )

protected

Count() [2/2]

return filteredEntityList SCR_EntityCatalog::Count ( )

protected

foreach() [1/2]

SCR_EntityCatalog::foreach ( SCR_EntityCatalogEntry entityEntry:m_aEntityEntryList )

inlineprotected

Definition at line 313 of file SCR_EntityCatalog.c.

foreach() [2/2]

SCR_EntityCatalog::foreach ( SCR_EntityCatalogEntry entityEntry:m_aEntityEntryList )

inlineprotected

Definition at line 285 of file SCR_EntityCatalog.c.

GetCatalogEntry()

Get Catalog Entry of index Can ignores disabled entries param Index of entry within list return Catalog Entry Null if entry is disabled *SCR_EntityCatalogEntry SCR_EntityCatalog::GetCatalogEntry ( int index )

inlineprotected

Definition at line 256 of file SCR_EntityCatalog.c.

GetCatalogType()

Get Data type return Returns Catalog type of holder *EEntityCatalogType SCR_EntityCatalog::GetCatalogType ( )

inlineprotected

Definition at line 197 of file SCR_EntityCatalog.c.

GetEntryWithPrefab()

SCR_EntityCatalogEntry SCR_EntityCatalog::GetEntryWithPrefab ( ResourceName prefabToFind )

inlineprotected

Return entry with specific prefab Ignores Disabled Entries

Parameters

prefabToFind

Prefab the entry has that you are looking for

Returns

Found Entry, can be null if not found

Definition at line 231 of file SCR_EntityCatalog.c.

GetFullFilteredEntityListWithLabels()

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 if false any needs to be true return List size *int SCR_EntityCatalog::GetFullFilteredEntityListWithLabels ( notnull out array< SCR_EntityCatalogEntry > filteredEntityList, array< EEditableEntityLabel > includedLabels = null, array< EEditableEntityLabel > excludedLabels = null, bool needsAllIncluded = true )

inlineprotected

Definition at line 337 of file SCR_EntityCatalog.c.

index() [1/4]

Get list of entities witin Catalog EXCLUDING those with specific label Ignores Disabled Entries as well Sometimes it is quicker to get the SCR_EntityCatalog::index ( entityList. GetCatalogIndex()[i] )

protected

index() [2/4]

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 SCR_EntityCatalog::index ( entityList. GetCatalogIndex()[i] )

protected

index() [3/4]

Get list of entities witin Catalog Ignores Disabled Entries Sometimes it is quicker to get the SCR_EntityCatalog::index ( entityList. GetCatalogIndex()[i] )

inlineprotected

Definition at line 207 of file SCR_EntityCatalog.c.

index() [4/4]

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 SCR_EntityCatalog::index ( entityList. GetCatalogIndex()[i] )

protected

type()

Get list of entities witin Catalog which have a specific Data SCR_EntityCatalog::type ( Needs to be inherent from SCR_BaseEntityCatalogData )

protected

Member Data Documentation

filteredEntityList [1/3]

Get list of entities witin Catalog which have a specific Data notnull out array<SCR_EntityCatalogEntry> SCR_EntityCatalog::filteredEntityList

protected

Definition at line 384 of file SCR_EntityCatalog.c.

filteredEntityList [2/3]

Get list of entities witin Catalog EXCLUDING those with specific label Ignores Disabled Entries as well Sometimes it is quicker to get the notnull out array<SCR_EntityCatalogEntry> SCR_EntityCatalog::filteredEntityList

protected

Initial value:

{
        
        filteredEntityList.Clear()

Definition at line 307 of file SCR_EntityCatalog.c.

filteredEntityList [3/3]

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 notnull out array<SCR_EntityCatalogEntry> SCR_EntityCatalog::filteredEntityList

protected

Initial value:

{
        
        filteredEntityList.Clear()

Definition at line 279 of file SCR_EntityCatalog.c.

m_aEntityEntryList

ref array<ref SCR_EntityCatalogEntry> SCR_EntityCatalog::m_aEntityEntryList

protected

Definition at line 187 of file SCR_EntityCatalog.c.

m_eEntityCatalogType

EEntityCatalogType SCR_EntityCatalog::m_eEntityCatalogType

protected

Definition at line 184 of file SCR_EntityCatalog.c.

m_mPrefabIndexes

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

protected

Definition at line 190 of file SCR_EntityCatalog.c.

---

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

• scripts/Game/EntityCatalog/SCR_EntityCatalog.c