SCR_HintUIInfo Class Reference

Inheritance diagram for SCR_HintUIInfo:

Protected Member Functions
bool	ShouldFactionSeeHint ()
bool	GetIsDontShowAgainVisible ()
EHint	GetType ()
int	GetShowLimit ()
bool	IsTimerVisible ()
void	SetPriority (int priority)
int	GetPriority ()
float	GetDuration ()
WorldTimestamp	GetTimeStarted ()
void	SetTimeStamp ()
	Set the time stamp of Hint start. Needed for hint timer timekeeping.
int	GetHighlightWidgetNames (out notnull array< string > outWidgetNames)
EFieldManualEntryId	GetFieldManualLink ()
void	InitSequence (int page, int count)
int	GetSequencePage ()
int	GetSequenceCount ()
bool	IsInSequence ()
bool	IsPersistent ()
void	SetPersistent (bool persistent)
override bool	SetDescriptionTo (TextWidget textWidget)

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

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
bool	m_bIsDontShowAgainVisible
ref array< SCR_ECampaignFaction >	m_aHiddenForFactions
int	m_iSequencePage
int	m_iSequenceCount
WorldTimestamp	m_iTimeHintStarted

Detailed Description

Definition at line 2 of file SCR_HintUIInfo.c.

Member Function Documentation

CreateInfo()

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

inlinestaticprotected

Parameters

description
name
duration
type
fieldManualEntry
isTimerVisible

Returns

the created SCR_HintUIInfo from the provided information

Definition at line 204 of file SCR_HintUIInfo.c.

GetDuration()

float SCR_HintUIInfo::GetDuration ( )

inlineprotected

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

Returns

duration

Definition at line 111 of file SCR_HintUIInfo.c.

GetFieldManualLink()

EFieldManualEntryId SCR_HintUIInfo::GetFieldManualLink ( )

inlineprotected

Get link to associated field manual entry.

Returns

Field manual entry ID

Definition at line 147 of file SCR_HintUIInfo.c.

GetHighlightWidgetNames()

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

inlineprotected

Get names of widgets that should be highlighted.

Parameters

[out]

Array

to be filled with widget names

Returns

number of names

Definition at line 136 of file SCR_HintUIInfo.c.

GetIsDontShowAgainVisible()

bool SCR_HintUIInfo::GetIsDontShowAgainVisible ( )

inlineprotected

Definition at line 64 of file SCR_HintUIInfo.c.

GetPriority()

int SCR_HintUIInfo::GetPriority ( )

inlineprotected

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

Definition at line 103 of file SCR_HintUIInfo.c.

GetSequenceCount()

int SCR_HintUIInfo::GetSequenceCount ( )

inlineprotected

Returns

Total number of hints in the sequence

Definition at line 171 of file SCR_HintUIInfo.c.

GetSequencePage()

int SCR_HintUIInfo::GetSequencePage ( )

inlineprotected

Returns

Sequence page number of this hint

Definition at line 164 of file SCR_HintUIInfo.c.

GetShowLimit()

int SCR_HintUIInfo::GetShowLimit ( )

inlineprotected

Get how many times can the hint be shown. Valid only if Type is defined!

Returns

display limit

Definition at line 81 of file SCR_HintUIInfo.c.

GetTimeStarted()

WorldTimestamp SCR_HintUIInfo::GetTimeStarted ( )

inlineprotected

Get the time of Hint start, needed for proper Map implementation. Returns Replication.Time() of hint creation;

Returns

Definition at line 119 of file SCR_HintUIInfo.c.

GetType()

EHint SCR_HintUIInfo::GetType ( )

inlineprotected

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

Returns

hint type

Definition at line 72 of file SCR_HintUIInfo.c.

InitSequence()

void SCR_HintUIInfo::InitSequence ( int page, int count )

inlineprotected

Initialize hint sequence

Parameters

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

Definition at line 156 of file SCR_HintUIInfo.c.

