Skip to main content

AnimationSlotPlayer

Acts as a priority slot which can be overridden and play any animation in. See Roblox's animation system for more information.

Functions​

new​

</>
AnimationSlotPlayer.new(animationTarget: Instance? | Observable<Instance>) → AnimationSlotPlayer

Creates a new AnimationSlotPlayer with a target to play the animation on.

SetDefaultFadeTime​

</>
AnimationSlotPlayer:SetDefaultFadeTime(defaultFadeTime: number) → ()

Sets a new default fade time

SetDefaultAnimationPriority​

</>
AnimationSlotPlayer:SetDefaultAnimationPriority(defaultAnimationPriority: number) → ()

Sets a new default animation priority

SetAnimationTarget​

</>
AnimationSlotPlayer:SetAnimationTarget(animationTarget: Instance | Observable<Instance>) → ()

Sets an animation target to play the animation on

AdjustSpeed​

</>
AnimationSlotPlayer:AdjustSpeed(
id: string | number,
speed: number
) → () → ()--

Callback to clean things up

Adjusts the speed of the animation playing in the slot

AdjustWeight​

</>
AnimationSlotPlayer:AdjustWeight(
id: string | number,
weight: number,
fadeTime: number
) → () → ()--

Callback to clean things up

Adjusts the weight of the animation playing in the slot

Play​

</>
AnimationSlotPlayer:Play(
id: string | number,
fadeTime: number?,
weight: number?,
speed: number?,
priority: number?
) → () → ()--

Callback to clean things up

Plays the animation in the slot, overriding any previous animation

Stop​

</>
AnimationSlotPlayer:Stop() → ()

Stops the current animation playing

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new AnimationSlotPlayer with a target to play the animation on.",
            "params": [
                {
                    "name": "animationTarget",
                    "desc": "",
                    "lua_type": "Instance? | Observable<Instance>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationSlotPlayer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "SetDefaultFadeTime",
            "desc": "Sets a new default fade time",
            "params": [
                {
                    "name": "defaultFadeTime",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 48,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "SetDefaultAnimationPriority",
            "desc": "Sets a new default animation priority",
            "params": [
                {
                    "name": "defaultAnimationPriority",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 57,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "SetAnimationTarget",
            "desc": "Sets an animation target to play the animation on",
            "params": [
                {
                    "name": "animationTarget",
                    "desc": "",
                    "lua_type": "Instance | Observable<Instance>"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 68,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "AdjustSpeed",
            "desc": "Adjusts the speed of the animation playing in the slot",
            "params": [
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Callback to clean things up",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "AdjustWeight",
            "desc": "Adjusts the weight of the animation playing in the slot",
            "params": [
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string | number"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Callback to clean things up",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 126,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "Play",
            "desc": "Plays the animation in the slot, overriding any previous animation",
            "params": [
                {
                    "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": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "Callback to clean things up",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 176,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        },
        {
            "name": "Stop",
            "desc": "Stops the current animation playing",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 232,
                "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimationSlotPlayer",
    "desc": "Acts as a priority slot which can be overridden and play any animation in.\nSee Roblox's animation system for more information.",
    "source": {
        "line": 7,
        "path": "src/animations/src/Shared/AnimationSlotPlayer.lua"
    }
}