Skip to main content

RideManager_Server

RideManager used server-side and syncs between clients. Extends RideManager

Types​

RideManagerServerData​

</>
interface RideManagerServerData {
IsReady: BoolValue
AnimationPlayers: Folder
Animations: Folder
Tracks: Folder
}

Properties​

isReadyValue​

</>
RideManager_Server.isReadyValue: BoolValue

animationPlayersFolder​

</>
RideManager_Server.animationPlayersFolder: Folder

animationsFolder​

</>
RideManager_Server.animationsFolder: Folder

tracksFolder​

</>
RideManager_Server.tracksFolder: Folder

Functions​

new​

Constructor
</>
RideManager_Server.new() → RideManager_Server

Default constructor

fromInstance​

Constructor
</>
RideManager_Server.fromInstance(instance: Instance) → Result<RideManager_Server,string>

Constructs from an Instance

Destroy​

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

ready​

</>
RideManager_Server:ready() → ()

Readies all animation players

unready​

</>
RideManager_Server:unready() → ()

Unready's all animation players

createAnimationPlayer​

</>
RideManager_Server:createAnimationPlayer(name: string) → Result<ModelAnimationPlayer_Server,string>

Creates an new ModelAnimationPlayer used by this RideManager_Server

addAnimationPlayer​

</>
RideManager_Server:addAnimationPlayer(animationPlayer: ModelAnimationPlayer_Server) → ()

Adds the given ModelAnimationPlayer_Server to this RideManager_Server

createAnimationPlayerFromInstance​

</>
RideManager_Server:createAnimationPlayerFromInstance(
instance: Instance,
modelsFolder: Instance?
) → Result<ModelAnimationPlayer_Server,string>

Creates a ModelAnimationPlayer_Server from an Instance. If modelsFolder is given, if the instance's Model child is a StringValue, finds first child of modelsFolder with the name of StringValue.Value and sets the created ModelAnimationPlayer_Server's model to it.

addAnimationPlayersFromInstance​

</>
RideManager_Server:addAnimationPlayersFromInstance(
instance: Instance,
modelsFolder: Instance?
) → Result<{ModelAnimationPlayer_Server},string>

Converts all children in the given Instance to ModelAnimationPlayer_Server's and adds them to this RideManager_Server

setAnimation​

</>
RideManager_Server:setAnimation(
animation: Animation,
instance: Instance,
name: string
) → ()

Adds an animation to this RideManager_Server

createAnimationFromInstance​

</>
RideManager_Server:createAnimationFromInstance(instance: Instance) → Result<{
animation: Animation,
instance: Instance
},string>

Creates an Animation from an Instance. Returns the resulting animation and a clone of the Instance.

setAnimationFromInstance​

</>
RideManager_Server:setAnimationFromInstance(
instance: Instance,
name: string
) → Result<Animation,string>

Constructs an Animation from an Instance and adds an animation to this RideManager_Server

setAnimationsFromInstance​

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

Converts all children in the given Instance to an Animation and adds it to this RideManager_Server

createTrackFromInstance​

</>
RideManager_Server:createTrackFromInstance(instance: Instance) → Result<{
track: CFrameTrack,
instance: Instance
},string>

Creates a CFrameTrack from an Instance. Returns the resulting CFrameTrack and a clone of the Instance.

setTrack​

</>
RideManager_Server:setTrack(
track: CFrameTrack,
instance: Instance,
name: string
) → ()

Adds a CFrameTrack to this RideManager_Server

setTrackFromInstance​

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

Converts a CFrameTrack from an Instance and adds it to this RideManager_Server

setTracksFromInstance​

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

Converts all children in the given Instance to CFrameTracks and adds them to this RideManager_Server

addAnimation​

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

Use `setAnimation` instead.

RideManager_Server:addAnimation(
animation: Animation,
instance: Instance,
name: string
) → ()

Adds an animation to this RideManager_Server

addAnimationFromInstance​

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

Use `addAnimationFromInstance` instead.

RideManager_Server:addAnimationFromInstance(
instance: Instance,
name: string
) → Result<Animation,string>

Constructs an Animation from an Instance and adds an animation to this RideManager_Server

addAnimationsFromInstance​

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

Use `setAnimationsFromInstance` instead.

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

Converts all children in the given Instance to an Animation and adds it to this RideManager_Server

addTrack​

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

Use `setTrack` instead.

RideManager_Server:addTrack(
track: CFrameTrack,
instance: Instance,
name: string
) → ()

Adds a CFrameTrack to this RideManager_Server

addTrackFromInstance​

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

Use `setTrackFromInstance` instead.

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

Converts a CFrameTrack from an Instance and adds it to this RideManager_Server

addTracksFromInstance​

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

Use `setTracksFromInstance` instead.

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

