CryEngine.Animations

CryEngine.Animations Namespace Reference

Classes

class ActionController
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...
class AnimationContext
Defines the context of animations. More...
class AnimationContextAction
Defines an action of an animation context. More...
class AnimationDatabase
Manages an animation database file and returns requested information from the database. More...
class AnimationDatabaseManager
Manages animation databases and controller definitions. More...
class AnimationTag
Contains data of an animation tag. More...
class Character
Interface to character animation. This interface contains methods for manipulating and querying an animated character instance. More...
class CharacterAttachment
An attachment on a character. Wraps the native IAttachment class. More...
class ControllerDefinition
Handles scope contexts and fragments for animations. More...
class Mannequin
Handles advanced character animations in the CRYENGINE. More...

Enumerations

enum ResumeFlags { ResumeFlags.RestartAnimations = 1, ResumeFlags.RestoreLoopingAnimationTime = 2, ResumeFlags.RestoreNonLoopingAnimationTime = 4, ResumeFlags.Default = RestartAnimations | RestoreLoopingAnimationTime | RestoreNonLoopingAnimationTime }
Flags for definining the behaviour when Resume is being called on an ActionController. More...
enum ActionControllerFlags {
ActionControllerFlags.PausedUpdate = EActionControllerFlags.AC_PausedUpdate, ActionControllerFlags.DebugDraw = EActionControllerFlags.AC_DebugDraw, ActionControllerFlags.DumpState = EActionControllerFlags.AC_DumpState, ActionControllerFlags.IsInUpdate = EActionControllerFlags.AC_IsInUpdate,
ActionControllerFlags.NoTransitions = EActionControllerFlags.AC_NoTransitions
}
Flags to set various options on the ActionController. More...
enum MotionParameterId {
MotionParameterId.TravelSpeed, MotionParameterId.TurnSpeed, MotionParameterId.TravelAngle, MotionParameterId.TravelSlope,
MotionParameterId.TurnAngle, MotionParameterId.TravelDist, MotionParameterId.StopLeg, MotionParameterId.BlendWeight1,
MotionParameterId.BlendWeight2, MotionParameterId.BlendWeight3, MotionParameterId.BlendWeight4, MotionParameterId.BlendWeight5,
MotionParameterId.BlendWeight6, MotionParameterId.BlendWeight7
}
ID-enum for motion parameters. More...
enum TagState { TagState.Empty, TagState.Full }
Tag states used to create animation contexts. More...

Enumeration Type Documentation

◆ ActionControllerFlags

Flags to set various options on the ActionController.

Enumerator
PausedUpdate

Flag indicating that the ActionController is paused.

DebugDraw

Flag indicating that the ActionController should draw debud information.

DumpState

Flag indicating that the ActionController will dump it's state on update. Disables itself after dumping the state.

IsInUpdate

Flag indicating that the ActionController is currently being updated.

NoTransitions

Flag indicating to not blend transitions in blend queries.

◆ MotionParameterId

ID-enum for motion parameters.

Enumerator
TravelSpeed

The speed at which the animated-entity is traveling.

TurnSpeed

The speed at which the animated-entity is turning.

TravelAngle

The angle of the traveling-direction of the animated-entity. Used to calculate forward, backwards or sidestepping movement.

TravelSlope

The vertical angle of the direction the animated-entity is traveling in.

TurnAngle

Rotation angle for Idle2Move and Idle animations.

TravelDist

Idle-steps.

StopLeg

Move2Idle.

BlendWeight1

Custom blend weight 1

BlendWeight2

Custom blend weight 2

BlendWeight3

Custom blend weight 3

BlendWeight4

Custom blend weight 4

BlendWeight5

Custom blend weight 5

BlendWeight6

Custom blend weight 6

BlendWeight7

Custom blend weight 7

◆ ResumeFlags

Flags for definining the behaviour when Resume is being called on an ActionController.

Enumerator
RestartAnimations

Restart the animations when resuming.

RestoreLoopingAnimationTime

Preserves the progress for looping animations when restarting.

RestoreNonLoopingAnimationTime

Preserves the progress for non-looping animations when restarting.

Default

Restarts the animations and preserves the progress for all animations.

◆ TagState

Tag states used to create animation contexts.

Enumerator
Empty

Indicates the tag state is empty.

Full

Indicates the tag state is full.