Inheritance diagram for SCR_EntityCatalogEntry:

Protected Member Functions
If is Enabled return If enabled or disabled *bool	IsEnabled ()
Get Index of entry within Catalog return index *int	GetCatalogIndex ()
Get Prefab data return Prefab data *ResourceName	GetPrefab ()
Get Catalog parent the entity entry is in return Catalog parent *SCR_EntityCatalog	GetCatalogParent ()
Get UI info Prefab needs to be an editable entity or have a custom UI info logic Note that if UIInfo is NULL then the autotest will fail return Ui info *SCR_UIInfo	GetEntityUiInfo ()
Get Name of entity Prefab needs to be an editable entity return empty string if no uiinfo was found *LocalizedString	GetEntityName ()
Get a list of all editable entity lables Prefab needs to be an editable entity param[out] List of all labels on entity return length of lable array *int	GetEditableEntityLabels (notnull out array< EEditableEntityLabel > editableEntityLables)
Check if entity has given label Prefab needs to be an editable entity param editableEntityLabel Label to check if entity has it return True if entity has the label *bool	HasEditableEntityLabel (EEditableEntityLabel editableEntityLabel)
Check if entity has any one of the given labels Prefab needs to be an editable entity param editableEntityLables Labels to check if entity has any of them return True if entity has any of the label *bool	HasAnyEditableEntityLabels (notnull array< EEditableEntityLabel > editableEntityLables)
Check if entity has ALL of the given labels Prefab needs to be an editable entity param editableEntityLables Labels to check if entity has ALL of them return True if entity has ALL of the label *bool	HasAllEditableEntityLabels (notnull array< EEditableEntityLabel > editableEntityLables)
Get prefab entity Data of type Ignores disabled Data s param dataType class of Data type you with to obtain return Entity Data of given type Null if not found *SCR_BaseEntityCatalogData	GetEntityDataOfType (typename dataType)
Get list of entity Data of all types Ignores Disabled Elements param[out] Array of enabled entity Data list return List size *int	GetEntityDataList (notnull out array< SCR_BaseEntityCatalogData > entityDataList)
Check if has the entity data of the given type Ignores disabled Data s param dataType class of Data type you want to check return True if the entity has an enabled data of given type *bool	HasEntityDataOfType (typename dataType)
bool	HasAllEntityDataOfTypes (array< typename > dataTypes)
bool	HasAnyEntityDataOfTypes (array< typename > dataTypes)
Init for general entry Setting index and called class specific init Only set by Catalog parent on init Should not be overwritten param catalog Catalog entry is in param index Index within catalog *void	InitEntry (notnull SCR_EntityCatalog catalog, int catalogIndex)
Post Init for general entry Called one frame after init is called Only set by Catalog parent on post init Should not be overwritten param[i] catalog Catalog entry is in *void	PostInitEntry (SCR_EntityCatalog catalog)
void	ClassSpecificInit ()

Protected Attributes
ResourceName	m_sEntityPrefab
bool	m_bEnabled
ref array< ref SCR_BaseEntityCatalogData >	m_aEntityDataList
int	m_iCatalogIndex = -1
ref SCR_UIInfo	m_EditableEntityUiInfo
SCR_EntityCatalog	m_CatalogParent
Get Name of entity Prefab needs to be an editable entity return	Name

Detailed Description

Entity Entry within the SCR_EntityCatalog. Includes the Prefab and list of Data for each entry

Definition at line 5 of file SCR_EntityCatalogEntry.c.

Member Function Documentation

◆ ClassSpecificInit()

void SCR_EntityCatalogEntry::ClassSpecificInit ( )

inlineprotected

Definition at line 318 of file SCR_EntityCatalogEntry.c.

◆ GetCatalogIndex()

Get Index of entry within Catalog return index *int SCR_EntityCatalogEntry::GetCatalogIndex ( )

inlineprotected

Definition at line 41 of file SCR_EntityCatalogEntry.c.

◆ GetCatalogParent()

