CryEngine.Animations.Character

Public Member Functions | Properties | List of all members

Interface to character animation. This interface contains methods for manipulating and querying an animated character instance. More...

Public Member Functions
void	SetAnimationSkeletonParameter (MotionParameterId id, float value)
	Set the MotionParameterId to the specified value . More...

CharacterAttachment	GetAttachment (string name)
	Get the CharacterAttachment with the specified name More...

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

Properties
float	PlaybackScale `[get, set]`
	The scale at which animation play on this Character . More...

bool	HasVertexAnimation `[get]`
	Gets a value indicating whether this T:CryEngine.Animations.Character has vertex animation. More...

string	FilePath `[get]`
	Get the filename of the character. This is either the model path or the CDF path. More...

ISkeletonAnim	AnimationSkeleton `[get]`
	Get the animation-skeleton for this instance. Returns the instance of an ISkeletonAnim derived class applicable for the model. More...

ISkeletonPose	PoseSkeleton `[get]`
	Get the pose-skeleton for this instance. Returns the instance of an ISkeletonPose derived class applicable for the model. More...

IFacialInstance	CharacterFace `[get]`
	Get the Facial interface of this Character. More...

Detailed Description

Interface to character animation. This interface contains methods for manipulating and querying an animated character instance.

Member Function Documentation

◆ GetAttachment()

CharacterAttachment CryEngine.Animations.Character.GetAttachment

(

string

name

)

inline

Get the CharacterAttachment with the specified name

Returns: The CharacterAttachment or null if no attachment was found.

Parameters

name	Name of the required attachment.

◆ Release()

void CryEngine.Animations.Character.Release

(

)

inline

Release this instance from both the managed and unmanaged side.

◆ SetAnimationSkeletonParameter()

void CryEngine.Animations.Character.SetAnimationSkeletonParameter	(	MotionParameterId	id,
		float	value
	)

inline

Set the MotionParameterId to the specified value .

Parameters

id	The MotionParameterId that needs to be set.
value	The value that will be set to the parameter.

Property Documentation

◆ AnimationSkeleton

ISkeletonAnim CryEngine.Animations.Character.AnimationSkeleton

get

Get the animation-skeleton for this instance. Returns the instance of an ISkeletonAnim derived class applicable for the model.

The animation skeleton.

◆ CharacterFace

IFacialInstance CryEngine.Animations.Character.CharacterFace

get

Get the Facial interface of this Character.

The character face.

◆ FilePath

string CryEngine.Animations.Character.FilePath

get

Get the filename of the character. This is either the model path or the CDF path.

The file path.

◆ HasVertexAnimation

bool CryEngine.Animations.Character.HasVertexAnimation

get

Gets a value indicating whether this T:CryEngine.Animations.Character has vertex animation.

true if has vertex animation; otherwise, false.

◆ PlaybackScale

float CryEngine.Animations.Character.PlaybackScale

get

set

The scale at which animation play on this Character .

The playback scale.

◆ PoseSkeleton

ISkeletonPose CryEngine.Animations.Character.PoseSkeleton

get

Get the pose-skeleton for this instance. Returns the instance of an ISkeletonPose derived class applicable for the model.

The pose skeleton.