Entity Entry within the SCR_EntityCatalog. More...

Inheritance diagram for SCR_EntityCatalogEntry:

Public Member Functions
bool	IsEnabled ()
	If is Enabled.

int	GetCatalogIndex ()
	Get Index of entry within Catalog.

ResourceName	GetPrefab ()
	Get Prefab data.

SCR_EntityCatalog	GetCatalogParent ()
	Get Catalog parent the entity entry is in.

SCR_UIInfo	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.

LocalizedString	GetEntityName ()
	Get Name of entity Prefab needs to be an editable entity.

int	GetEditableEntityLabels (notnull out array< EEditableEntityLabel > editableEntityLables)
	Get a list of all editable entity lables Prefab needs to be an editable entity.

bool	HasEditableEntityLabel (EEditableEntityLabel editableEntityLabel)
	Check if entity has given label Prefab needs to be an editable entity.

bool	HasAnyEditableEntityLabels (notnull array< EEditableEntityLabel > editableEntityLables)
	Check if entity has any one of the given labels Prefab needs to be an editable entity.

bool	HasAllEditableEntityLabels (notnull array< EEditableEntityLabel > editableEntityLables)
	Check if entity has ALL of the given labels Prefab needs to be an editable entity.

SCR_BaseEntityCatalogData	GetEntityDataOfType (TypeName dataType)
	Get prefab entity Data of type.

int	GetEntityDataList (notnull out array< SCR_BaseEntityCatalogData > entityDataList)
	Get list of entity Data of all types Ignores Disabled Elements.

bool	HasEntityDataOfType (TypeName dataType)
	Check if has the entity data of the given type Ignores disabled Data's.

bool	HasAllEntityDataOfTypes (array< TypeName > dataTypes)
	Check if has ALL the entity datas of the given types Ignores disabled Data's.

bool	HasAnyEntityDataOfTypes (array< TypeName > dataTypes)
	Check if has ANY the entity datas of the given types Ignores disabled Data's.

void	InitEntry (notnull SCR_EntityCatalog catalog, int catalogIndex)
	Init for general entry.

void	PostInitEntry (SCR_EntityCatalog catalog)
	Post Init for general entry.

Protected Member Functions
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

Detailed Description

Entity Entry within the SCR_EntityCatalog.

Includes the Prefab and list of Data for each entry

Member Function Documentation

◆ ClassSpecificInit()

void SCR_EntityCatalogEntry.ClassSpecificInit ( )

protected

Implemented in SCR_EntityCatalogEntryNonEditable, and SCR_EntityCatalogInventoryItem.

◆ GetCatalogIndex()

int SCR_EntityCatalogEntry.GetCatalogIndex ( )

Get Index of entry within Catalog.

Returns: index

◆ GetCatalogParent()

SCR_EntityCatalog SCR_EntityCatalogEntry.GetCatalogParent ( )

Get Catalog parent the entity entry is in.

Returns: Catalog parent

◆ GetEditableEntityLabels()

int SCR_EntityCatalogEntry.GetEditableEntityLabels ( notnull out array< EEditableEntityLabel > editableEntityLables )

Get a list of all editable entity lables Prefab needs to be an editable entity.

Parameters

[out] List of all labels on entity

Returns: length of lable array

Implemented in SCR_EntityCatalogEntryNonEditable.

◆ GetEntityDataList()

int SCR_EntityCatalogEntry.GetEntityDataList ( notnull out array< SCR_BaseEntityCatalogData > entityDataList )

Get list of entity Data of all types Ignores Disabled Elements.

Parameters

[out] Array of enabled entity Data list

Returns: List size

◆ GetEntityDataOfType()

SCR_BaseEntityCatalogData SCR_EntityCatalogEntry.GetEntityDataOfType ( TypeName dataType )

Get prefab entity Data of type.

Ignores disabled Data's

Parameters

dataType class of Data type you with to obtain

Returns: Entity Data of given type. Null if not found

◆ GetEntityName()

LocalizedString SCR_EntityCatalogEntry.GetEntityName ( )

