SCR_EditableEntityUIInfo Class Reference

Inheritance diagram for SCR_EditableEntityUIInfo:

Protected Member Functions
override LocalizedString	GetName ()
bool	IsFullBackgroundAssetCard ()
ResourceName	GetImage ()
EEditableEntityType	GetEntityTypex ()
FactionKey	GetFactionKey ()
FactionKey	GetDefaultFactionKey ()
void	OverrideFactionKey (FactionKey newKey)
Faction	GetFaction ()
int	GetEntityLabels (out notnull array< EEditableEntityLabel > entityLabels)
bool	HasEntityLabel (EEditableEntityLabel label)
bool	GetEntityBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
void	GetEntityAndChildrenBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get Entity and its children budgets.
void	GetEntityChildrenBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get only Entity's children budget costs, i.e. cost of entities inside a composition entitiy.
ResourceName	GetSlotPrefab ()
EEditableEntityType	GetEntityType ()
bool	HasEntityFlag (EEditableEntityFlag flag)
bool	SetAssetImageTo (ImageWidget imageWidget)
void	InitFromSource (IEntityComponentSource componentSource)
override void	CopyFrom (SCR_UIName source)

Static Protected Member Functions
static SCR_EditableEntityUIInfo	ExtractEditableUIInfoFromPrefab (ResourceName prefab)

Protected Attributes
ResourceName	m_SlotPrefab
bool	m_bFullBackgroundAssetCard
FactionKey	m_sFactionKeyOverride
EEditableEntityType	m_EntityType
EEditableEntityFlag	m_EntityFlags

Static Protected Attributes
static const LocalizedString	EDITABLE_ENTITY_FALLBACK_NAME = "#AR-AttributesDialog_TitlePage_Entity_Text"

Detailed Description

Definition at line 2 of file SCR_EditableEntityUIInfo.c.

Member Function Documentation

CopyFrom()

override void SCR_EditableEntityUIInfo::CopyFrom ( SCR_UIName source )

inlineprotected

Definition at line 204 of file SCR_EditableEntityUIInfo.c.

ExtractEditableUIInfoFromPrefab()

SCR_EditableEntityUIInfo SCR_EditableEntityUIInfo::ExtractEditableUIInfoFromPrefab ( ResourceName prefab )

inlinestaticprotected

Extracts the ui info from editable entity prefab

Parameters

[in]

prefab

Returns

ui info of editable entity if such is found, otherwise null

Definition at line 226 of file SCR_EditableEntityUIInfo.c.

GetDefaultFactionKey()

FactionKey SCR_EditableEntityUIInfo::GetDefaultFactionKey ( )

inlineprotected

Definition at line 76 of file SCR_EditableEntityUIInfo.c.

GetEntityAndChildrenBudgetCost()

void SCR_EditableEntityUIInfo::GetEntityAndChildrenBudgetCost ( out notnull array< ref SCR_EntityBudgetValue > outBudgets )

inlineprotected

Get Entity and its children budgets.

Definition at line 134 of file SCR_EditableEntityUIInfo.c.

GetEntityBudgetCost()

bool SCR_EditableEntityUIInfo::GetEntityBudgetCost ( out notnull array< ref SCR_EntityBudgetValue > outBudgets )

inlineprotected

Get Entity budget costs

Returns

false if budget cost should be determined by entitytype, or return true with an empty cost array to avoid any budget cost

Definition at line 126 of file SCR_EditableEntityUIInfo.c.

GetEntityChildrenBudgetCost()

void SCR_EditableEntityUIInfo::GetEntityChildrenBudgetCost ( out notnull array< ref SCR_EntityBudgetValue > outBudgets )

inlineprotected

Get only Entity's children budget costs, i.e. cost of entities inside a composition entitiy.

Definition at line 142 of file SCR_EditableEntityUIInfo.c.

GetEntityLabels()

int SCR_EditableEntityUIInfo::GetEntityLabels ( out notnull array< EEditableEntityLabel > entityLabels )

inlineprotected

Fill the provided array with auto and authored labels

Parameters

[out]

entityLabels

Returns

number of provided labels (auto + authored)

Definition at line 101 of file SCR_EditableEntityUIInfo.c.

GetEntityType()

EEditableEntityType SCR_EditableEntityUIInfo::GetEntityType ( )

inlineprotected

Get entity type.

Returns

Type

Definition at line 158 of file SCR_EditableEntityUIInfo.c.

