SCR_HintSequenceComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_HintSequenceComponentClass

Functions
bool	StartSequence ()
void	StopSequence ()
void	ToggleSequence ()
bool	IsSequenceActive ()
ScriptInvoker	GetOnSequenceChange ()
protected void	OnHintShow (SCR_HintUIInfo info, bool isSilent)
protected void	OnHintHide (SCR_HintUIInfo info, bool isSilent)
protected void	Clear ()

Variables
SCR_HintSequenceComponentClass	m_bIsActive
protected ref ScriptInvoker	m_OnSequenceChange = new ScriptInvoker

Function Documentation

Clear()

protected void Clear

(

)

Definition at line 119 of file SCR_HintSequenceComponent.c.

GetOnSequenceChange()

ScriptInvoker GetOnSequenceChange

(

)

Get the event triggered when the hint sequence starts or stops.

Returns

Script invoker

Definition at line 84 of file SCR_HintSequenceComponent.c.

IsSequenceActive()

bool IsSequenceActive

(

)

Check if the hint sequence is currently active.

Returns

True when active

Definition at line 76 of file SCR_HintSequenceComponent.c.

OnHintHide()

protected void OnHintHide	(	SCR_HintUIInfo	info,
		bool	isSilent
	)

Definition at line 103 of file SCR_HintSequenceComponent.c.

OnHintShow()

protected void OnHintShow	(	SCR_HintUIInfo	info,
		bool	isSilent
	)

Definition at line 94 of file SCR_HintSequenceComponent.c.

StartSequence()

bool StartSequence

(

)

Start hint sequence defined by this component.

Returns

True if the sequence started

Definition at line 27 of file SCR_HintSequenceComponent.c.

StopSequence()

void StopSequence

(

)

Stop hint sequence defined by this component. Has no effect if the sequence is not active.

Definition at line 51 of file SCR_HintSequenceComponent.c.

ToggleSequence()

void ToggleSequence

(

)

Toggle hint sequence defined by this component. Stops the sequence if it is active, and starts it if it is not.

Definition at line 65 of file SCR_HintSequenceComponent.c.

Variable Documentation

m_bIsActive

SCR_HintSequenceComponentClass m_bIsActive

m_OnSequenceChange

protected ref ScriptInvoker m_OnSequenceChange = new ScriptInvoker

Definition at line 18 of file SCR_HintSequenceComponent.c.