Inheritance diagram for SCR_RequestedTaskUIInfo:

Public Member Functions
void	SetRequesterGroupId (int groupId)

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

Public Member Functions inherited from SCR_TaskUIInfo
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.

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_RequestedTaskUIInfo	CreateRequestedTaskUIInfo (LocalizedString name, array< LocalizedString > nameParams, LocalizedString description, array< LocalizedString > descParams, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty, int requesterGroupId=0)
	Create SCR_RequestedTaskUIInfo from basic params.

Static Public Member Functions inherited from SCR_TaskUIInfo
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 Attributes
int	m_iRequesterGroupId

Protected Attributes inherited from SCR_TaskUIInfo
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

Additional Inherited Members
Protected Member Functions inherited from SCR_TaskUIInfo
LocalizedString	NameParam (int index)

LocalizedString	DescriptionParam (int index)

Static Protected Attributes inherited from SCR_TaskUIInfo
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

◆ CreateRequestedTaskUIInfo()

static SCR_RequestedTaskUIInfo SCR_RequestedTaskUIInfo.CreateRequestedTaskUIInfo	(	LocalizedString	name,
		array< LocalizedString >	nameParams,
		LocalizedString	description,
		array< LocalizedString >	descParams,
		ResourceName	icon = ResourceName::Empty,
		string	iconSetName = string::Empty,
		int	requesterGroupId = 0 )

static

Create SCR_RequestedTaskUIInfo from basic params.

Parameters

[in]	name
[in]	nameParams
[in]	description
[in]	descParams
[in]	icon
[in]	iconSetName
[in]	requesterGroupId

Returns: SCR_RequestedTaskUIInfo class

◆ SetDescriptionTo()

override bool SCR_RequestedTaskUIInfo.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_TaskUIInfo.

◆ SetRequesterGroupId()

void SCR_RequestedTaskUIInfo.SetRequesterGroupId ( int groupId )

Member Data Documentation

◆ m_iRequesterGroupId

int SCR_RequestedTaskUIInfo.m_iRequesterGroupId

protected

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

Game/UI/SCR_RequestedTaskUIInfo.c

Public Member Functions

Static Public Member Functions