GetEntityTypex()

EEditableEntityType SCR_EditableEntityUIInfo::GetEntityTypex ( )

inlineprotected

Definition at line 62 of file SCR_EditableEntityUIInfo.c.

GetFaction()

Faction SCR_EditableEntityUIInfo::GetFaction ( )

inlineprotected

Definition at line 88 of file SCR_EditableEntityUIInfo.c.

GetFactionKey()

FactionKey SCR_EditableEntityUIInfo::GetFactionKey ( )

inlineprotected

Definition at line 68 of file SCR_EditableEntityUIInfo.c.

GetImage()

ResourceName SCR_EditableEntityUIInfo::GetImage ( )

inlineprotected

Definition at line 56 of file SCR_EditableEntityUIInfo.c.

GetName()

override LocalizedString SCR_EditableEntityUIInfo::GetName ( )

inlineprotected

Definition at line 39 of file SCR_EditableEntityUIInfo.c.

GetSlotPrefab()

ResourceName SCR_EditableEntityUIInfo::GetSlotPrefab ( )

inlineprotected

Get prefab this entity prefab extends.

Returns

Type

Definition at line 150 of file SCR_EditableEntityUIInfo.c.

HasEntityFlag()

bool SCR_EditableEntityUIInfo::HasEntityFlag ( EEditableEntityFlag flag )

inlineprotected

Check if a flag is active.

Parameters

flag

Returns

True if the flag is active

Definition at line 167 of file SCR_EditableEntityUIInfo.c.

HasEntityLabel()

bool SCR_EditableEntityUIInfo::HasEntityLabel ( EEditableEntityLabel label )

inlineprotected

Check if entity has label in either Auto or Authored labels

Parameters

label

Label to search

Returns

true if entity has the label

Definition at line 112 of file SCR_EditableEntityUIInfo.c.

InitFromSource()

void SCR_EditableEntityUIInfo::InitFromSource ( IEntityComponentSource componentSource )

inlineprotected

Initialise UI info from component source

Parameters

componentSource

Definition at line 197 of file SCR_EditableEntityUIInfo.c.

IsFullBackgroundAssetCard()

bool SCR_EditableEntityUIInfo::IsFullBackgroundAssetCard ( )

inlineprotected

Definition at line 50 of file SCR_EditableEntityUIInfo.c.

OverrideFactionKey()

void SCR_EditableEntityUIInfo::OverrideFactionKey ( FactionKey newKey )

inlineprotected

Definition at line 82 of file SCR_EditableEntityUIInfo.c.

SetAssetImageTo()

bool SCR_EditableEntityUIInfo::SetAssetImageTo ( ImageWidget imageWidget )

inlineprotected

Set asset image to given image widget and stretches if is full background flagged. Use this function instead of retrieving the texture using GetIconPath() and setting it manually! When the texture is an image set, manual setting would not work.

Parameters

imageWidget

Target image widget

Returns

True when the image was set

Definition at line 178 of file SCR_EditableEntityUIInfo.c.

Member Data Documentation

EDITABLE_ENTITY_FALLBACK_NAME

const LocalizedString SCR_EditableEntityUIInfo::EDITABLE_ENTITY_FALLBACK_NAME = "#AR-AttributesDialog_TitlePage_Entity_Text"

staticprotected

Definition at line 35 of file SCR_EditableEntityUIInfo.c.

m_bFullBackgroundAssetCard

bool SCR_EditableEntityUIInfo::m_bFullBackgroundAssetCard

protected

Definition at line 26 of file SCR_EditableEntityUIInfo.c.

m_EntityFlags

EEditableEntityFlag SCR_EditableEntityUIInfo::m_EntityFlags

protected

Definition at line 32 of file SCR_EditableEntityUIInfo.c.

m_EntityType

EEditableEntityType SCR_EditableEntityUIInfo::m_EntityType

protected

Definition at line 31 of file SCR_EditableEntityUIInfo.c.

m_sFactionKeyOverride

FactionKey SCR_EditableEntityUIInfo::m_sFactionKeyOverride

protected

Definition at line 28 of file SCR_EditableEntityUIInfo.c.

m_SlotPrefab

ResourceName SCR_EditableEntityUIInfo::m_SlotPrefab

protected

Definition at line 23 of file SCR_EditableEntityUIInfo.c.

---

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

• scripts/Game/Editor/Containers/UIInfo/SCR_EditableEntityUIInfo.c