Skip to main content

RigBuilderUtils

Helps build player characters or other humanoid rigs for use in a variety of situations.

Functions​

disableAnimateScript​

</>
RigBuilderUtils.disableAnimateScript(rig: Model) → ()

Typically we don't want to remove the animate script completely, just disable it.

findAnimateScript​

</>
RigBuilderUtils.findAnimateScript(rig: Model) → LocalScript?

Finds the animate script in the rig

createR6MeshRig​

</>
RigBuilderUtils.createR6MeshRig() → Model

Creates an R6 mesh rig

createR6MeshBoyRig​

</>
RigBuilderUtils.createR6MeshBoyRig() → Model

Creates an R6 boy mesh rig

createR6MeshGirlRig​

</>
RigBuilderUtils.createR6MeshGirlRig() → Model

Creates an R6 girl mesh rig

promiseR15PackageRig​

</>
RigBuilderUtils.promiseR15PackageRig(packageAssetId: number) → Promise<Model>

Creates an R15 rig from a package

promiseR15Rig​

</>
RigBuilderUtils.promiseR15Rig() → Promise<Model>

Creates a default R15 rig

promiseR15ManRig​

</>
RigBuilderUtils.promiseR15ManRig() → Promise<Model>

Creates an R15 man rig

promiseR15WomanRig​

</>
RigBuilderUtils.promiseR15WomanRig() → Promise<Model>

Creates an R15 woman rig

promiseR15MeshRig​

</>
RigBuilderUtils.promiseR15MeshRig() → Promise<Model>

Creates an R15 mesh rig

promiseBasePlayerRig​

</>
RigBuilderUtils.promiseBasePlayerRig(
userId: number,
humanoidRigType: HumanoidRigType | nil,
assetTypeVerification: AssetTypeVerification | nil
) → Promise<Model>

Creates an R15 rig with the base details of a given character, but not all of them

promiseHumanoidModelFromDescription​

</>
RigBuilderUtils.promiseHumanoidModelFromDescription(
description: HumanoidDescription,
rigType: HumanoidRigType | nil,
assetTypeVerification: AssetTypeVerification | nil
) → Promise<Model>

Promises humanoid model from description

promisePlayerRig​

</>
RigBuilderUtils.promisePlayerRig(userId: number) → Promise<Model>

Creates an R15 rig dressed as a given player

Show raw api
{
    "functions": [
        {
            "name": "disableAnimateScript",
            "desc": "Typically we don't want to remove the animate script completely, just disable it.",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "findAnimateScript",
            "desc": "Finds the animate script in the rig",
            "params": [
                {
                    "name": "rig",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "LocalScript?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "createR6MeshRig",
            "desc": "Creates an R6 mesh rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 196,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "createR6MeshBoyRig",
            "desc": "Creates an R6 boy mesh rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 236,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "createR6MeshGirlRig",
            "desc": "Creates an R6 girl mesh rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 276,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseR15PackageRig",
            "desc": "Creates an R15 rig from a package",
            "params": [
                {
                    "name": "packageAssetId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 358,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseR15Rig",
            "desc": "Creates a default R15 rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 419,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseR15ManRig",
            "desc": "Creates an R15 man rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 449,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseR15WomanRig",
            "desc": "Creates an R15 woman rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 457,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseR15MeshRig",
            "desc": "Creates an R15 mesh rig",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 465,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseBasePlayerRig",
            "desc": "Creates an R15 rig with the base details of a given character, but not all of them",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "humanoidRigType",
                    "desc": "",
                    "lua_type": "HumanoidRigType | nil"
                },
                {
                    "name": "assetTypeVerification",
                    "desc": "",
                    "lua_type": "AssetTypeVerification | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 476,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promiseHumanoidModelFromDescription",
            "desc": "Promises humanoid model from description",
            "params": [
                {
                    "name": "description",
                    "desc": "",
                    "lua_type": "HumanoidDescription"
                },
                {
                    "name": "rigType",
                    "desc": "",
                    "lua_type": "HumanoidRigType | nil"
                },
                {
                    "name": "assetTypeVerification",
                    "desc": "",
                    "lua_type": "AssetTypeVerification | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 516,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        },
        {
            "name": "promisePlayerRig",
            "desc": "Creates an R15 rig dressed as a given player",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Model>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 585,
                "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RigBuilderUtils",
    "desc": "Helps build player characters or other humanoid rigs for use in a variety of situations.",
    "source": {
        "line": 6,
        "path": "src/rigbuilderutils/src/Shared/RigBuilderUtils.lua"
    }
}