SCR_HintSequenceComponent Interface Reference

Inheritance diagram for SCR_HintSequenceComponent:

Public Member Functions
bool	StartSequence ()
	Start hint sequence defined by this component.
void	StopSequence ()
	Stop hint sequence defined by this component.
void	ToggleSequence ()
	Toggle hint sequence defined by this component.
bool	IsSequenceActive ()
	Check if the hint sequence is currently active.
ScriptInvoker	GetOnSequenceChange ()
	Get the event triggered when the hint sequence starts or stops.

Protected Member Functions
void	OnHintShow (SCR_HintUIInfo info, bool isSilent)
void	OnHintHide (SCR_HintUIInfo info, bool isSilent)
void	Clear ()

Protected Attributes
bool	m_bIsActive
ref ScriptInvoker	m_OnSequenceChange = new ScriptInvoker

Detailed Description

Examples

d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

Member Function Documentation

Clear()

void SCR_HintSequenceComponent.Clear ( )

protected

GetOnSequenceChange()

ScriptInvoker SCR_HintSequenceComponent.GetOnSequenceChange

(

)

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

Returns

Script invoker

IsSequenceActive()

bool SCR_HintSequenceComponent.IsSequenceActive

(

)

Check if the hint sequence is currently active.

Returns

True when active

OnHintHide()

void SCR_HintSequenceComponent.OnHintHide ( SCR_HintUIInfo  info, bool  isSilent  )

protected

OnHintShow()

void SCR_HintSequenceComponent.OnHintShow ( SCR_HintUIInfo  info, bool  isSilent  )

protected

StartSequence()

bool SCR_HintSequenceComponent.StartSequence

(

)

Start hint sequence defined by this component.

Returns

True if the sequence started

Examples

d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

StopSequence()

void SCR_HintSequenceComponent.StopSequence

(

)

Stop hint sequence defined by this component.

Has no effect if the sequence is not active.

ToggleSequence()

void SCR_HintSequenceComponent.ToggleSequence

(

)

Toggle hint sequence defined by this component.

Stops the sequence if it is active, and starts it if it is not.

Member Data Documentation

m_bIsActive

bool SCR_HintSequenceComponent.m_bIsActive

protected

m_OnSequenceChange

ref ScriptInvoker SCR_HintSequenceComponent.m_OnSequenceChange = new ScriptInvoker

protected

---

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

• Game/Components/Hints/SCR_HintSequenceComponent.c