Get Catalog parent the entity entry is in return Catalog parent *SCR_EntityCatalog SCR_EntityCatalogEntry::GetCatalogParent ( )

inlineprotected

Definition at line 61 of file SCR_EntityCatalogEntry.c.

◆ GetEditableEntityLabels()

Get a list of all editable entity lables Prefab needs to be an editable entity param[out] List of all labels on entity return length of lable array *int SCR_EntityCatalogEntry::GetEditableEntityLabels ( notnull out array< EEditableEntityLabel > editableEntityLables )

inlineprotected

Definition at line 101 of file SCR_EntityCatalogEntry.c.

◆ GetEntityDataList()

Get list of entity Data of all types Ignores Disabled Elements param[out] Array of enabled entity Data list return List size *int SCR_EntityCatalogEntry::GetEntityDataList ( notnull out array< SCR_BaseEntityCatalogData > entityDataList )

inlineprotected

Definition at line 199 of file SCR_EntityCatalogEntry.c.

◆ GetEntityDataOfType()

Get prefab entity Data of type Ignores disabled Data s param dataType class of Data type you with to obtain return Entity Data of given type Null if not found *SCR_BaseEntityCatalogData SCR_EntityCatalogEntry::GetEntityDataOfType ( typename dataType )

inlineprotected

Definition at line 180 of file SCR_EntityCatalogEntry.c.

◆ GetEntityName()

Get Name of entity Prefab needs to be an editable entity return empty string if no uiinfo was found *LocalizedString SCR_EntityCatalogEntry::GetEntityName ( )

inlineprotected

Definition at line 85 of file SCR_EntityCatalogEntry.c.

◆ GetEntityUiInfo()

Get UI info Prefab needs to be an editable entity or have a custom UI info logic Note that if UIInfo is NULL then the autotest will fail return Ui info *SCR_UIInfo SCR_EntityCatalogEntry::GetEntityUiInfo ( )

inlineprotected

Definition at line 74 of file SCR_EntityCatalogEntry.c.

◆ GetPrefab()

Get Prefab data return Prefab data *ResourceName SCR_EntityCatalogEntry::GetPrefab ( )

inlineprotected

Definition at line 51 of file SCR_EntityCatalogEntry.c.

◆ HasAllEditableEntityLabels()

Check if entity has ALL of the given labels Prefab needs to be an editable entity param editableEntityLables Labels to check if entity has ALL of them return True if entity has ALL of the label *bool SCR_EntityCatalogEntry::HasAllEditableEntityLabels ( notnull array< EEditableEntityLabel > editableEntityLables )

inlineprotected

Definition at line 157 of file SCR_EntityCatalogEntry.c.

◆ HasAllEntityDataOfTypes()

bool SCR_EntityCatalogEntry::HasAllEntityDataOfTypes ( array< typename > dataTypes )

inlineprotected

Check if has ALL the entity datas of the given types Ignores disabled Data's

Parameters

dataTypes classes of Data types you want to check

Returns: True if the entity has ALL the enabled data of given types

Definition at line 240 of file SCR_EntityCatalogEntry.c.

◆ HasAnyEditableEntityLabels()

Check if entity has any one of the given labels Prefab needs to be an editable entity param editableEntityLables Labels to check if entity has any of them return True if entity has any of the label *bool SCR_EntityCatalogEntry::HasAnyEditableEntityLabels ( notnull array< EEditableEntityLabel > editableEntityLables )

inlineprotected

Definition at line 135 of file SCR_EntityCatalogEntry.c.

◆ HasAnyEntityDataOfTypes()

bool SCR_EntityCatalogEntry::HasAnyEntityDataOfTypes ( array< typename > dataTypes )

inlineprotected

Check if has ANY the entity datas of the given types Ignores disabled Data's

Parameters

dataTypes classes of Data types you want to check

Returns: True if the entity has ANY the enabled data of given types

Definition at line 258 of file SCR_EntityCatalogEntry.c.

◆ HasEditableEntityLabel()