Converts all children in the given Instance to CFrameTracks and adds them to this RideManager_Server.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Default constructor\n\t",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RideManager_Server"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 63,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "fromInstance",
            "desc": "Constructs from an Instance\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<RideManager_Server, string>"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 94,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 139,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Readies all animation players\n\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 157,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "unready",
            "desc": "Unready's all animation players\n\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 168,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "createAnimationPlayer",
            "desc": "Creates an new ModelAnimationPlayer used by this RideManager_Server\n\t",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<ModelAnimationPlayer_Server, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 181,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimationPlayer",
            "desc": "Adds the given ModelAnimationPlayer_Server to this RideManager_Server\n\t",
            "params": [
                {
                    "name": "animationPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Server"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 210,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "createAnimationPlayerFromInstance",
            "desc": "Creates a ModelAnimationPlayer_Server from an Instance.\nIf `modelsFolder` is given, if the instance's Model child is a `StringValue`,\nfinds first child of `modelsFolder` with the name of `StringValue.Value` and sets the created\nModelAnimationPlayer_Server's model to it.\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "modelsFolder",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<ModelAnimationPlayer_Server, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 236,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimationPlayersFromInstance",
            "desc": "Converts all children in the given Instance to ModelAnimationPlayer_Server's and adds them to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "modelsFolder",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ ModelAnimationPlayer_Server }, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 398,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setAnimation",
            "desc": "Adds an animation to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "animation",
                    "desc": "",
                    "lua_type": "Animation"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 445,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimation",
            "desc": "Adds an animation to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "animation",
                    "desc": "",
                    "lua_type": "Animation"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setAnimation` instead."
            },
            "source": {
                "line": 462,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "createAnimationFromInstance",
            "desc": "Creates an Animation from an Instance. Returns the resulting animation and a clone of the Instance.\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ animation: Animation, instance: Instance }, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 469,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setAnimationFromInstance",
            "desc": "Constructs an Animation from an Instance and adds an animation to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<Animation, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 491,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimationFromInstance",
            "desc": "Constructs an Animation from an Instance and adds an animation to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<Animation, string>"
                }
            ],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `addAnimationFromInstance` instead."
            },
            "source": {
                "line": 519,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setAnimationsFromInstance",
            "desc": "Converts all children in the given Instance to an Animation and adds it to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{Animation}, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 527,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addAnimationsFromInstance",
            "desc": "Converts all children in the given Instance to an Animation and adds it to this RideManager_Server\n\n\t",
            "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": 578,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "createTrackFromInstance",
            "desc": "Creates a CFrameTrack from an Instance.  Returns the resulting CFrameTrack and a clone of the Instance.\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{ track: CFrameTrack, instance: Instance }, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 586,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setTrack",
            "desc": "Adds a CFrameTrack to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "track",
                    "desc": "",
                    "lua_type": "CFrameTrack"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 608,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addTrack",
            "desc": "Adds a CFrameTrack to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "track",
                    "desc": "",
                    "lua_type": "CFrameTrack"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "deprecated": {
                "version": "v2.alpha.14",
                "desc": "Use `setTrack` instead."
            },
            "source": {
                "line": 625,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setTrackFromInstance",
            "desc": "Converts a CFrameTrack from an Instance and adds it to this RideManager_Server\n\n\t",
            "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": 634,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addTrackFromInstance",
            "desc": "Converts a CFrameTrack from an Instance and adds it to this RideManager_Server\n\n\t",
            "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": 663,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "setTracksFromInstance",
            "desc": "Converts all children in the given Instance to CFrameTracks and adds them to this RideManager_Server\n\n\t",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<{CFrameTrack}, string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 671,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "addTracksFromInstance",
            "desc": "Converts all children in the given Instance to CFrameTracks and adds them to this RideManager_Server.\n\n\t",
            "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": 722,
                "path": "src/server/rideManager/RideManager.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "isReadyValue",
            "desc": "\t",
            "lua_type": "BoolValue",
            "source": {
                "line": 38,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "animationPlayersFolder",
            "desc": "\t",
            "lua_type": "Folder",
            "source": {
                "line": 43,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "animationsFolder",
            "desc": "\t",
            "lua_type": "Folder",
            "source": {
                "line": 48,
                "path": "src/server/rideManager/RideManager.lua"
            }
        },
        {
            "name": "tracksFolder",
            "desc": "\t",
            "lua_type": "Folder",
            "source": {
                "line": 53,
                "path": "src/server/rideManager/RideManager.lua"
            }
        }
    ],
    "types": [
        {
            "name": "RideManagerServerData",
            "desc": "\t",
            "fields": [
                {
                    "name": "IsReady",
                    "lua_type": "BoolValue",
                    "desc": ""
                },
                {
                    "name": "AnimationPlayers",
                    "lua_type": "Folder",
                    "desc": ""
                },
                {
                    "name": "Animations",
                    "lua_type": "Folder",
                    "desc": ""
                },
                {
                    "name": "Tracks",
                    "lua_type": "Folder",
                    "desc": ""
                }
            ],
            "source": {
                "line": 27,
                "path": "src/server/rideManager/RideManager.lua"
            }
        }
    ],
    "name": "RideManager_Server",
    "desc": "RideManager used server-side and syncs between clients.\n*Extends RideManager*\n\t",
    "source": {
        "line": 33,
        "path": "src/server/rideManager/RideManager.lua"
    }
}