SCR_HintSequenceComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_HintSequenceComponentClass

Functions
bool	StartSequence ()
void	StopSequence ()
void	ToggleSequence ()
bool	IsSequenceActive ()
ScriptInvoker	GetOnSequenceChange ()
void	OnHintShow (SCR_HintUIInfo info, bool isSilent)
void	OnHintHide (SCR_HintUIInfo info, bool isSilent)
void	Clear ()
	Remove all calls from list.

Variables
SCR_HintSequenceComponentClass	m_bIsActive
ref ScriptInvoker	m_OnSequenceChange = new ScriptInvoker

Function Documentation

GetOnSequenceChange()

ScriptInvoker GetOnSequenceChange ( )

protected

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 ( )

protected

Check if the hint sequence is currently active.

Returns

True when active

Definition at line 76 of file SCR_HintSequenceComponent.c.

OnHintHide()

void OnHintHide ( SCR_HintUIInfo info, bool isSilent )

protected

Definition at line 103 of file SCR_HintSequenceComponent.c.

OnHintShow()

void OnHintShow ( SCR_HintUIInfo info, bool isSilent )

protected

Definition at line 94 of file SCR_HintSequenceComponent.c.

StartSequence()

bool StartSequence ( )

protected

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 ( )

protected

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 ( )

protected

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

ref ScriptInvoker m_OnSequenceChange = new ScriptInvoker

protected

Definition at line 18 of file SCR_HintSequenceComponent.c.