CryEngine.Animations.ActionController

Public Member Functions | Properties | List of all members

The root object controlling mannequin for a character. It is configured using a controller definition (defining the fragmentIDs, scopes, scope contexts, etc). It schedules actions onto scopes and holds the global tagstate. More...

Public Member Functions
void	Reset ()
	Completely resets the state of the ActionController. More...

void	Flush ()
	Flushes all currently playing and queued actions. More...

void	SetScopeContext (uint scopeContextId, Entity entity, Character character, AnimationDatabase animationDatabase)
	Set the context of a scope of the ActionController. More...

void	ClearScopeContext (uint scopeContextId, bool flushAnimations=true)
	Clears the context of a scope. More...

bool	IsScopeActive (uint scopeId)
	Check if a scope is currently active or not. More...

uint	GetScopeId (string scopeName)
	Returns the ID of the scope with the value of scopeName as its name. More...

int	GetFragmentId (uint crc)
	Returns the ID of the fragment that corresponds to crc . More...

int	GetGlobalTagId (uint crc)
	Returns the global tag ID that corresponds to crc . More...

int	GetFragmentTagId (int fragmentId, uint crc)
	Returns the ID of the fragment tag that corresponds to fragmentId and crc . More...

void	Queue (AnimationContextAction action)
	Queue the specified action . More...

void	Requeue (AnimationContextAction action)
	Requeue the specified action .. More...

void	SetSlaveController (ActionController target, uint targetContext, bool enslave, AnimationDatabase targetDatabase=null)
	Set the slave ActionController of this ActionController. More...

void	Update (float frameTime)
	Update the ActionController with the specified frameTime. More...

void	Pause ()
	Pause the ActionController. More...

void	Resume (ResumeFlags resumeFlags=ResumeFlags.Default)
	Resume the ActionController. More...

void	SetFlag (ActionControllerFlags flag, bool enable)
	Used to set various options on the ActionController. More...

void	Release ()
	Release this ActionController from the managed and unmanaged side. More...

Properties
int	ScopesCount `[get]`
	The amount of scopes in this ActionController. More...

Entity	Entity `[get]`
	The CryEngine.Entity that this ActionController belongs to. More...

EntitySystem.EntityId	EntityId `[get]`
	The ID of the CryEngine.Entity that this ActionController belongs to. More...

float	TimeScale `[get, set]`
	The timescale of the ActionController. More...

AnimationContext	Context `[get]`
	The AnimationContext of the ActionController. More...

Detailed Description

Member Function Documentation

◆ ClearScopeContext()

void CryEngine.Animations.ActionController.ClearScopeContext	(	uint	scopeContextId,
		bool	flushAnimations = `true`
	)

inline

Clears the context of a scope.

Parameters

scopeContextId	ID of a scope.
flushAnimations	If set to `true` flush animations.

◆ Flush()

void CryEngine.Animations.ActionController.Flush

(

)

inline

Flushes all currently playing and queued actions.

◆ GetFragmentId()

int CryEngine.Animations.ActionController.GetFragmentId

(

uint

crc

)

inline

Returns the ID of the fragment that corresponds to crc .

Returns: The ID of the fragment.

Parameters

crc

Crc.

◆ GetFragmentTagId()

int CryEngine.Animations.ActionController.GetFragmentTagId	(	int	fragmentId,
		uint	crc
	)

inline

Returns the ID of the fragment tag that corresponds to fragmentId and crc .

Returns: The fragment tag identifier.

Parameters

fragmentId	Fragment identifier.
crc	Crc.

◆ GetGlobalTagId()

int CryEngine.Animations.ActionController.GetGlobalTagId

(

uint

crc

)

inline

Returns the global tag ID that corresponds to crc .

Returns: The ID of the global tag.

Parameters

crc

Crc.

◆ GetScopeId()

uint CryEngine.Animations.ActionController.GetScopeId

(

string

scopeName

)

inline

Returns the ID of the scope with the value of scopeName as its name.

Returns: The ID of the scope.

Parameters

scopeName

Scope name.

◆ IsScopeActive()

bool CryEngine.Animations.ActionController.IsScopeActive

(

uint

scopeId

)

inline

Check if a scope is currently active or not.

Returns: true, if scope the scope is active, false otherwise.

Parameters

scopeId

Scope ID.

◆ Pause()

void CryEngine.Animations.ActionController.Pause

(

)

inline

Pause the ActionController.

◆ Queue()

void CryEngine.Animations.ActionController.Queue

(

AnimationContextAction

action

)

inline

Queue the specified action .

Parameters

action

Action list.

◆ Release()

void CryEngine.Animations.ActionController.Release

(

)

inline

Release this ActionController from the managed and unmanaged side.

◆ Requeue()

void CryEngine.Animations.ActionController.Requeue

(

AnimationContextAction

action

)

inline

Requeue the specified action ..

Parameters

action

Action list.

◆ Reset()

void CryEngine.Animations.ActionController.Reset

(

)

inline

Completely resets the state of the ActionController.

◆ Resume()

void CryEngine.Animations.ActionController.Resume ( ResumeFlags resumeFlags = ResumeFlags.Default )

inline

Resume the ActionController.

Parameters

resumeFlags

Flags to define the resume behaviour.

◆ SetFlag()

void CryEngine.Animations.ActionController.SetFlag	(	ActionControllerFlags	flag,
		bool	enable
	)

inline

Used to set various options on the ActionController.

Parameters

flag	The option that needs to be set. Multiple flags can be combined.
enable	If set to `true` enables the flag, otherwise the flag is disabled.

◆ SetScopeContext()

void CryEngine.Animations.ActionController.SetScopeContext	(	uint	scopeContextId,
		Entity	entity,
		Character	character,
		AnimationDatabase	animationDatabase
	)

inline

Set the context of a scope of the ActionController.

Parameters

scopeContextId	Scope context identifier.
entity	Target Entity.
character	Target Character.
animationDatabase	Animation database.

◆ SetSlaveController()

void CryEngine.Animations.ActionController.SetSlaveController	(	ActionController	target,
		uint	targetContext,
		bool	enslave,
		AnimationDatabase	targetDatabase = `null`
	)

inline

Set the slave ActionController of this ActionController.

Parameters

target	Target slave controller.
targetContext	Target context.
enslave	If set to `true` enslave.
targetDatabase	Target database.

◆ Update()

void CryEngine.Animations.ActionController.Update

(

float

frameTime

)

inline

Update the ActionController with the specified frameTime.

Parameters

frameTime

Frame time.

Property Documentation

◆ Context

AnimationContext CryEngine.Animations.ActionController.Context

get

The AnimationContext of the ActionController.

The AnimationContext.

◆ Entity

Entity CryEngine.Animations.ActionController.Entity

get

The CryEngine.Entity that this ActionController belongs to.

The entity.

◆ EntityId

EntitySystem.EntityId CryEngine.Animations.ActionController.EntityId

get

The ID of the CryEngine.Entity that this ActionController belongs to.

The ID of the entity identifier.

◆ ScopesCount

int CryEngine.Animations.ActionController.ScopesCount

get

The amount of scopes in this ActionController.

The scopes count.

◆ TimeScale

float CryEngine.Animations.ActionController.TimeScale

get

set

The timescale of the ActionController.

The time scale.