Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_TaskUIInfo Class Reference
Inheritance diagram for SCR_TaskUIInfo:
SCR_UIInfo SCR_RequestedTaskUIInfo

Protected 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)
void SetUnformattedName (LocalizedString name, array< LocalizedString > nameParams=null)
 Sets unformatted name with parameters.
LocalizedString GetUnformattedDescription (out array< LocalizedString > params=null)
void SetUnformattedDescription (LocalizedString description, array< LocalizedString > descriptionParams=null)
 Sets unformatted description with parameters.
override bool SetNameTo (TextWidget textWidget)
override bool SetDescriptionTo (TextWidget textWidget)
string GetTranslatedName ()
LocalizedString NameParam (int index)
LocalizedString DescriptionParam (int index)
override void CopyFrom (SCR_UIName source)
bool HasCustomIcon ()
bool HasCustomName ()
bool HasCustomDescription ()

Static Protected Member Functions

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

Protected Attributes

ref array< LocalizedStringm_aNameParameters
ref array< LocalizedStringm_aDescriptionParameters
const int MAX_PARAM_COUNT = 9
int m_iDefaultFlags = 0
const int FLAG_CUSTOM_ICON = 1 << 0
const int FLAG_CUSTOM_NAME = 1 << 1
const int FLAG_CUSTOM_DESCRIPTION = 1 << 2

Detailed Description

Definition at line 2 of file SCR_TaskUIInfo.c.

Member Function Documentation

◆ CopyFrom()

override void SCR_TaskUIInfo::CopyFrom ( SCR_UIName source)
inlineprotected

Definition at line 192 of file SCR_TaskUIInfo.c.

◆ CreateInfo()

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

Create SCR_TaskUIInfo from basic params.

Parameters
name
description
icon
iconSetName
Returns
SCR_TaskUIInfo class

Definition at line 161 of file SCR_TaskUIInfo.c.

◆ DescriptionParam()

LocalizedString SCR_TaskUIInfo::DescriptionParam ( int index)
inlineprotected
Parameters
index
Returns

Definition at line 146 of file SCR_TaskUIInfo.c.

◆ GetTranslatedName()

string SCR_TaskUIInfo::GetTranslatedName ( )
inlineprotected
Returns

Definition at line 122 of file SCR_TaskUIInfo.c.

◆ GetUnformattedDescription()

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

Returns unformatted description and parameters

Parameters
[out]params
Returns

Definition at line 66 of file SCR_TaskUIInfo.c.

◆ GetUnformattedName()

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

Returns unformatted name and parameters

Parameters
[out]params
Returns

Definition at line 37 of file SCR_TaskUIInfo.c.

◆ HasCustomDescription()

bool SCR_TaskUIInfo::HasCustomDescription ( )
inlineprotected

Definition at line 228 of file SCR_TaskUIInfo.c.

◆ HasCustomIcon()

bool SCR_TaskUIInfo::HasCustomIcon ( )
inlineprotected

Definition at line 216 of file SCR_TaskUIInfo.c.

◆ HasCustomName()

bool SCR_TaskUIInfo::HasCustomName ( )
inlineprotected

Definition at line 222 of file SCR_TaskUIInfo.c.

◆ NameParam()

LocalizedString SCR_TaskUIInfo::NameParam ( int index)
inlineprotected
Parameters
index
Returns

Definition at line 134 of file SCR_TaskUIInfo.c.

◆ SetDescriptionTo()

override bool SCR_TaskUIInfo::SetDescriptionTo ( TextWidget textWidget)
inlineprotected

Definition at line 106 of file SCR_TaskUIInfo.c.

◆ SetIconPath()

void SCR_TaskUIInfo::SetIconPath ( ResourceName iconPath)
inlineprotected

Sets icon path to given path.

Definition at line 19 of file SCR_TaskUIInfo.c.

◆ SetIconSetName()

void SCR_TaskUIInfo::SetIconSetName ( string iconSetName)
inlineprotected

Sets icon path to given path.

Definition at line 27 of file SCR_TaskUIInfo.c.

◆ SetNameTo()

override bool SCR_TaskUIInfo::SetNameTo ( TextWidget textWidget)
inlineprotected

Definition at line 92 of file SCR_TaskUIInfo.c.

◆ SetUnformattedDescription()

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

Sets unformatted description with parameters.

Definition at line 79 of file SCR_TaskUIInfo.c.

◆ SetUnformattedName()

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

Sets unformatted name with parameters.

Definition at line 50 of file SCR_TaskUIInfo.c.

Member Data Documentation

◆ FLAG_CUSTOM_DESCRIPTION

const int SCR_TaskUIInfo::FLAG_CUSTOM_DESCRIPTION = 1 << 2
protected

Definition at line 15 of file SCR_TaskUIInfo.c.

◆ FLAG_CUSTOM_ICON

const int SCR_TaskUIInfo::FLAG_CUSTOM_ICON = 1 << 0
protected

Definition at line 13 of file SCR_TaskUIInfo.c.

◆ FLAG_CUSTOM_NAME

const int SCR_TaskUIInfo::FLAG_CUSTOM_NAME = 1 << 1
protected

Definition at line 14 of file SCR_TaskUIInfo.c.

◆ m_aDescriptionParameters

ref array<LocalizedString> SCR_TaskUIInfo::m_aDescriptionParameters
protected

Definition at line 8 of file SCR_TaskUIInfo.c.

◆ m_aNameParameters

ref array<LocalizedString> SCR_TaskUIInfo::m_aNameParameters
protected

Definition at line 5 of file SCR_TaskUIInfo.c.

◆ m_iDefaultFlags

int SCR_TaskUIInfo::m_iDefaultFlags = 0
protected

Definition at line 12 of file SCR_TaskUIInfo.c.

◆ MAX_PARAM_COUNT

const int SCR_TaskUIInfo::MAX_PARAM_COUNT = 9
protected

Definition at line 10 of file SCR_TaskUIInfo.c.


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