Skip to main content

HumanoidAnimatorUtils

Utility functions involving Animator underneath a humanoid. These are used because the Animator is the preferred API surface by Roblox.

Functions​

getOrCreateAnimator​

</>
HumanoidAnimatorUtils.getOrCreateAnimator(humanoid: Humanoid) → Animator

Gets a humanoid animator for a given humanoid

warning

There is undefined behavior when using this on the client when the server does not already have an animator. Doing so may break replication. I'm not sure.

findAnimator​

</>
HumanoidAnimatorUtils.findAnimator(target: Instance) → ()

Finds an animator in an instance

stopAnimations​

</>
HumanoidAnimatorUtils.stopAnimations(
humanoid: Humanoid,
fadeTime: number?--

Optional fade time to stop animations. Defaults to 0.1.

) → ()

Stops all animations from playing.

isPlayingAnimationTrack​

</>
HumanoidAnimatorUtils.isPlayingAnimationTrack(
humanoid: Humanoid,
) → boolean

Returns whether a track is being played.

Show raw api
{
    "functions": [
        {
            "name": "getOrCreateAnimator",
            "desc": "Gets a humanoid animator for a given humanoid\n\n:::warning\nThere is undefined behavior when using this on the client when the server\ndoes not already have an animator. Doing so may break replication. I'm not sure.\n:::",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animator"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/humanoidanimatorutils/src/Shared/HumanoidAnimatorUtils.lua"
            }
        },
        {
            "name": "findAnimator",
            "desc": "Finds an animator in an instance",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/humanoidanimatorutils/src/Shared/HumanoidAnimatorUtils.lua"
            }
        },
        {
            "name": "stopAnimations",
            "desc": "Stops all animations from playing.",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "fadeTime",
                    "desc": "Optional fade time to stop animations. Defaults to 0.1.",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 53,
                "path": "src/humanoidanimatorutils/src/Shared/HumanoidAnimatorUtils.lua"
            }
        },
        {
            "name": "isPlayingAnimationTrack",
            "desc": "Returns whether a track is being played.",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "track",
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/humanoidanimatorutils/src/Shared/HumanoidAnimatorUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HumanoidAnimatorUtils",
    "desc": "Utility functions involving [Animator] underneath a humanoid. These are used\nbecause the [Animator] is the preferred API surface by Roblox.",
    "source": {
        "line": 7,
        "path": "src/humanoidanimatorutils/src/Shared/HumanoidAnimatorUtils.lua"
    }
}