DarkBASIC Professional Help File

DX11 STOP OBJECT ANIMATION

Stops the animation associated with the given object from playing. Will have no effect if the animation is not playing or if there is no such animation.
The animation can be restarted from where it was stopped by using the DX11 RESUME OBJECT ANIMATION function.

Syntax

    DX11 STOP OBJECT ANIMATION obj, [limb], [ignoreChildren]

Parameters

    obj

> Dword
> The object to stop the currently set animation of.

    [Optional] limb

> Dword
> Set to the limb (joint / bone) to stop the set animation for. Defaults to the root node if omitted / set to null.

    [Optional] ignoreChildren

> Boolean
> If set, only the specified limb will have its animation stopped. Defaults to false in which case the specified limb and all its child limbs will have their animations stopped.

Returns

This function does not return a value.

See also

ANIMATION Functions Menu
DX11 Function Categories