SCR_VoiceoverSystem Interface Reference

Inheritance diagram for SCR_VoiceoverSystem:

Public Member Functions
override bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?
ScriptInvokerVoid	GetOnFinished ()
	Triggered when a line or sequence finishes playing.
void	SetData (ResourceName config)
	Loads voiceover data from the given SCR_VoiceoverData config resource Must be called before PlaySequence or PlayLine which both use data from this config!
bool	IsPlaying ()
void	PlaySequence (string sequenceName, IEntity actor1=null, IEntity actor2=null, IEntity actor3=null, IEntity actor4=null, IEntity actor5=null)
	Plays a sequence of voiceover lines defined in loaded config (see SetData)
void	PlayLine (string lineName, IEntity actor1=null, IEntity actor2=null, IEntity actor3=null, IEntity actor4=null, IEntity actor5=null)
	Plays a voiceover line defined in loaded config (see SetData)
void	PlayCustomLine (string soundEventName, string subtitle, IEntity actor=null)
	Plays a custom voiceover line.
void	Stop ()
Public Member Functions inherited from GameSystem
bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?
bool	ShouldBeEnabledInEditMode ()
	Is this system should be enabled inside the editor.

Static Public Member Functions
static SCR_VoiceoverSystem	GetInstance ()

Protected Member Functions
override void	OnUpdate (ESystemPoint point)
void	PlayFromQueue ()
void	PlayLine (string eventName, string subtitle, IEntity actor=null)
void	ShowSubtitle (string subtitle)
IEntity	GetDefaultActor ()
void	OnFinished ()

Protected Attributes
ref ScriptInvokerVoid	m_OnFinished
ref SCR_VoiceoverData	m_Data
ref SCR_VoiceoverSubtitles	m_SubtitlesDisplay
ref array< ref SCR_VoiceoverLine >	m_aQueue = {}
ref array< IEntity >	m_aActors = {}
SCR_CommunicationSoundComponent	m_PlayingSoundComponent
AudioHandle	m_iAudioHandle
float	m_fTimer

Static Protected Attributes
static const float	PAUSE_BETWEEN_LINES = 0.5

Member Function Documentation

GetDefaultActor()

IEntity SCR_VoiceoverSystem.GetDefaultActor ( )

protected

GetInstance()

static SCR_VoiceoverSystem SCR_VoiceoverSystem.GetInstance ( )

static

GetOnFinished()

ScriptInvokerVoid SCR_VoiceoverSystem.GetOnFinished

(

)

Triggered when a line or sequence finishes playing.

IsPlaying()

bool SCR_VoiceoverSystem.IsPlaying

(

)

OnFinished()

void SCR_VoiceoverSystem.OnFinished ( )

protected

OnUpdate()

override void SCR_VoiceoverSystem.OnUpdate ( ESystemPoint  point )

protected

PlayCustomLine()

void SCR_VoiceoverSystem.PlayCustomLine	(	string	soundEventName,
		string	subtitle,
		IEntity	actor = null
	)

Plays a custom voiceover line.

PlayFromQueue()

void SCR_VoiceoverSystem.PlayFromQueue ( )

protected

PlayLine() [1/2]

void SCR_VoiceoverSystem.PlayLine ( string  eventName, string  subtitle, IEntity  actor = null  )

protected

PlayLine() [2/2]

void SCR_VoiceoverSystem.PlayLine	(	string	lineName,
		IEntity	actor1 = null,
		IEntity	actor2 = null,
		IEntity	actor3 = null,
		IEntity	actor4 = null,
		IEntity	actor5 = null
	)

Plays a voiceover line defined in loaded config (see SetData)

PlaySequence()

void SCR_VoiceoverSystem.PlaySequence	(	string	sequenceName,
		IEntity	actor1 = null,
		IEntity	actor2 = null,
		IEntity	actor3 = null,
		IEntity	actor4 = null,
		IEntity	actor5 = null
	)

Plays a sequence of voiceover lines defined in loaded config (see SetData)

SetData()

void SCR_VoiceoverSystem.SetData

(

ResourceName

config

)

Loads voiceover data from the given SCR_VoiceoverData config resource Must be called before PlaySequence or PlayLine which both use data from this config!

ShouldBePaused()

override bool SCR_VoiceoverSystem.ShouldBePaused

(

)

Is this system should be paused while the simulation is paused?

Implements GameSystem.

ShowSubtitle()

void SCR_VoiceoverSystem.ShowSubtitle ( string  subtitle )

protected

Stop()

void SCR_VoiceoverSystem.Stop

(

)

Member Data Documentation

m_aActors

ref array<IEntity> SCR_VoiceoverSystem.m_aActors = {}

protected

m_aQueue

ref array<ref SCR_VoiceoverLine> SCR_VoiceoverSystem.m_aQueue = {}

protected

m_Data

ref SCR_VoiceoverData SCR_VoiceoverSystem.m_Data

protected

m_fTimer

float SCR_VoiceoverSystem.m_fTimer

protected

m_iAudioHandle

AudioHandle SCR_VoiceoverSystem.m_iAudioHandle

protected

m_OnFinished

ref ScriptInvokerVoid SCR_VoiceoverSystem.m_OnFinished

protected

m_PlayingSoundComponent

SCR_CommunicationSoundComponent SCR_VoiceoverSystem.m_PlayingSoundComponent

protected

m_SubtitlesDisplay

ref SCR_VoiceoverSubtitles SCR_VoiceoverSystem.m_SubtitlesDisplay

protected

PAUSE_BETWEEN_LINES

const float SCR_VoiceoverSystem.PAUSE_BETWEEN_LINES = 0.5

staticprotected

---

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

• Game/Systems/SCR_VoiceoverSystem.c