SCR_CharacterAnimationEventCinematicTrack Interface Reference

Inheritance diagram for SCR_CharacterAnimationEventCinematicTrack:

Public Member Functions
IEntity	GetSourceEntity ()
override void	OnApply (float time)
override void	OnFinish ()
Public Member Functions inherited from SCR_CinematicTrackBase
override void	OnInit (World world)
IEntity	FindOwner ()
IEntity	FindOwner (string ownerName)

Public Attributes
bool	m_bIsFirstFrame = true

Static Public Attributes
static const string	EVENT_NAME_SIGNAL = "SignalCinematicTimeline"
static const string	EVENT_NAME_SOUND = "SoundCinematicTimeline"

Protected Member Functions
void	OnAnimationEvent (AnimationEventID animEventType, AnimationEventID animUserString, int intParam, float timeFromStart, float timeToEnd)
	Callback called when animation event happens.

Protected Attributes
string	m_sSourceEntityName
bool	m_bUsePlayerCharacter
string	m_sTargerEntityName
Protected Attributes inherited from SCR_CinematicTrackBase
World	m_World

Member Function Documentation

GetSourceEntity()

IEntity SCR_CharacterAnimationEventCinematicTrack.GetSourceEntity

(

)

OnAnimationEvent()

void SCR_CharacterAnimationEventCinematicTrack.OnAnimationEvent ( AnimationEventID animEventType, AnimationEventID animUserString, int intParam, float timeFromStart, float timeToEnd )

protected

Callback called when animation event happens.

Parameters

[in]	animEventType	ID of animation event.
[in]	animUserString	String parameter of animation event
[in]	intParam	int parameter of animation event
[in]	timeFromStart	time from Start of animation event
[in]	timeToEnd	time to end of animation event

OnApply()

override void SCR_CharacterAnimationEventCinematicTrack.OnApply

(

float

time

)

OnFinish()

override void SCR_CharacterAnimationEventCinematicTrack.OnFinish

(

)

Member Data Documentation

EVENT_NAME_SIGNAL

const string SCR_CharacterAnimationEventCinematicTrack.EVENT_NAME_SIGNAL = "SignalCinematicTimeline"

static

EVENT_NAME_SOUND

const string SCR_CharacterAnimationEventCinematicTrack.EVENT_NAME_SOUND = "SoundCinematicTimeline"

static

m_bIsFirstFrame

bool SCR_CharacterAnimationEventCinematicTrack.m_bIsFirstFrame = true

m_bUsePlayerCharacter

bool SCR_CharacterAnimationEventCinematicTrack.m_bUsePlayerCharacter

protected

m_sSourceEntityName

string SCR_CharacterAnimationEventCinematicTrack.m_sSourceEntityName

protected

m_sTargerEntityName

string SCR_CharacterAnimationEventCinematicTrack.m_sTargerEntityName

protected

---

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

• Game/Cinematics/SCR_CharacterAnimationEventCinematicTrack.c