A controller is a re-usable Asset that allow you to create complex machine states to smoothly animate a Skeleton. They can either be controlled by AI (or by custom user logic); or directly by a game pad etc...

To make a Controller usable you first need to declare variables; theses variables will in turn drive the different Action states you wish to implement. Once created the next step would be to create a ActionLayer.

An ActionLayer is where all ActionClip are placed; each clip is created using a specific type (which will dictate how they handle the action(s) connected to them) that can connected to one or more Variable managed by the Controller / ActionController.

By updating the value of theses variables the machine state of will be updated and actions will start to interpolate, blend and/or mix existing action wich in turn will drive a Skeleton connected to a SkeletalMesh.

Static Variables

Name	Description
`asset`	Parent Asset the active Controller is connected to.
Declaration Asset *asset
`variable_count`	Amount of Variable declared within the current Controller scope.
Declaration unsigned char variable_count
`skeleton`	The Skeleton associated to the current Controller.
Declaration Skeleton *skeleton
`actionlayer_count`	Amount of ActionLayer associated with the active Controller.
Declaration unsigned char actionlayer_count

Variables

Name Description

flags Bit mask to enable or disable Controller settings.

Declaration

int flags

Cap	Value	Description
`CTL_FLAG_LOCK_VARIABLES`	`bit.lshift(1,0)`	Prevent the Controller variables to be modified within the Controller Editor.

Functions

Name	Description
`SetSkeleton`	Set the Skeleton that the active Controller will control.
Declaration void SetSkeleton( Skeleton skeleton ) Parameters* `skeleton`: An existing Skeleton asset; pass `nil` to disconnect.
`AddVariable`	Create a new Variable and attach it to the active Controller.
Declaration Variable AddVariable( const char name, const VariableType type ) Parameters `name`: Name to identify the Variable within the Controller. `type`: The VariableType for the new Variable. Return Value A new Variable reference; `nil` if the VariableType is invalid (see below for more info.) or above the maximum count limit. Warning The only valid VariableType that are accepted when creating a new Variable for a Controller are `kBool`, `kInt` and `kFloat`.
`GetVariable`	Return an existing Variable reference.
Declaration Variable GetVariable( const char name ) Parameters `name`: The name of the Variable to retrieve. Return Value A reference to the Variable that match the `name` received in parameter; else return `nil`.
`GetVariableIndex`	Retrieve an existing Variable using its index as key.
Declaration int GetVariableIndex( const Variable variable ) Parameters* `variable`: An existing Variable reference pointer. Return Value The Variable index within the internal Controller Variable list; else return `-1`.
`GetVariableAt`	Retrieve an existing Variable using an index as key.
Declaration Variable GetVariableAt( unsigned char index ) Parameters* `index`: The index of the Variable to retrieve. Return Value A reference to the Variable located at the `index` position; else return `nil`.
`RemoveVariable`	Remove a specific Controller Variable.
Declaration bool RemoveVariable( Variable variable ) Parameters* `variable`: An existing Variable reference pointer. Return Value `true` if the Variable have been removed; else return `false` if the `variable` parameter does not match any Variable associated to the Controller.
`RemoveVariableAt`	Remove an existing Variable using an index as key.
Declaration bool RemoveVariableAt( int index ) Parameters `index`: The index of the Variable to remove. Return Value `true` if the Variable have been removed; else return `false` if the index is out of bounds.
`AddActionLayer`	Add a new ActionLayer to the active Controller.
Declaration ActionLayer AddActionLayer( const char name ) Parameters `name`: A unique name to identify the new ActionLayer within the Controller. Return Value A new ActionLayer reference.
`GetActionLayer`	Retrieve an existing ActionLayer using its name as key.
Declaration ActionLayer GetActionLayer( const char name ) Parameters `name`: The name of the ActionLayer to retrieve. Return Value `nil` if the `name` does not match any existing ActionLayer connected to the Controller; else return the ActionLayer reference.
`GetActionLayerAt`	Get an existing ActionLayer at a specific index.
Declaration ActionLayer GetActionLayerAt( unsigned char index ) Parameters* `index`: Index of the ActionLayer to retrieve. Return Value The ActionLayer reference located at the `index` received in parameter; else return `nil` if the `index` is nonexistent.
`GetActionLayerIndex`	Get the internal index of an existing ActionLayer connected to a Controller.
Declaration int GetActionLayerIndex( const ActionLayer actionlayer ) Parameters* `actionlayer`: An existing ActionLayer reference. Return Value The index of the `actionlayer` reference; else return `-1` if the `actionlayer` does not exist.
`SetActionLayerIndex`	Change the position in the stack of a specific ActionLayer.
Declaration bool SetActionLayerIndex( ActionLayer actionlayer, const unsigned char index ) Parameters* `actionlayer`: An existing ActionLayer reference. `index`: The new position of the `actionlayer`. Return Value `true` if the operation is successful; else `false` if the `actionlayer` or the `index` specified is invalid.
`SwapActionLayers`	Exchange the position of two existing ActionLayer.
Declaration bool SwapActionLayers( unsigned char index0, unsigned char index1 ) Parameters `index0`: From index. `index1`: To index. Return Value `true` if the operation is successful; else `false` if one or both indexes are invalid.
`RemoveActionLayer`	Remove a ActionLayer using its reference as key.
Declaration bool RemoveActionLayer( ActionLayer actionlayer ) Parameters* `actionlayer`: An existing ActionLayer reference. Return Value `true` if the operation is successful; else `false` if the `actionlayer` does not exist.
`RemoveActionLayerAt`	Remove an ActionLayer using its index as key.
Declaration bool RemoveActionLayerAt( int index ) Parameters `index`: Index of the ActionLayer to remove. Return Value `true` if removed successfully; else `false` the index is out of bounds.