Kinemium Docs

Animator

Manages animation playback, blending, and control for animated objects.

Properties

PropertyTypeDefault
Namestring"Animator"
Clocknumber0
SpeedScalenumber1
UseDefaultAnimationsbooleantrue
PoseProvideranynil
DefaultProvideranynil

Functions


copy

Copies.

Arguments

tbl: table

Returns

This function returns nothing.

mergePose

Merges pose.

Arguments

basePose: any, layerPose: any

Returns

This function returns nothing.

instance:SetPoseProvider

Sets the Pose Provider.

Arguments

provider: number

Returns

This function returns nothing.

instance:AddPoseLayer

Adds a pose layer.

Arguments

name: string, layer: number

Returns

This function returns nothing.

instance:RemovePoseLayer

Removes a pose layer.

Arguments

name: string

Returns

This function returns nothing.

instance:SetDefaultProvider

Sets the Default Provider.

Arguments

provider: number

Returns

This function returns nothing.

instance:ResetClock

Resets clock.

Arguments

value: number

Returns

This function returns nothing.

instance:Advance

Advances.

Arguments

dt: number

Returns

This function returns nothing.

instance:SetStateValue

Sets the State Value.

Arguments

key: number, value: number

Returns

This function returns nothing.

instance:GetStateValue

Gets the Stat eValue.

Arguments

key: number

Returns

This function returns nothing.

instance:GetPose

Gets the Pose.

Arguments

target: table, context: table

Returns

This function returns nothing.

instance:StepAnimation

Steps animation.

Arguments

target: table, context: table

Returns

This function returns nothing.

API

instance:copy(tbl: table)
instance:mergePose(basePose: any, layerPose: any)
instance:SetPoseProvider(provider: number)
instance:AddPoseLayer(name: string, layer: number)
instance:RemovePoseLayer(name: string)
instance:SetDefaultProvider(provider: number)
instance:ResetClock(value: number)
instance:Advance(dt: number)
instance:SetStateValue(key: number, value: number)
instance:GetStateValue(key: number)
instance:GetPose(target: table, context: table)
instance:StepAnimation(target: table, context: table)

On this page