Inheritance diagram for SCR_HintUIInfo:

[legend]

Public Member Functions
EHint	GetType ()
	Get hint type.

int	GetShowLimit ()
	Get how many times can the hint be shown.

bool	IsTimerVisible ()
	Get if the animated timer should be visible.

int	GetPriority ()
	Get priority of the hint.

float	GetDuration ()
	Get duration for which the hint should be displayed (in seconds)

WorldTimestamp	GetTimeStarted ()
	Get the time of Hint start, needed for proper Map implementation.

void	SetTimeStamp ()
	Set the time stamp of Hint start. Needed for hint timer timekeeping.

int	GetHighlightWidgetNames (out notnull array< string > outWidgetNames)
	Get names of widgets that should be highlighted.

EFieldManualEntryId	GetFieldManualLink ()
	Get link to associated field manual entry.

void	InitSequence (int page, int count)
	Initialize hint sequence.

int	GetSequencePage ()

int	GetSequenceCount ()

bool	IsInSequence ()

bool	IsPersistent ()

void	SetPersistent (bool persistent)

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

Public Member Functions inherited from SCR_BlockUIInfo
override bool	HasDescription ()
	Check if the info has a description defined.

override LocalizedString	GetDescription ()
	Get description.

LocalizedString	GetUnformattedDescriptionBlockName (int index)
	Get Name of selected description block without formatting (raw).

void	SetDescriptionBlockName (int index, LocalizedString text)
	Changes the Name (text) of selected Description Block.

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.

Static Public Member Functions
static SCR_HintUIInfo	CreateInfo (string description, string name, float duration, EHint type, EFieldManualEntryId fieldManualEntry, bool isTimerVisible)

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
EHint	m_Type

int	m_iShowLimit

int	m_iPriority

float	m_fDuration

ref array< string >	m_aHighlightWidgetsNames

bool	m_bIsTimerVisible

EFieldManualEntryId	m_FieldManualLink

bool	m_bPersistent

int	m_iSequencePage

int	m_iSequenceCount

WorldTimestamp	m_iTimeHintStarted

Protected Attributes inherited from SCR_BlockUIInfo
ref array< ref SCR_SubBlockUIName >	m_aDescriptionBlocks

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_UIInfo
override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Member Function Documentation

◆ CreateInfo()

static SCR_HintUIInfo SCR_HintUIInfo.CreateInfo	(	string	description,
		string	name,
		float	duration,
		EHint	type,
		EFieldManualEntryId	fieldManualEntry,
		bool	isTimerVisible
	)

static

Parameters

description
name
duration
type
fieldManualEntry
isTimerVisible

Returns: the created SCR_HintUIInfo from the provided information

◆ GetDuration()

float SCR_HintUIInfo.GetDuration ( )

Get duration for which the hint should be displayed (in seconds)

Returns: duration

◆ GetFieldManualLink()

EFieldManualEntryId SCR_HintUIInfo.GetFieldManualLink ( )

Get link to associated field manual entry.

Returns: Field manual entry ID

◆ GetHighlightWidgetNames()

int SCR_HintUIInfo.GetHighlightWidgetNames ( out notnull array< string > outWidgetNames )

Get names of widgets that should be highlighted.

Parameters

[out] Array to be filled with widget names

Returns: number of names

◆ GetPriority()

int SCR_HintUIInfo.GetPriority ( )

Get priority of the hint.

When another hint is already shown, this one will replace it only if it has the same or higher priority.

Returns: priority

◆ GetSequenceCount()

int SCR_HintUIInfo.GetSequenceCount ( )

Returns: Total number of hints in the sequence

◆ GetSequencePage()

int SCR_HintUIInfo.GetSequencePage ( )

Returns: Sequence page number of this hint

◆ GetShowLimit()

int SCR_HintUIInfo.GetShowLimit ( )

Get how many times can the hint be shown.

Valid only if Type is defined!

Returns: display limit

◆ GetTimeStarted()

WorldTimestamp SCR_HintUIInfo.GetTimeStarted ( )

Get the time of Hint start, needed for proper Map implementation.

Returns Replication.Time() of hint creation;

Returns

◆ GetType()

EHint SCR_HintUIInfo.GetType ( )

Get hint type.

When defined, the hint will be persistently saved and not shown again.

Returns: hint type

◆ InitSequence()

void SCR_HintUIInfo.InitSequence	(	int	page,
		int	count
	)

Initialize hint sequence.

Parameters

page	Page number of this hint
count	Total number of hints in the sequence

◆ IsInSequence()

bool SCR_HintUIInfo.IsInSequence ( )

Returns: True whent he hint is a part of a sequence.

◆ IsPersistent()

bool SCR_HintUIInfo.IsPersistent ( )

◆ IsTimerVisible()

bool SCR_HintUIInfo.IsTimerVisible ( )

Get if the animated timer should be visible.

Returns: true if the timer is visible, false otherwise

◆ SetDescriptionTo()

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

◆ SetPersistent()

void SCR_HintUIInfo.SetPersistent ( bool persistent )

◆ SetTimeStamp()

void SCR_HintUIInfo.SetTimeStamp ( )

Set the time stamp of Hint start. Needed for hint timer timekeeping.

Member Data Documentation

◆ m_aHighlightWidgetsNames

ref array<string> SCR_HintUIInfo.m_aHighlightWidgetsNames

protected

◆ m_bIsTimerVisible

bool SCR_HintUIInfo.m_bIsTimerVisible

protected

◆ m_bPersistent

bool SCR_HintUIInfo.m_bPersistent

protected

◆ m_fDuration

float SCR_HintUIInfo.m_fDuration

protected

◆ m_FieldManualLink

EFieldManualEntryId SCR_HintUIInfo.m_FieldManualLink

protected

◆ m_iPriority

int SCR_HintUIInfo.m_iPriority

protected

◆ m_iSequenceCount

int SCR_HintUIInfo.m_iSequenceCount

protected

◆ m_iSequencePage

int SCR_HintUIInfo.m_iSequencePage

protected

◆ m_iShowLimit

int SCR_HintUIInfo.m_iShowLimit

protected

◆ m_iTimeHintStarted

WorldTimestamp SCR_HintUIInfo.m_iTimeHintStarted

protected

◆ m_Type

EHint SCR_HintUIInfo.m_Type

protected

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

Game/Editor/Containers/UIInfo/SCR_HintUIInfo.c

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CreateInfo()

◆ GetDuration()

◆ GetFieldManualLink()

◆ GetHighlightWidgetNames()

◆ GetPriority()

◆ GetSequenceCount()

◆ GetSequencePage()

◆ GetShowLimit()

◆ GetTimeStarted()

◆ GetType()

◆ InitSequence()

◆ IsInSequence()

◆ IsPersistent()

◆ IsTimerVisible()

◆ SetDescriptionTo()

◆ SetPersistent()

◆ SetTimeStamp()

Member Data Documentation

◆ m_aHighlightWidgetsNames

◆ m_bIsTimerVisible

◆ m_bPersistent

◆ m_fDuration

◆ m_FieldManualLink

◆ m_iPriority

◆ m_iSequenceCount

◆ m_iSequencePage

◆ m_iShowLimit

◆ m_iTimeHintStarted

◆ m_Type