SCR_HintManagerComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_HintManagerComponentClass

Typedefs
typedef func	SCR_HintManagerComponent_OnHint

Functions
void	SCR_HintManagerComponent_OnHint (SCR_HintUIInfo info, bool isSilent)
SCR_HintManagerComponentClass SCR_BaseGameModeComponentClass	Attribute ("4")
void	InitConditionLists (IEntity owner)
void	ExitConditionLists (IEntity owner)
bool	ShowCustom (string description, string name=string.Empty, float duration=0, bool isSilent=false, EHint type=EHint.UNDEFINED, EFieldManualEntryId fieldManualEntry=EFieldManualEntryId.NONE, bool isTimerVisible=false)
bool	ClearHint ()
bool	Repeat (bool isSilent=false)
bool	Refresh ()
bool	Hide (SCR_HintUIInfo info=null)
void	Toggle ()
	Toggle hint. Hide it if it's shown, and open it again if it's hidden. More...
void	OpenContext ()
	Open context to currently shown hint. More...
SCR_HintUIInfo	GetLatestHint ()
SCR_HintUIInfo	GetCurrentHint ()
bool	IsShown ()
bool	CanShow ()
bool	WasShown (EHint hint, int limit=1)
bool	WasShown (SCR_HintUIInfo info)
void	SetDurationOverride (float duration)
float	GetDurationOverride ()
ScriptInvokerBase< SCR_HintManagerComponent_OnHint >	GetOnHintShow ()
ScriptInvokerBase< SCR_HintManagerComponent_OnHint >	GetOnHintHide ()
protected void	LoadSettings ()
protected void	SetShown (SCR_HintUIInfo info)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
override void	OnDelete (IEntity owner)

Variables
protected ref array< ref SCR_HintConditionList >	m_aConditionLists

Typedef Documentation

SCR_HintManagerComponent_OnHint

typedef func SCR_HintManagerComponent_OnHint

Definition at line 2 of file SCR_HintManagerComponent.c.

Function Documentation

Attribute()

SCR_HintManagerComponentClass SCR_BaseGameModeComponentClass Attribute

(

"4"

)

Definition at line 35 of file SCR_HintManagerComponent.c.

CanShow()

bool CanShow

(

)

Check if hints are enabled in gameplay settings.

Returns

True when enabled

Definition at line 266 of file SCR_HintManagerComponent.c.

ClearHint()

bool ClearHint

(

)

Returns

Definition at line 159 of file SCR_HintManagerComponent.c.

ExitConditionLists()

void Attribute::ExitConditionLists

(

IEntity

owner

)

Parameters

[in]

owner

Definition at line 20 of file SCR_HintManagerComponent.c.

GetCurrentHint()

SCR_HintUIInfo GetCurrentHint

(

)

Get thecurrently shown hint.

Returns

Hint UI info

Definition at line 247 of file SCR_HintManagerComponent.c.

GetDurationOverride()

float GetDurationOverride

(

)

Get override of hint duration.

Returns

Duration. When 0, no override is active.

Definition at line 304 of file SCR_HintManagerComponent.c.

GetLatestHint()

SCR_HintUIInfo GetLatestHint

(

)

Get the most recent hint.

Returns

Hint UI info

Definition at line 239 of file SCR_HintManagerComponent.c.

GetOnHintHide()

ScriptInvokerBase<SCR_HintManagerComponent_OnHint> GetOnHintHide

(

)

Get the event called when a hint is hidden.

Returns

Script invoker

Definition at line 320 of file SCR_HintManagerComponent.c.

GetOnHintShow()

ScriptInvokerBase<SCR_HintManagerComponent_OnHint> GetOnHintShow

(

)

Get the event called when a hint is shown.

Returns

Script invoker

Definition at line 312 of file SCR_HintManagerComponent.c.

Hide()

bool Hide

(

SCR_HintUIInfo

info = null

)

Hide currently shown hint.

Parameters

[in]

info

When defined, clear only this hint. If other hint is shown, do nothing.

Returns

True if a hint was cleared

Definition at line 197 of file SCR_HintManagerComponent.c.

InitConditionLists()

void Attribute::InitConditionLists

(

IEntity

owner

)

Parameters

[in]

owner

Definition at line 9 of file SCR_HintManagerComponent.c.

IsShown()

bool IsShown

(

)

Check if a hint is shown at this moment.

Returns

True when shown

Definition at line 258 of file SCR_HintManagerComponent.c.

LoadSettings()

protected void LoadSettings

(

)

Definition at line 449 of file SCR_HintManagerComponent.c.

OpenContext()

void OpenContext

(

)

Open context to currently shown hint.

Definition at line 226 of file SCR_HintManagerComponent.c.

Refresh()

bool Refresh

(

)

Silently refresh currently shown hint.

Returns

True if the hint was refreshed

Definition at line 185 of file SCR_HintManagerComponent.c.

Repeat()

bool Repeat

(

bool

isSilent = false

)

Repeat previously shown hint.

Parameters

[in]

isSilent

Returns

True if the hint was shown

Definition at line 174 of file SCR_HintManagerComponent.c.

SCR_HintManagerComponent_OnHint()

void SCR_HintManagerComponent_OnHint	(	SCR_HintUIInfo	info,
		bool	isSilent
	)

SetDurationOverride()

void SetDurationOverride

(

float

duration

)

Override hint duration.

Parameters

[in]

duration.

When 0, override is reset.

Definition at line 297 of file SCR_HintManagerComponent.c.

SetShown()

protected void SetShown

(

SCR_HintUIInfo

info

)

Definition at line 461 of file SCR_HintManagerComponent.c.

ShowCustom()

bool ShowCustom	(	string	description,
		string	name = string.Empty,
		float	duration = 0,
		bool	isSilent = false,
		EHint	type = EHint.UNDEFINED,
		EFieldManualEntryId	fieldManualEntry = EFieldManualEntryId.NONE,
		bool	isTimerVisible = false
	)

Show hint made of custom texts.

---

WARNING!

Use only for quick debugging. For legit use, please configure the hint as SCR_UIInfo attribute on your entity/component/config! That will allow you to set all hint properties, as well as to localize it using LocParserPlugin.

---

Parameters

[in]	description	Hint text
[in]	name	Hint title
[in]	duration	For how long should the hint be shown (in seconds)
[in]	isSilent	True to show the hint without any sound effect
[in]	type	Hint type. When defined, the hint will be shown only once and never again.

Returns

True if the hint was shown

Definition at line 150 of file SCR_HintManagerComponent.c.

Toggle()

void Toggle

(

)

Toggle hint. Hide it if it's shown, and open it again if it's hidden.

Definition at line 216 of file SCR_HintManagerComponent.c.

WasShown() [1/2]

bool WasShown	(	EHint	hint,
		int	limit = 1
	)

Check if hint type was shown previously (even in previous game sessions; the information is stored persistently).

Parameters

[in]	hint	Hint type
[in]	limit	How many times can the hint be shown

Returns

True when shown

Definition at line 276 of file SCR_HintManagerComponent.c.

WasShown() [2/2]

bool WasShown

(

SCR_HintUIInfo

info

)

Check if hint info was shown previously (even in previous game sessions; the information is stored persistently).

Returns

True when shown

Definition at line 289 of file SCR_HintManagerComponent.c.

Variable Documentation

m_aConditionLists

protected ref array<ref SCR_HintConditionList> m_aConditionLists

Definition at line 4 of file SCR_HintManagerComponent.c.