IsInSequence()

bool SCR_HintUIInfo::IsInSequence ( )

inlineprotected

Returns

True whent he hint is a part of a sequence.

Definition at line 178 of file SCR_HintUIInfo.c.

IsPersistent()

bool SCR_HintUIInfo::IsPersistent ( )

inlineprotected

Definition at line 184 of file SCR_HintUIInfo.c.

IsTimerVisible()

bool SCR_HintUIInfo::IsTimerVisible ( )

inlineprotected

Get if the animated timer should be visible.

Returns

true if the timer is visible, false otherwise

Definition at line 89 of file SCR_HintUIInfo.c.

SetDescriptionTo()

override bool SCR_HintUIInfo::SetDescriptionTo ( TextWidget textWidget )

inlineprotected

Definition at line 217 of file SCR_HintUIInfo.c.

SetPersistent()

void SCR_HintUIInfo::SetPersistent ( bool persistent )

inlineprotected

Definition at line 190 of file SCR_HintUIInfo.c.

SetPriority()

void SCR_HintUIInfo::SetPriority ( int priority )

inlineprotected

Definition at line 95 of file SCR_HintUIInfo.c.

SetTimeStamp()

void SCR_HintUIInfo::SetTimeStamp ( )

inlineprotected

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

Definition at line 126 of file SCR_HintUIInfo.c.

ShouldFactionSeeHint()

bool SCR_HintUIInfo::ShouldFactionSeeHint ( )

inlineprotected

Check whether the player's faction is within the array of faction enums that this hint should not be shown to

Returns

true if the player's faction can see this hint (or if the player has no faction)

Definition at line 41 of file SCR_HintUIInfo.c.

Member Data Documentation

m_aHiddenForFactions

ref array<SCR_ECampaignFaction> SCR_HintUIInfo::m_aHiddenForFactions

protected

Definition at line 32 of file SCR_HintUIInfo.c.

m_aHighlightWidgetsNames

ref array<string> SCR_HintUIInfo::m_aHighlightWidgetsNames

protected

Definition at line 17 of file SCR_HintUIInfo.c.

m_bIsDontShowAgainVisible

bool SCR_HintUIInfo::m_bIsDontShowAgainVisible

protected

Definition at line 29 of file SCR_HintUIInfo.c.

m_bIsTimerVisible

bool SCR_HintUIInfo::m_bIsTimerVisible

protected

Definition at line 20 of file SCR_HintUIInfo.c.

m_bPersistent

bool SCR_HintUIInfo::m_bPersistent

protected

Definition at line 26 of file SCR_HintUIInfo.c.

m_fDuration

float SCR_HintUIInfo::m_fDuration

protected

Definition at line 14 of file SCR_HintUIInfo.c.

m_FieldManualLink

EFieldManualEntryId SCR_HintUIInfo::m_FieldManualLink

protected

Definition at line 23 of file SCR_HintUIInfo.c.

m_iPriority

int SCR_HintUIInfo::m_iPriority

protected

Definition at line 11 of file SCR_HintUIInfo.c.

m_iSequenceCount

int SCR_HintUIInfo::m_iSequenceCount

protected

Definition at line 35 of file SCR_HintUIInfo.c.

m_iSequencePage

int SCR_HintUIInfo::m_iSequencePage

protected

Definition at line 34 of file SCR_HintUIInfo.c.

m_iShowLimit

int SCR_HintUIInfo::m_iShowLimit

protected

Definition at line 8 of file SCR_HintUIInfo.c.

m_iTimeHintStarted

WorldTimestamp SCR_HintUIInfo::m_iTimeHintStarted

protected

Definition at line 36 of file SCR_HintUIInfo.c.

m_Type

EHint SCR_HintUIInfo::m_Type

protectedattribute

Definition at line 5 of file SCR_HintUIInfo.c.

---

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

• scripts/Game/Editor/Containers/UIInfo/SCR_HintUIInfo.c