Check if entity has given label Prefab needs to be an editable entity param editableEntityLabel Label to check if entity has it return True if entity has the label *bool SCR_EntityCatalogEntry::HasEditableEntityLabel ( EEditableEntityLabel editableEntityLabel )

inlineprotected

Definition at line 119 of file SCR_EntityCatalogEntry.c.

◆ HasEntityDataOfType()

Check if has the entity data of the given type Ignores disabled Data s param dataType class of Data type you want to check return True if the entity has an enabled data of given type *bool SCR_EntityCatalogEntry::HasEntityDataOfType ( typename dataType )

inlineprotected

Definition at line 222 of file SCR_EntityCatalogEntry.c.

◆ InitEntry()

Init for general entry Setting index and called class specific init Only set by Catalog parent on init Should not be overwritten param catalog Catalog entry is in param index Index within catalog *void SCR_EntityCatalogEntry::InitEntry	(	notnull SCR_EntityCatalog	catalog,
		int	catalogIndex )

inlineprotected

Definition at line 278 of file SCR_EntityCatalogEntry.c.

◆ IsEnabled()

If is Enabled return If enabled or disabled *bool SCR_EntityCatalogEntry::IsEnabled ( )

inlineprotected

Definition at line 31 of file SCR_EntityCatalogEntry.c.

◆ PostInitEntry()

Post Init for general entry Called one frame after init is called Only set by Catalog parent on post init Should not be overwritten param[i] catalog Catalog entry is in *void SCR_EntityCatalogEntry::PostInitEntry ( SCR_EntityCatalog catalog )

inlineprotected

Definition at line 305 of file SCR_EntityCatalogEntry.c.

Member Data Documentation

◆ m_aEntityDataList

ref array<ref SCR_BaseEntityCatalogData> SCR_EntityCatalogEntry::m_aEntityDataList

protected

Definition at line 14 of file SCR_EntityCatalogEntry.c.

◆ m_bEnabled

bool SCR_EntityCatalogEntry::m_bEnabled

protected

Definition at line 11 of file SCR_EntityCatalogEntry.c.

◆ m_CatalogParent

SCR_EntityCatalog SCR_EntityCatalogEntry::m_CatalogParent

protected

Definition at line 23 of file SCR_EntityCatalogEntry.c.

◆ m_EditableEntityUiInfo

ref SCR_UIInfo SCR_EntityCatalogEntry::m_EditableEntityUiInfo

protected

Definition at line 20 of file SCR_EntityCatalogEntry.c.

◆ m_iCatalogIndex

int SCR_EntityCatalogEntry::m_iCatalogIndex = -1

protected

Definition at line 17 of file SCR_EntityCatalogEntry.c.

◆ m_sEntityPrefab

ResourceName SCR_EntityCatalogEntry::m_sEntityPrefab

protected

Definition at line 8 of file SCR_EntityCatalogEntry.c.

◆ Name

Get Name of entity Prefab needs to be an editable entity return SCR_EntityCatalogEntry::Name

protected

Definition at line 83 of file SCR_EntityCatalogEntry.c.

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

scripts/Game/EntityCatalog/EntityCatalogEntry/SCR_EntityCatalogEntry.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ ClassSpecificInit()

◆ GetCatalogIndex()

◆ GetCatalogParent()

◆ GetEditableEntityLabels()

◆ GetEntityDataList()

◆ GetEntityDataOfType()

◆ GetEntityName()

◆ GetEntityUiInfo()

◆ GetPrefab()

◆ HasAllEditableEntityLabels()

◆ HasAllEntityDataOfTypes()

◆ HasAnyEditableEntityLabels()

◆ HasAnyEntityDataOfTypes()

◆ HasEditableEntityLabel()

◆ HasEntityDataOfType()

◆ InitEntry()

◆ IsEnabled()

◆ PostInitEntry()

Member Data Documentation

◆ m_aEntityDataList

◆ m_bEnabled

◆ m_CatalogParent

◆ m_EditableEntityUiInfo

◆ m_iCatalogIndex

◆ m_sEntityPrefab

◆ Name