Skip to main content

RideManager

Manages animationPlayers and their animations and tracks

Properties​

updater​

</>
RideManager.updater: RootUpdater

animationPlayers​

</>
RideManager.animationPlayers: {ModelAnimationPlayer}

animations​

</>
RideManager.animations: {Animations}

animationsMap​

</>
RideManager.animationsMap: {[string]: Animation}

tracks​

</>
RideManager.tracks: {CFrameTrack}

tracksMap​

</>
RideManager.tracksMap: {[string]: CFrameTrack}

getAnimationPlayerFunction​

</>
RideManager.getAnimationPlayerFunction: (name: string) → ModelAnimationPlayer?

getAnimationFunction​

</>
RideManager.getAnimationFunction: (name: string) → Animation?

getTrackFunction​

</>
RideManager.getTrackFunction: (name: string) → CFrameTrack?

Functions​

new​

Constructor
</>
RideManager.new() → RideManager

Default constructor

fromInstance​

Constructor
</>
RideManager.fromInstance(_instance: Instance) → Result<RideManager,string>

Constructs a RideManager from an Instance

Errors

TypeDescription
Not implemented!

Destroy​

Deconstructor
</>
RideManager:Destroy() → ()

Deconstructor

update​

</>
RideManager:update(stepped: number) → ()

Updates

getAnimationPlayer​

</>
RideManager:getAnimationPlayer(name: string) → ModelAnimationPlayer?

Returns the ModelAnimationPlayer with the given name

getAnimationPlayersWithTags​

</>
RideManager:getAnimationPlayersWithTags(...: string) → {ModelAnimationPlayer}

Returns the animationPlayer with the given tags

getAnimationPlayers​

</>
RideManager:getAnimationPlayers() → {ModelAnimationPlayer}

Returns the list of ModelAnimationPlayers

getAnimation​

</>
RideManager:getAnimation(name: string) → Animation?

Returns the animation with the given name

getAnimations​

</>
RideManager:getAnimations() → {Animation}

Returns the list of Animations

getAnimationNames​

</>
RideManager:getAnimationNames() → {string}

Returns a table of the added animations

getTrack​

</>
RideManager:getTrack(name: string) → CFrameTrack?

Returns the track with the given name

getTracks​

</>
RideManager:getTracks() → {CFrameTrack}

Returns the list of Tracks

addAnimationPlayer​

</>
RideManager:addAnimationPlayer(animationPlayer: ModelAnimationPlayer) → ()

Adds a ModelAnimationPlayer

removeAnimationPlayer​

</>
RideManager:removeAnimationPlayer(index: number) → Result<RideManager,string>

Removes a ModelAnimationPlayer from this RideManager Does NOT Destroy it

setAnimation​

</>
RideManager:setAnimation(
animation: Animation,
name: string
) → Animation?

Registers an animation with the given name

If animation with given name already set, overwrites it and returns it.

setTrack​

</>
RideManager:setTrack(
cframeTrack: CFrameTrack,
name: string
) → CFrameTrack?

Registers a CFrameTrack with the given name

If track with given name already set, overwrites it and returns it.

addAnimation​

deprecated in v2.alpha.14
</>
This was deprecated in v2.alpha.14

Use `setAnimation` instead.

RideManager:addAnimation(
animation: Animation,
name: string
) → Animation?

Registers an animation with the given name

addTrack​

deprecated in v2.alpha.14
</>
This was deprecated in v2.alpha.14

Use `setTrack` instead.

RideManager:addTrack(
cframeTrack: CFrameTrack,
name: string
) → CFrameTrack?

Registers a CFrameTrack with the given name.

If track with given name already set, overwrites it and returns it.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Default constructor",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideManager"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 54,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Constructs a RideManager from an Instance",
            "params": [
                {
                    "name": "_instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<RideManager, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "errors": [
                {
                    "lua_type": "Not implemented!",
                    "desc": ""
                }
            ],
            "source": {
                "line": 85,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 91,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 108,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimationPlayer",
            "desc": "Returns the ModelAnimationPlayer with the given name",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 115,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimationPlayersWithTags",
            "desc": "Returns the animationPlayer with the given tags",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ModelAnimationPlayer}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 130,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimationPlayers",
            "desc": "Returns the list of ModelAnimationPlayers",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ModelAnimationPlayer}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 144,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimation",
            "desc": "Returns the animation with the given name",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animation?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 151,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimations",
            "desc": "Returns the list of Animations",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{Animation}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 157,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimationNames",
            "desc": "Returns a table of the added animations",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 168,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getTrack",
            "desc": "Returns the track with the given name",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrameTrack?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 181,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getTracks",
            "desc": "Returns the list of Tracks",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{CFrameTrack}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 187,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimationPlayer",
            "desc": "Adds a ModelAnimationPlayer",
            "params": [
                {
                    "name": "animationPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 198,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "removeAnimationPlayer",
            "desc": "Removes a ModelAnimationPlayer from this RideManager\n*Does NOT Destroy it*",
            "params": [
                {
                    "name": "index",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<RideManager, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 210,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setAnimation",
            "desc": "Registers an animation with the given name\n\nIf animation with given name already set, overwrites it and returns it.",
            "params": [
                {
                    "name": "animation",
                    "desc": "",
                    "lua_type": "Animation"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animation?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 232,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimation",
            "desc": "Registers an animation with the given name",
            "params": [
                {
                    "name": "animation",
                    "desc": "",
                    "lua_type": "Animation"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Animation?"
                }
            ],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setAnimation` instead."
            },
            "source": {
                "line": 252,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setTrack",
            "desc": "Registers a CFrameTrack with the given name\n\nIf track with given name already set, overwrites it and returns it.",
            "params": [
                {
                    "name": "cframeTrack",
                    "desc": "",
                    "lua_type": "CFrameTrack"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrameTrack?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 263,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addTrack",
            "desc": "Registers a CFrameTrack with the given name.\n\nIf track with given name already set, overwrites it and returns it.",
            "params": [
                {
                    "name": "cframeTrack",
                    "desc": "",
                    "lua_type": "CFrameTrack"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrameTrack?"
                }
            ],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setTrack` instead."
            },
            "source": {
                "line": 285,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "updater",
            "desc": "",
            "lua_type": "RootUpdater",
            "source": {
                "line": 23,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "animationPlayers",
            "desc": "",
            "lua_type": "{ModelAnimationPlayer}",
            "source": {
                "line": 26,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "animations",
            "desc": "",
            "lua_type": "{Animations}",
            "source": {
                "line": 29,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "animationsMap",
            "desc": "",
            "lua_type": "{[string]: Animation}",
            "source": {
                "line": 32,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "tracks",
            "desc": "",
            "lua_type": "{CFrameTrack}",
            "source": {
                "line": 35,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "tracksMap",
            "desc": "",
            "lua_type": "{[string]: CFrameTrack}",
            "source": {
                "line": 38,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimationPlayerFunction",
            "desc": "",
            "lua_type": "(name: string) -> ModelAnimationPlayer?",
            "source": {
                "line": 41,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getAnimationFunction",
            "desc": "",
            "lua_type": "(name: string) -> Animation?",
            "source": {
                "line": 44,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        },
        {
            "name": "getTrackFunction",
            "desc": "",
            "lua_type": "(name: string) -> CFrameTrack?",
            "source": {
                "line": 47,
                "path": "src/shared/rideManager/RideManager.lua"
            }
        }
    ],
    "types": [],
    "name": "RideManager",
    "desc": "Manages animationPlayers and their animations and tracks",
    "source": {
        "line": 20,
        "path": "src/shared/rideManager/RideManager.lua"
    }
}