Skip to main content

RideManager_Client

RideManager used client-side and syncs with server. Extends RideManager

Functions​

new​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
RideManager_Client.new(
serverData: Folder--

Instance generated from RideManager_Server to sync between server and client

) → RideManager_Client

Constructs a RideManager_Client. Yields until server data is ready.

Errors

TypeDescription
Errors if not setup properly. Use fromInstance to catch these errors

fromInstance​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
RideManager_Client.fromInstance(instance: Instance) → Result<RideManager_Client,string>

Constructs a RideManager_Client from an Instance (the server data) Returns a Err Result if serverData is not setup correctly. Yields until server data is ready.

Destroy​

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

ready​

</>
RideManager_Client:ready() → ()

Readies this for syncing

unready​

</>
RideManager_Client:unready() → ()

Unready's this from syncing

createAnimationPlayer​

</>
RideManager_Client:createAnimationPlayer(serverData: Folder) → ModelAnimationPlayer_Client

Creates a ModelAnimationPlayer used by this RideManager_Client

addAnimationPlayersFromInstance​

</>
RideManager_Client:addAnimationPlayersFromInstance(instance: Instance) → ()

Converts all children in the given Instance to ModelAnimationPlayer_Client's and adds them to this RideManager_Client

setAnimationFromInstance​

</>
RideManager_Client:setAnimationFromInstance(
instance: Instance,
name: string
) → ()

Creates and adds a ModelAnimationPlayer from Instance

setAnimationsFromInstance​

</>
RideManager_Client:setAnimationsFromInstance(instance: Instance) → Result<{Animation},string>

Converts all children in the given Instance to Animations and adds them to this RideManager_Client

setTrackFromInstance​

</>
RideManager_Client:setTrackFromInstance(
instance: Instance,
name: string
) → Result<CFrameTrack,string>

Converts am Instance to a CFrameTrack and adds it to this RideManager_Client

setTracksFromInstance​

</>
RideManager_Client:setTracksFromInstance(instance: Instance) → Result<{CFrameTrack},string>

Converts all children in the given Instance to CFrameTrack's and adds them to this RideManager_Client

addAnimationFromInstance​

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

Use `setAnimationFromInstance` instead.

RideManager_Client:addAnimationFromInstance(instance: Instance) → ()

Creates and adds a ModelAnimationPlayer from Instance

addAnimationsFromInstance​

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

Use `setAnimationsFromInstance` instead.

RideManager_Client:addAnimationsFromInstance(instance: Instance) → Result<{Animation},string>

Converts all children in the given Instance to Animations and adds them to this RideManager_Client

addTrackFromInstance​

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

Use `setTrackFromInstance` instead.

RideManager_Client:addTrackFromInstance(
instance: Instance,
name: string
) → Result<CFrameTrack,string>

Converts an Instance to a CFrameTrack and adds it to this RideManager_Client

addTracksFromInstance​

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

Use `setTracksFromInstance` instead.

RideManager_Client:addTracksFromInstance(instance: Instance) → Result<{CFrameTrack},string>

Converts all children in the given Instance to CFrameTrack's and adds them to this RideManager_Client

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a RideManager_Client.\nYields until server data is ready.",
            "params": [
                {
                    "name": "serverData",
                    "desc": "Instance generated from RideManager_Server to sync between server and client",
                    "lua_type": "Folder"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideManager_Client"
                }
            ],
            "function_type": "static",
            "errors": [
                {
                    "lua_type": "Errors if not setup properly. Use fromInstance to catch these errors",
                    "desc": ""
                }
            ],
            "yields": true,
            "source": {
                "line": 36,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Constructs a RideManager_Client from an Instance (the server data)\nReturns a `Err` Result if serverData is not setup correctly.\nYields until server data is ready.",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<RideManager_Client, string>"
                }
            ],
            "function_type": "static",
            "yields": true,
            "source": {
                "line": 82,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 113,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Readies this for syncing",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 128,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "unready",
            "desc": "Unready's this from syncing",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 135,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "createAnimationPlayer",
            "desc": "Creates a ModelAnimationPlayer used by this RideManager_Client",
            "params": [
                {
                    "name": "serverData",
                    "desc": "",
                    "lua_type": "Folder"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Client"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 144,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "addAnimationPlayersFromInstance",
            "desc": "Converts all children in the given Instance to ModelAnimationPlayer_Client's and adds them to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 176,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "setAnimationFromInstance",
            "desc": "Creates and adds a ModelAnimationPlayer from Instance",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 218,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "addAnimationFromInstance",
            "desc": "Creates and adds a ModelAnimationPlayer from Instance",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setAnimationFromInstance` instead."
            },
            "source": {
                "line": 246,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "setAnimationsFromInstance",
            "desc": "Converts all children in the given Instance to Animations and adds them to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ Animation }, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 254,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "addAnimationsFromInstance",
            "desc": "Converts all children in the given Instance to Animations and adds them to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ Animation }, string>"
                }
            ],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setAnimationsFromInstance` instead."
            },
            "source": {
                "line": 303,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "setTrackFromInstance",
            "desc": "Converts am Instance to a CFrameTrack and adds it to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<CFrameTrack, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 312,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "addTrackFromInstance",
            "desc": "Converts an Instance to a CFrameTrack and adds it to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<CFrameTrack, string>"
                }
            ],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setTrackFromInstance` instead."
            },
            "source": {
                "line": 343,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "setTracksFromInstance",
            "desc": "Converts all children in the given Instance to CFrameTrack's and adds them to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ CFrameTrack }, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 351,
                "path": "src/shared/client/RideManager.lua"
            }
        },
        {
            "name": "addTracksFromInstance",
            "desc": "Converts all children in the given Instance to CFrameTrack's and adds them to this RideManager_Client",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ CFrameTrack }, string>"
                }
            ],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setTracksFromInstance` instead."
            },
            "source": {
                "line": 400,
                "path": "src/shared/client/RideManager.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RideManager_Client",
    "desc": "RideManager used client-side and syncs with server.\n*Extends RideManager*",
    "source": {
        "line": 25,
        "path": "src/shared/client/RideManager.lua"
    }
}