Get Name of entity Prefab needs to be an editable entity.

Returns: Name, empty string if no uiinfo was found

◆ GetEntityUiInfo()

SCR_UIInfo SCR_EntityCatalogEntry.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.

Returns: Ui info

Implemented in SCR_EntityCatalogEntryCustomInfo.

◆ GetPrefab()

ResourceName SCR_EntityCatalogEntry.GetPrefab ( )

Get Prefab data.

Returns: Prefab data

◆ HasAllEditableEntityLabels()

bool SCR_EntityCatalogEntry.HasAllEditableEntityLabels ( notnull array< EEditableEntityLabel > editableEntityLables )

Check if entity has ALL of the given labels Prefab needs to be an editable entity.

Parameters

editableEntityLables Labels to check if entity has ALL of them

Returns: True if entity has ALL of the label

Implemented in SCR_EntityCatalogEntryNonEditable.

◆ HasAllEntityDataOfTypes()

bool SCR_EntityCatalogEntry.HasAllEntityDataOfTypes ( array< TypeName > dataTypes )

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

◆ HasAnyEditableEntityLabels()

bool SCR_EntityCatalogEntry.HasAnyEditableEntityLabels ( notnull array< EEditableEntityLabel > editableEntityLables )

Check if entity has any one of the given labels Prefab needs to be an editable entity.

Parameters

editableEntityLables Labels to check if entity has any of them

Returns: True if entity has any of the label

Implemented in SCR_EntityCatalogEntryNonEditable.

◆ HasAnyEntityDataOfTypes()

bool SCR_EntityCatalogEntry.HasAnyEntityDataOfTypes ( array< TypeName > dataTypes )

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

◆ HasEditableEntityLabel()

bool SCR_EntityCatalogEntry.HasEditableEntityLabel ( EEditableEntityLabel editableEntityLabel )

Check if entity has given label Prefab needs to be an editable entity.

Parameters

editableEntityLabel Label to check if entity has it

Returns: True if entity has the label

Implemented in SCR_EntityCatalogEntryNonEditable.

◆ HasEntityDataOfType()

bool SCR_EntityCatalogEntry.HasEntityDataOfType ( TypeName dataType )

Check if has the entity data of the given type Ignores disabled Data's.

Parameters

dataType class of Data type you want to check

Returns: True if the entity has an enabled data of given type

◆ InitEntry()

void SCR_EntityCatalogEntry.InitEntry	(	notnull SCR_EntityCatalog	catalog,
		int	catalogIndex
	)

Init for general entry.

Setting index and called class specific init Only set by Catalog parent on init. Should not be overwritten

Parameters

catalog	Catalog entry is in
index	Index within catalog

◆ IsEnabled()

bool SCR_EntityCatalogEntry.IsEnabled ( )

If is Enabled.

Returns: If enabled or disabled

◆ PostInitEntry()

void SCR_EntityCatalogEntry.PostInitEntry ( SCR_EntityCatalog catalog )

Post Init for general entry.

Called one frame after init is called Only set by Catalog parent on post init. Should not be overwritten

Parameters

[i]	catalog Catalog entry is in

Member Data Documentation

◆ m_aEntityDataList

ref array<ref SCR_BaseEntityCatalogData> SCR_EntityCatalogEntry.m_aEntityDataList

protected

◆ m_bEnabled

bool SCR_EntityCatalogEntry.m_bEnabled

protected

◆ m_CatalogParent

SCR_EntityCatalog SCR_EntityCatalogEntry.m_CatalogParent

protected

◆ m_EditableEntityUiInfo

ref SCR_UIInfo SCR_EntityCatalogEntry.m_EditableEntityUiInfo

protected

◆ m_iCatalogIndex

int SCR_EntityCatalogEntry.m_iCatalogIndex = -1

protected

◆ m_sEntityPrefab

ResourceName SCR_EntityCatalogEntry.m_sEntityPrefab

protected

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

Game/EntityCatalog/EntityCatalogEntry/SCR_EntityCatalogEntry.c

Public Member Functions

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