Skip to main content

Rig

A stand-in R15 rig made at runtime, server side. Nothing in the package needs it; it exists so a test place or a story can spawn an enemy without authoring a model first.

Functions​

Create​

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
</>
Rig.Create(
name: string,
options: RigOptions?
) → Model--

At the origin; pivot it into place. Server only.

Types

​

interface RigOptions {
Humanoid: boolean?--

false anchors the root for the CFrame mover. Default true.

Color: Color3?--

Body colour. Default light grey.

Transparency: number?--

Body transparency. Default 0.

Speed: number?--

The Humanoid's WalkSpeed. Default 16.

}
Show raw api
{
    "functions": [
        {
            "name": "Create",
            "desc": "",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "RigOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "At the origin; pivot it into place. Server only.",
                    "lua_type": "Model"
                }
            ],
            "function_type": "static",
            "yields": true,
            "source": {
                "line": 67,
                "path": "lib/Debug/Rig.luau"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "RigOptions",
            "desc": "",
            "fields": [
                {
                    "name": "Humanoid",
                    "lua_type": "boolean?",
                    "desc": "`false` anchors the root for the CFrame mover. Default `true`."
                },
                {
                    "name": "Color",
                    "lua_type": "Color3?",
                    "desc": "Body colour. Default light grey."
                },
                {
                    "name": "Transparency",
                    "lua_type": "number?",
                    "desc": "Body transparency. Default `0`."
                },
                {
                    "name": "Speed",
                    "lua_type": "number?",
                    "desc": "The Humanoid's WalkSpeed. Default `16`."
                }
            ],
            "source": {
                "line": 35,
                "path": "lib/Debug/Rig.luau"
            }
        }
    ],
    "name": "Rig",
    "desc": "A stand-in R15 rig made at runtime, server side. Nothing in the package needs it; it exists so\na test place or a story can spawn an enemy without authoring a model first.",
    "source": {
        "line": 59,
        "path": "lib/Debug/Rig.luau"
    }
}