Inheritance diagram for SCR_TaskUIInfo:

Public Member Functions
void	SetIconPath (ResourceName iconPath)
	Sets icon path to given path.

void	SetIconSetName (string iconSetName)
	Sets icon path to given path.

LocalizedString	GetUnformattedName (out array< LocalizedString > params=null)
	Returns unformatted name and parameters.

void	SetUnformattedName (LocalizedString name, array< LocalizedString > nameParams=null)
	Sets unformatted name with parameters.

LocalizedString	GetUnformattedDescription (out array< LocalizedString > params=null)
	Returns unformatted description and parameters.

void	SetUnformattedDescription (LocalizedString description, array< LocalizedString > descriptionParams=null)
	Sets unformatted description with parameters.

override bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

override bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.

string	GetTranslatedName ()

override void	CopyFrom (SCR_UIName source)

bool	HasCustomIcon ()

bool	HasCustomName ()

bool	HasCustomDescription ()

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.

LocalizedString	GetName ()
	Get name.

bool	HasName ()
	Check if the info has a name defined.

Static Public Member Functions
static SCR_TaskUIInfo	CreateInfo (LocalizedString name, array< LocalizedString > nameParams, LocalizedString description, array< LocalizedString > descParams, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_TaskUIInfo from basic params.

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.

Protected Member Functions
LocalizedString	NameParam (int index)

LocalizedString	DescriptionParam (int index)

Protected Attributes
ref array< LocalizedString >	m_aNameParameters

ref array< LocalizedString >	m_aDescriptionParameters

int	m_iDefaultFlags = 0

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

Static Protected Attributes
const int	MAX_PARAM_COUNT = 9

const int	FLAG_CUSTOM_ICON = 1 << 0

const int	FLAG_CUSTOM_NAME = 1 << 1

const int	FLAG_CUSTOM_DESCRIPTION = 1 << 2

Member Function Documentation

◆ CopyFrom()

override void SCR_TaskUIInfo.CopyFrom ( SCR_UIName source )

Implements SCR_UIInfo.

◆ CreateInfo()

static SCR_TaskUIInfo SCR_TaskUIInfo.CreateInfo	(	LocalizedString	name,
		array< LocalizedString >	nameParams,
		LocalizedString	description,
		array< LocalizedString >	descParams,
		ResourceName	icon = ResourceName::Empty,
		string	iconSetName = string::Empty )

static

Create SCR_TaskUIInfo from basic params.

Parameters

name
description
icon
iconSetName

Returns: SCR_TaskUIInfo class

◆ DescriptionParam()

LocalizedString SCR_TaskUIInfo.DescriptionParam ( int index )

protected

Parameters

index

Returns

◆ GetTranslatedName()

string SCR_TaskUIInfo.GetTranslatedName ( )

Returns

◆ GetUnformattedDescription()

LocalizedString SCR_TaskUIInfo.GetUnformattedDescription ( out array< LocalizedString > params = null )

Returns unformatted description and parameters.

Parameters

[out] params

Returns

◆ GetUnformattedName()

LocalizedString SCR_TaskUIInfo.GetUnformattedName ( out array< LocalizedString > params = null )

Returns unformatted name and parameters.

Parameters

[out] params

Returns

◆ HasCustomDescription()

bool SCR_TaskUIInfo.HasCustomDescription ( )

◆ HasCustomIcon()

bool SCR_TaskUIInfo.HasCustomIcon ( )

◆ HasCustomName()

bool SCR_TaskUIInfo.HasCustomName ( )

◆ NameParam()

LocalizedString SCR_TaskUIInfo.NameParam ( int index )

protected

Parameters

index

Returns

◆ SetDescriptionTo()

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

Implemented in SCR_RequestedTaskUIInfo.

◆ SetIconPath()

void SCR_TaskUIInfo.SetIconPath ( ResourceName iconPath )

Sets icon path to given path.

◆ SetIconSetName()

void SCR_TaskUIInfo.SetIconSetName ( string iconSetName )

Sets icon path to given path.

◆ SetNameTo()

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

◆ SetUnformattedDescription()

void SCR_TaskUIInfo.SetUnformattedDescription	(	LocalizedString	description,
		array< LocalizedString >	descriptionParams = null )

Sets unformatted description with parameters.

◆ SetUnformattedName()

void SCR_TaskUIInfo.SetUnformattedName	(	LocalizedString	name,
		array< LocalizedString >	nameParams = null )

Sets unformatted name with parameters.

Member Data Documentation

◆ FLAG_CUSTOM_DESCRIPTION

const int SCR_TaskUIInfo.FLAG_CUSTOM_DESCRIPTION = 1 << 2

staticprotected

◆ FLAG_CUSTOM_ICON

const int SCR_TaskUIInfo.FLAG_CUSTOM_ICON = 1 << 0

staticprotected

◆ FLAG_CUSTOM_NAME

const int SCR_TaskUIInfo.FLAG_CUSTOM_NAME = 1 << 1

staticprotected

◆ m_aDescriptionParameters

ref array<LocalizedString> SCR_TaskUIInfo.m_aDescriptionParameters

protected

◆ m_aNameParameters

ref array<LocalizedString> SCR_TaskUIInfo.m_aNameParameters

protected

◆ m_iDefaultFlags

int SCR_TaskUIInfo.m_iDefaultFlags = 0

protected

◆ MAX_PARAM_COUNT

const int SCR_TaskUIInfo.MAX_PARAM_COUNT = 9

staticprotected

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

Game/UI/SCR_TaskUIInfo.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

◆ CopyFrom()

◆ CreateInfo()

◆ DescriptionParam()

◆ GetTranslatedName()

◆ GetUnformattedDescription()

◆ GetUnformattedName()

◆ HasCustomDescription()

◆ HasCustomIcon()

◆ HasCustomName()

◆ NameParam()

◆ SetDescriptionTo()

◆ SetIconPath()

◆ SetIconSetName()

◆ SetNameTo()

◆ SetUnformattedDescription()

◆ SetUnformattedName()

Member Data Documentation

◆ FLAG_CUSTOM_DESCRIPTION

◆ FLAG_CUSTOM_ICON

◆ FLAG_CUSTOM_NAME

◆ m_aDescriptionParameters

◆ m_aNameParameters

◆ m_iDefaultFlags

◆ MAX_PARAM_COUNT