Skip to main content

RestraintPlugin

Manages restraints so that they can be open, closed, locked, unlocked all at once.

Types​

CreateRestraintFunction​

</>
type CreateRestraintFunction = (
rideSeat: RideSeat,
model: Instance
) → Restraint

Functions​

new​

Constructor
</>
RestraintPlugin.new(
animPlayer: ModelAnimationPlayer,
getRestraintsFromModel: (model: Model) → {Restraint}
) → RestraintPlugin

getRestraint​

</>
RestraintPlugin:getRestraint(seat: any) → Restraint | nil

Returns the restraint associated with the given seat.

setIsOpen​

</>
RestraintPlugin:setIsOpen(value: boolean) → ()

Sets isOpen of all restraints

openAll​

</>
RestraintPlugin:openAll() → ()

Sets all restraints to be open. Restraint must NOT be locked in order to be changed.

closeAll​

</>
RestraintPlugin:closeAll() → ()

Sets all restraints to be closed. Restraint must NOT be locked in order to be changed.

setIsLocked​

</>
RestraintPlugin:setIsLocked(value: boolean) → ()

Sets isLocked of all restraints

lock​

</>
RestraintPlugin:lock() → ()

Sets all restraints to be locked.

unlock​

</>
RestraintPlugin:unlock() → ()

Sets all restraints to be unlocked.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "animPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer"
                },
                {
                    "name": "getRestraintsFromModel",
                    "desc": "",
                    "lua_type": "(model: Model) -> {Restraint}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RestraintPlugin"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 21,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "_updateModel",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 54,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "_removeModel",
            "desc": "",
            "params": [
                {
                    "name": "_animModel",
                    "desc": "",
                    "lua_type": "AnimationModel"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 68,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "getRestraint",
            "desc": "Returns the restraint associated with the given seat.",
            "params": [
                {
                    "name": "seat",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Restraint | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 78,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "setIsOpen",
            "desc": "Sets isOpen of all restraints",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 90,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "openAll",
            "desc": "Sets all restraints to be open.\nRestraint must NOT be locked in order to be changed.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 98,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "closeAll",
            "desc": "Sets all restraints to be closed.\nRestraint must NOT be locked in order to be changed.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 104,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "setIsLocked",
            "desc": "Sets isLocked of all restraints",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "lock",
            "desc": "Sets all restraints to be locked.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 117,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        },
        {
            "name": "unlock",
            "desc": "Sets all restraints to be unlocked.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 122,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "CreateRestraintFunction",
            "desc": "",
            "lua_type": "(rideSeat: RideSeat, model: Instance) -> Restraint",
            "source": {
                "line": 11,
                "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
            }
        }
    ],
    "name": "RestraintPlugin",
    "desc": "Manages restraints so that they can be open, closed, locked, unlocked all at once.",
    "source": {
        "line": 8,
        "path": "src/shared/plugins/restraint/RestraintPlugin.lua"
    }
}