CryEngine.Animations.AnimationContext

Public Member Functions | Static Public Member Functions | List of all members

Defines the context of animations. More...

Public Member Functions
void	SetTagValue (AnimationTag tag, bool value)
	Set the value of the specified AnimationTag. More...

void	SetTagValue (int id, bool value)
	Set the value of the specified id. More...

AnimationTag	FindAnimationTag (string tagName)
	Find the AnimationTag with the specified name. More...

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

Static Public Member Functions
static AnimationContext	Create (ControllerDefinition definition)
	Create a new AnimationContext based on the specified ControllerDefinition. More...

Detailed Description

Defines the context of animations.

Member Function Documentation

◆ Create()

static AnimationContext CryEngine.Animations.AnimationContext.Create

(

ControllerDefinition

definition

)

inline

static

Create a new AnimationContext based on the specified ControllerDefinition.

Returns: The newly created AnimationContext.

Parameters

definition

The ControllerDefinition this AnimationContext will belong to.

◆ FindAnimationTag()

AnimationTag CryEngine.Animations.AnimationContext.FindAnimationTag

(

string

tagName

)

inline

Find the AnimationTag with the specified name.

Returns: The AnimationTag that was found, or null if none was found.

Parameters

tagName

Name of the tag.

◆ Release()

void CryEngine.Animations.AnimationContext.Release

(

)

inline

Release this AnimationContext from the managed and unmanaged side.

◆ SetTagValue() [1/2]

void CryEngine.Animations.AnimationContext.SetTagValue	(	AnimationTag	tag,
		bool	value
	)

inline

Set the value of the specified AnimationTag.

Parameters

tag	The tag to identify which value to set.
value	The value that needs to be set.

◆ SetTagValue() [2/2]

void CryEngine.Animations.AnimationContext.SetTagValue	(	int	id,
		bool	value
	)

inline

Set the value of the specified id.

Parameters

id	The ID of the value which will be set.
value	The value that needs to be set.