Skip to main content

AnimationUtils

Functions​

playAnimation​

</>
AnimationUtils.playAnimation(
id: string | number,
fadeTime: number?,
weight: number?,
speed: number?,
priority: Enum.AnimationPriority?
) → AnimationTrack?

Plays the animation on the target instance.

TIP

If you play an animation at 1 priority, and then request another animation track at a different priority, it will give you 2 separate animation tracks. Otherwise it tries to reuse the same animation track.

stopAnimation​

</>
AnimationUtils.stopAnimation(
id: string | number,
fadeTime: number?
) → AnimationTrack?

Stops the animation on the target instance.

getOrCreateAnimationTrack​

</>
AnimationUtils.getOrCreateAnimationTrack(
id: string | number,
priority: Enum.AnimationPriority?
) → AnimationTrack?

Gets or creates an animation track for the player

getOrCreateAnimationFromIdInAnimator​

</>
AnimationUtils.getOrCreateAnimationFromIdInAnimator(
animator: Animator,
id: string | number,
priority: Enum.AnimationPriority?
) → Animation

Gets or creates an animation from the id in the animator

findAnimationTrack​

</>
AnimationUtils.findAnimationTrack(
id: string | number,
priority: Enum.AnimationPriority?
) → AnimationTrack?

Finds an animation track

isMatchingAnimationTrack​

</>
AnimationUtils.isMatchingAnimationTrack(
animationTrack: AnimationTrack,
id: string | number,
priority: Enum.AnimationPriority?
) → boolean

Computes whether a given animation track matches the id and priority

findAnimationTrackInAnimator​

</>
AnimationUtils.findAnimationTrackInAnimator(
animator: Animator,
id: string | number,
priority: Enum.AnimationPriority?
) → AnimationTrack?

Finds an animation track in an animator

getOrCreateAnimator​

</>
AnimationUtils.getOrCreateAnimator(target: Animator | Player | Model | Humanoid | AnimationController) → Animator?

Finds an animator for the current instance

getAnimationName​

</>
AnimationUtils.getAnimationName(animationId: string) → string

Gets a specific animation name for an animation id

createAnimationFromId​

</>
AnimationUtils.createAnimationFromId(id: string | number) → Animation

Creates a new animation object from the given id

Show raw api
{
    "functions": [
        {
            "name": "playAnimation",
            "desc": "Plays the animation on the target instance.\n\n:::tip\nIf you play an animation at 1 priority, and then request another animation track at\na different priority, it will give you 2 separate animation tracks. Otherwise it tries to reuse the\nsame animation track.\n:::",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Animator | Player | Model | AnimationController"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "stopAnimation",
            "desc": "Stops the animation on the target instance.",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Animator | Player | Model | AnimationController"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "getOrCreateAnimationTrack",
            "desc": "Gets or creates an animation track for the player",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Animator | Player | Model | AnimationController"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "getOrCreateAnimationFromIdInAnimator",
            "desc": "Gets or creates an animation from the id in the animator",
            "params": [
                {
                    "name": "animator",
                    "desc": "",
                    "lua_type": "Animator"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animation\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 127,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "findAnimationTrack",
            "desc": "Finds an animation track",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Animator | Player | Model | AnimationController"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 154,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "isMatchingAnimationTrack",
            "desc": "Computes whether a given animation track matches the id and priority",
            "params": [
                {
                    "name": "animationTrack",
                    "desc": "",
                    "lua_type": "AnimationTrack"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 174,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "findAnimationTrackInAnimator",
            "desc": "Finds an animation track in an animator",
            "params": [
                {
                    "name": "animator",
                    "desc": "",
                    "lua_type": "Animator"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "Enum.AnimationPriority?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 203,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "getOrCreateAnimator",
            "desc": "Finds an animator for the current instance",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Animator | Player | Model | Humanoid | AnimationController\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animator?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 225,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "getAnimationName",
            "desc": "Gets a specific animation name for an animation id",
            "params": [
                {
                    "name": "animationId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 268,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        },
        {
            "name": "createAnimationFromId",
            "desc": "Creates a new animation object from the given id",
            "params": [
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animation\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 275,
                "path": "src/animations/src/Shared/AnimationUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimationUtils",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/animations/src/Shared/AnimationUtils.lua"
    }
}