Skip to main content

AnimationManager

This item only works when running on the client. Client

Handles all of the games animations.

Types​

AnimationModuleType​

</>
interface AnimationModuleType {
initAnimationController: (
self: AnimationModuleType,
animationController: AnimationController | Humanoid
) → ()
isInitialised: (animationController: AnimationController | Humanoid) → boolean
getAnimation: (
animationController: AnimationController | Humanoid,
category: string,
parameter: string | Animation
) → AnimationTrack
getAnimationInstance: (
animationController: AnimationController | Humanoid,
category: string,
animName: string
) → Animation?
playAnimation: (
animationController: AnimationController | Humanoid,
category: string,
parameter: string | Animation,
fadeTime: number?,
weight: number?,
speed: number?
) → AnimationTrack
stopAnimation: (
animationController: AnimationController | Humanoid,
category: string,
parameter: string | Animation,
fadeTime: number?
) → ()
}

Defines the structure and methods available for managing animations across different controllers.

Functions​

isInitialised​

</>
AnimationManager.isInitialised(animationController: AnimationController | Humanoid) → boolean

Checks to see if a certain AnimationController is initalized.

getAnimation​

</>
AnimationManager.getAnimation(
animationController: AnimationController | Humanoid,
category: string,
parameter: string | Animation
) → AnimationTrack

Fetches an animation track from the desired category.

getAnimationInstance​

</>
AnimationManager.getAnimationInstance(
animationController: AnimationController | Humanoid,
category: string,
animName: string
) → Animation?

Finds the desired animation and returns the instance

playAnimation​

</>
AnimationManager.playAnimation(
animationController: AnimationController | Humanoid,
category: string,
parameter: string | Animation,
fadeTime: number?,
weight: number?,
speed: number?
) → AnimationTrack

Plays a desired animation.

stopAnimation​

</>
AnimationManager.stopAnimation(
animationController: AnimationController | Humanoid,
category: string,
parameter: string | Animation,
fadeTime: number?
) → ()

Stops a desired animation.

initAnimationController​

</>
AnimationManager:initAnimationController(animationController: AnimationController | Humanoid) → ()

Initalizes the desired animation controller and adds it tot he registry.

Show raw api
{
    "functions": [
        {
            "name": "initAnimationController",
            "desc": "Initalizes the desired animation controller and adds it tot he registry.",
            "params": [
                {
                    "name": "animationController",
                    "desc": "",
                    "lua_type": "AnimationController | Humanoid"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 107,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        },
        {
            "name": "isInitialised",
            "desc": "Checks to see if a certain AnimationController is initalized.",
            "params": [
                {
                    "name": "animationController",
                    "desc": "",
                    "lua_type": "AnimationController | Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 133,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        },
        {
            "name": "getAnimation",
            "desc": "Fetches an animation track from the desired category.",
            "params": [
                {
                    "name": "animationController",
                    "desc": "",
                    "lua_type": "AnimationController | Humanoid"
                },
                {
                    "name": "category",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "parameter",
                    "desc": "",
                    "lua_type": "string | Animation"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        },
        {
            "name": "getAnimationInstance",
            "desc": "Finds the desired animation and returns the instance",
            "params": [
                {
                    "name": "animationController",
                    "desc": "",
                    "lua_type": "AnimationController | Humanoid"
                },
                {
                    "name": "category",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "animName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animation?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 184,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        },
        {
            "name": "playAnimation",
            "desc": "Plays a desired animation.",
            "params": [
                {
                    "name": "animationController",
                    "desc": "",
                    "lua_type": "AnimationController | Humanoid"
                },
                {
                    "name": "category",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "parameter",
                    "desc": "",
                    "lua_type": "string | Animation"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 209,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        },
        {
            "name": "stopAnimation",
            "desc": "Stops a desired animation.",
            "params": [
                {
                    "name": "animationController",
                    "desc": "",
                    "lua_type": "AnimationController | Humanoid"
                },
                {
                    "name": "category",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "parameter",
                    "desc": "",
                    "lua_type": "string | Animation"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 239,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "AnimationModuleType",
            "desc": "Defines the structure and methods available for managing animations across different controllers.",
            "fields": [
                {
                    "name": "initAnimationController",
                    "lua_type": "(self: AnimationModuleType, animationController: AnimationController | Humanoid) -> ()",
                    "desc": ""
                },
                {
                    "name": "isInitialised",
                    "lua_type": "(animationController: AnimationController | Humanoid) -> boolean",
                    "desc": ""
                },
                {
                    "name": "getAnimation",
                    "lua_type": "(animationController: AnimationController | Humanoid, category: string, parameter: string | Animation) -> AnimationTrack",
                    "desc": ""
                },
                {
                    "name": "getAnimationInstance",
                    "lua_type": "(animationController: AnimationController | Humanoid, category: string, animName: string) -> Animation?",
                    "desc": ""
                },
                {
                    "name": "playAnimation",
                    "lua_type": "(animationController: AnimationController | Humanoid, category: string, parameter: string | Animation, fadeTime: number?, weight: number?, speed: number?) -> AnimationTrack",
                    "desc": ""
                },
                {
                    "name": "stopAnimation",
                    "lua_type": "(animationController: AnimationController | Humanoid, category: string, parameter: string | Animation, fadeTime: number?) -> ()",
                    "desc": ""
                }
            ],
            "source": {
                "line": 28,
                "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
            }
        }
    ],
    "name": "AnimationManager",
    "desc": "Handles all of the games animations.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 9,
        "path": "global/ReplicatedStorage/Scripts/Modules/AnimationManager.luau"
    }
}