SCR_EditableDescriptorUIInfo Interface Reference

Inheritance diagram for SCR_EditableDescriptorUIInfo:

Public Member Functions
LocalizedString	GetLocationName ()
	Get location name.
void	SetLocationName (LocalizedString locationName)
	Set location name from existing name.
void	SetLocationName (vector pos)
	Set location name from a position.
override bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.
override bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.
override void	CopyFrom (SCR_UIName source)
void	SCR_EditableDescriptorUIInfo ()
Public Member Functions inherited from SCR_EditableEntityUIInfo
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.
ResourceName	GetImageSetPath ()
	Get Image Set.
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.
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.
bool	HasName ()
	Check if the info has a name defined.

Protected Attributes
LocalizedString	m_sNameFormat
LocalizedString	m_sDescriptionFormat
LocalizedString	m_sLocationName
string	m_sNameEncoded
string	m_sDescriptionEncoded
Protected Attributes inherited from SCR_EditableEntityUIInfo
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.
Static Public Attributes inherited from SCR_EditableEntityUIInfo
static const LocalizedString	EDITABLE_ENTITY_FALLBACK_NAME = "#AR-AttributesDialog_TitlePage_Entity_Text"

Constructor & Destructor Documentation

SCR_EditableDescriptorUIInfo()

void SCR_EditableDescriptorUIInfo.SCR_EditableDescriptorUIInfo

(

)

Member Function Documentation

CopyFrom()

override void SCR_EditableDescriptorUIInfo.CopyFrom

(

SCR_UIName

source

)

Implements SCR_EditableEntityUIInfo.

GetLocationName()

LocalizedString SCR_EditableDescriptorUIInfo.GetLocationName

(

)

Get location name.

Returns

Location name

SetDescriptionTo()

override bool SCR_EditableDescriptorUIInfo.SetDescriptionTo

(

TextWidget

textWidget

)

Set description to given text widget.

When possible, use this function instead of retrieving the description using GetDescription() and setting it manually. Custom UI info classes may be using parameters which would not be applied otherwise.

Parameters

textWidget

Target text widget

Returns

True when the description was set

Implements SCR_UIDescription.

SetLocationName() [1/2]

void SCR_EditableDescriptorUIInfo.SetLocationName

(

LocalizedString

locationName

)

Set location name from existing name.

Parameters

locationName

Name of the location

SetLocationName() [2/2]

void SCR_EditableDescriptorUIInfo.SetLocationName

(

vector

pos

)

Set location name from a position.

Parameters

pos

Position

SetNameTo()

override bool SCR_EditableDescriptorUIInfo.SetNameTo

(

TextWidget

textWidget

)

Set name to given text widget.

When possible, use this function instead of retrieving the name using GetName() and setting it manually. Custom UI info classes may be using parameters which would not be applied otherwise.

Parameters

textWidget

Target text widget

Returns

True when the name was set

Implements SCR_UIName.

Member Data Documentation

m_sDescriptionEncoded

string SCR_EditableDescriptorUIInfo.m_sDescriptionEncoded

protected

m_sDescriptionFormat

LocalizedString SCR_EditableDescriptorUIInfo.m_sDescriptionFormat

protected

m_sLocationName

LocalizedString SCR_EditableDescriptorUIInfo.m_sLocationName

protected

m_sNameEncoded

string SCR_EditableDescriptorUIInfo.m_sNameEncoded

protected

m_sNameFormat

LocalizedString SCR_EditableDescriptorUIInfo.m_sNameFormat

protected

---

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

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