SCR_EditableEntityUIInfo Interface Reference

Inheritance diagram for SCR_EditableEntityUIInfo:

Public Member Functions
override LocalizedString	GetName ()
	Get name.
bool	IsFullBackgroundAssetCard ()
ResourceName	GetImage ()
EEditableEntityType	GetEntityTypex ()
FactionKey	GetFactionKey ()
Faction	GetFaction ()
int	GetEntityLabels (out notnull array< EEditableEntityLabel > entityLabels)
	Fill the provided array with auto and authored labels.
bool	HasEntityLabel (EEditableEntityLabel label)
	Check if entity has label in either Auto or Authored labels.
bool	GetEntityBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get Entity budget costs.
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 ()
	Get prefab this entity prefab extends.
EEditableEntityType	GetEntityType ()
	Get entity type.
bool	HasEntityFlag (EEditableEntityFlag flag)
	Check if a flag is active.
bool	SetAssetImageTo (ImageWidget imageWidget)
	Set asset image to given image widget and stretches if is full background flagged.
void	InitFromSource (IEntityComponentSource componentSource)
	Initialise UI info from component source.
Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.
string	GetIconSetName ()
	Returns Icon Set name if imageset.
bool	HasIcon ()
	Check if the info has an icon defined.
bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.
void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.
LocalizedString	GetDescription ()
	Get description.
bool	HasDescription ()
	Check if the info has a description defined.
bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.
void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.
LocalizedString	GetName ()
	Get name.
bool	HasName ()
	Check if the info has a name defined.
bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.
void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

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

Protected Member Functions
override void	CopyFrom (SCR_UIName source)
override void	CopyFrom (SCR_UIName source)
override void	CopyFrom (SCR_UIName source)
void	CopyFrom (SCR_UIName source)

Protected Attributes
ResourceName	m_SlotPrefab
bool	m_bFullBackgroundAssetCard
EEditableEntityType	m_EntityType
EEditableEntityFlag	m_EntityFlags
Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon
string	IconSetName
Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description
Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.
static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.
static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.
static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

Member Function Documentation

CopyFrom()

override void SCR_EditableEntityUIInfo.CopyFrom ( SCR_UIName  source )

protected

Implements SCR_UIInfo.

Implemented in SCR_EditableDescriptorUIInfo, and SCR_EditableGroupUIInfo.

GetEntityAndChildrenBudgetCost()

void SCR_EditableEntityUIInfo.GetEntityAndChildrenBudgetCost

(

out notnull array< ref SCR_EntityBudgetValue >

outBudgets

)

Get Entity and its children budgets.

GetEntityBudgetCost()

bool SCR_EditableEntityUIInfo.GetEntityBudgetCost

(

out notnull array< ref SCR_EntityBudgetValue >

outBudgets

)

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

Implemented in SCR_EditableGroupUIInfo.

GetEntityChildrenBudgetCost()

void SCR_EditableEntityUIInfo.GetEntityChildrenBudgetCost

(

out notnull array< ref SCR_EntityBudgetValue >

outBudgets

)

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

GetEntityLabels()

int SCR_EditableEntityUIInfo.GetEntityLabels

(

out notnull array< EEditableEntityLabel >

entityLabels

)

Fill the provided array with auto and authored labels.

Parameters

[out]

entityLabels

Returns

number of provided labels (auto + authored)

GetEntityType()

EEditableEntityType SCR_EditableEntityUIInfo.GetEntityType

(

)

Get entity type.

Returns

Type

GetEntityTypex()

EEditableEntityType SCR_EditableEntityUIInfo.GetEntityTypex

(

)

GetFaction()

Faction SCR_EditableEntityUIInfo.GetFaction

(

)

GetFactionKey()

FactionKey SCR_EditableEntityUIInfo.GetFactionKey

(

)

GetImage()

ResourceName SCR_EditableEntityUIInfo.GetImage

(

)

GetName()

override LocalizedString SCR_EditableEntityUIInfo.GetName

(

)

Get name.

When using it to fill TextWidget, use SetNameTo() if possible.

Returns

Name text

Implements SCR_UIName.

Implemented in SCR_EditableGroupUIInfo.

GetSlotPrefab()

ResourceName SCR_EditableEntityUIInfo.GetSlotPrefab

(

)

Get prefab this entity prefab extends.

Returns

Type

HasEntityFlag()

bool SCR_EditableEntityUIInfo.HasEntityFlag

(

EEditableEntityFlag

flag

)

Check if a flag is active.

Parameters

flag

Returns

True if the flag is active

HasEntityLabel()

bool SCR_EditableEntityUIInfo.HasEntityLabel

(

EEditableEntityLabel

label

)

Check if entity has label in either Auto or Authored labels.

Parameters

label

Label to search

Returns

true if entity has the label

InitFromSource()

void SCR_EditableEntityUIInfo.InitFromSource

(

IEntityComponentSource

componentSource

)

Initialise UI info from component source.

Parameters

componentSource

IsFullBackgroundAssetCard()

bool SCR_EditableEntityUIInfo.IsFullBackgroundAssetCard

(

)

SetAssetImageTo()

bool SCR_EditableEntityUIInfo.SetAssetImageTo

(

ImageWidget

imageWidget

)

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

Member Data Documentation

EDITABLE_ENTITY_FALLBACK_NAME

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

static

m_bFullBackgroundAssetCard

bool SCR_EditableEntityUIInfo.m_bFullBackgroundAssetCard

protected

m_EntityFlags

EEditableEntityFlag SCR_EditableEntityUIInfo.m_EntityFlags

protected

m_EntityType

EEditableEntityType SCR_EditableEntityUIInfo.m_EntityType

protected

m_SlotPrefab

ResourceName SCR_EditableEntityUIInfo.m_SlotPrefab

protected

---

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

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