SCR_EntityCatalogEntryNonEditable Interface Reference

Entity Entry within the SCR_EntityCatalog. More...

Inheritance diagram for SCR_EntityCatalogEntryNonEditable:

Public Member Functions
override int	GetEditableEntityLabels (notnull out array< EEditableEntityLabel > editableEntityLables)
	Get a list of all editable entity lables Prefab needs to be an editable entity.
override bool	HasEditableEntityLabel (EEditableEntityLabel editableEntityLabel)
	Check if entity has given label Prefab needs to be an editable entity.
override bool	HasAnyEditableEntityLabels (notnull array< EEditableEntityLabel > editableEntityLables)
	Check if entity has any one of the given labels Prefab needs to be an editable entity.
override bool	HasAllEditableEntityLabels (notnull array< EEditableEntityLabel > editableEntityLables)
	Check if entity has ALL of the given labels Prefab needs to be an editable entity.
override void	ClassSpecificInit ()
Public Member Functions inherited from SCR_EntityCatalogEntry
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 Attributes
ref array< EEditableEntityLabel >	m_aLabels
Protected Attributes inherited from SCR_EntityCatalogEntry
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

Additional Inherited Members
void	ClassSpecificInit ()

Detailed Description

Entity Entry within the SCR_EntityCatalog.

This is meant for NON-EDITABLE ENTITIES ONLY! For editable entities use SCR_EntityCatalogEntry!

Member Function Documentation

ClassSpecificInit()

override void SCR_EntityCatalogEntryNonEditable.ClassSpecificInit

(

)

Implements SCR_EntityCatalogEntry.

Implemented in SCR_EntityCatalogInventoryItem.

GetEditableEntityLabels()

override int SCR_EntityCatalogEntryNonEditable.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

Implements SCR_EntityCatalogEntry.

HasAllEditableEntityLabels()

override bool SCR_EntityCatalogEntryNonEditable.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

Implements SCR_EntityCatalogEntry.

HasAnyEditableEntityLabels()

override bool SCR_EntityCatalogEntryNonEditable.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

Implements SCR_EntityCatalogEntry.

HasEditableEntityLabel()

override bool SCR_EntityCatalogEntryNonEditable.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

Implements SCR_EntityCatalogEntry.

Member Data Documentation

m_aLabels

ref array<EEditableEntityLabel> SCR_EntityCatalogEntryNonEditable.m_aLabels

protected

---

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

• Game/EntityCatalog/EntityCatalogEntry/SCR_EntityCatalogEntryNonEditable.c