Inheritance diagram for SCR_EditableGroupUIInfo:

[legend]

Public Member Functions
SCR_MilitarySymbol	GetMilitarySymbol ()
	Get military symbol.

void	SetInstance (SCR_MilitarySymbol symbol, LocalizedString name)
	Set info instance.

override string	GetName ()
	Get name.

override bool	GetEntityBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get Entity budget costs.

bool	GetGroupBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets)
	Get Group budget costs Use when you need to get a set budget values for the group and don't want to relay on default logic where AI budget is deducted by individually spawned AI.

override void	CopyFrom (SCR_UIName source)

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.

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.

Protected Attributes
bool	m_bUseUIInfoName

ref SCR_MilitarySymbol	m_MilitarySymbol

SCR_MilitarySymbol	m_MilitarySymbolInstance

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"

override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Member Function Documentation

◆ CopyFrom()

override void SCR_EditableGroupUIInfo.CopyFrom ( SCR_UIName source )

Implements SCR_EditableEntityUIInfo.

◆ GetEntityBudgetCost()

override bool SCR_EditableGroupUIInfo.GetEntityBudgetCost ( out notnull array< ref SCR_EntityBudgetValue > outBudgets )

Get Entity budget costs.

Implements SCR_EditableEntityUIInfo.

◆ GetGroupBudgetCost()

bool SCR_EditableGroupUIInfo.GetGroupBudgetCost ( out notnull array< ref SCR_EntityBudgetValue > outBudgets )

Get Group budget costs Use when you need to get a set budget values for the group and don't want to relay on default logic where AI budget is deducted by individually spawned AI.

◆ GetMilitarySymbol()

SCR_MilitarySymbol SCR_EditableGroupUIInfo.GetMilitarySymbol ( )

Get military symbol.

Returns: Military symbol

◆ GetName()

override string SCR_EditableGroupUIInfo.GetName ( )

Get name.

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

Returns: Name text

Implements SCR_EditableEntityUIInfo.

◆ SetInstance()

void SCR_EditableGroupUIInfo.SetInstance	(	SCR_MilitarySymbol	symbol,
		LocalizedString	name
	)

Set info instance.

Use only when the UI info is on entity instance, not prefab!

Parameters

symbol	Military symbol
name

Member Data Documentation

◆ m_bUseUIInfoName

bool SCR_EditableGroupUIInfo.m_bUseUIInfoName

protected

◆ m_MilitarySymbol

ref SCR_MilitarySymbol SCR_EditableGroupUIInfo.m_MilitarySymbol

protected

◆ m_MilitarySymbolInstance

SCR_MilitarySymbol SCR_EditableGroupUIInfo.m_MilitarySymbolInstance

protected

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

Game/Editor/Containers/UIInfo/SCR_EditableGroupUIInfo.c

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CopyFrom()

◆ GetEntityBudgetCost()

◆ GetGroupBudgetCost()

◆ GetMilitarySymbol()

◆ GetName()

◆ SetInstance()

Member Data Documentation

◆ m_bUseUIInfoName

◆ m_MilitarySymbol

◆ m_MilitarySymbolInstance