Skip to main content

Blueprint

Types​

SocketSettings​

</>
interface SocketSettings {
MaxFrictionTorque: number
UpperAngle: number
TwistLowerAngle: number
TwistUpperAngle: number
}

SocketSettingsDictionary​

</>
type SocketSettingsDictionary = {[string]=SocketSetting}

Each string must refer to a Basepart within the character this blueprint describes.

CFrameOverrides​

</>
type CFrameOverrides = {[string]={
C0: CFrame,
C1: CFrame
}}

Each string must refer to a Basepart within the character this blueprint describes.

Properties​

numlimbs​

</>
Blueprint.numlimbs: number?

Number of limbs your character model has

tip

Putting an accurate number can improve the performance of ragdoll construction slightly, although it isn't necessary.

socketSettings​

</>
Blueprint.socketSettings: SocketSettingsDictionary

Used to describe the range of motion of each BasePart within the ragdoll.

cframeOverrides​

</>
Blueprint.cframeOverrides: CFrameOverrides?

Used to change how specific parts in the ragdoll are attached on the ragdoll. For example, in the R6 blueprint the arms are overridden to be attached the same way Upper Arms are attached in R15 Characters.

lowDetailModeLimbs​

</>
Blueprint.lowDetailModeLimbs: {[string]: boolean}?

Describes which limbs will be activated in low detail mode.

Functions​

satisfiesRequirements​

</>
Blueprint.satisfiesRequirements(model: Model) → boolean

Returns whether the model can be properly constructed by this blueprint.

finalTouches​

</>
Blueprint.finalTouches(ragdoll: Ragdoll) → ()

Apply final touches to the ragdoll. For example, in the R15 blueprint some extra NoCollisionConstraints are added to make the ragdoll physics flow smoother.

Show raw api
{
    "functions": [
        {
            "name": "satisfiesRequirements",
            "desc": "Returns whether the model can be properly constructed by this blueprint.",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        },
        {
            "name": "finalTouches",
            "desc": "Apply final touches to the ragdoll. For example, in the R15 blueprint some extra NoCollisionConstraints are added to make the ragdoll physics flow smoother.",
            "params": [
                {
                    "name": "ragdoll",
                    "desc": "",
                    "lua_type": "Ragdoll"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "numlimbs",
            "desc": "Number of limbs your character model has\n:::tip\n\nPutting an accurate number can improve the performance of ragdoll construction slightly, although it isn't necessary.\n\n:::",
            "lua_type": "number?",
            "source": {
                "line": 35,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        },
        {
            "name": "socketSettings",
            "desc": "Used to describe the range of motion of each BasePart within the ragdoll.",
            "lua_type": "SocketSettingsDictionary",
            "source": {
                "line": 40,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        },
        {
            "name": "cframeOverrides",
            "desc": "Used to change how specific parts in the ragdoll are attached on the ragdoll.\nFor example, in the R6 blueprint the arms are overridden to be attached the same way Upper Arms are attached in R15 Characters.",
            "lua_type": "CFrameOverrides?",
            "source": {
                "line": 46,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        },
        {
            "name": "lowDetailModeLimbs",
            "desc": "Describes which limbs will be activated in low detail mode.",
            "lua_type": "{ [string]: boolean }?",
            "source": {
                "line": 51,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        }
    ],
    "types": [
        {
            "name": "SocketSettings",
            "desc": "",
            "fields": [
                {
                    "name": "MaxFrictionTorque",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "UpperAngle",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "TwistLowerAngle",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "TwistUpperAngle",
                    "lua_type": "number",
                    "desc": ""
                }
            ],
            "source": {
                "line": 15,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        },
        {
            "name": "SocketSettingsDictionary",
            "desc": "Each string must refer to a Basepart within the character this blueprint describes.",
            "lua_type": "{[string] = SocketSetting}",
            "source": {
                "line": 20,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        },
        {
            "name": "CFrameOverrides",
            "desc": "Each string must refer to a Basepart within the character this blueprint describes.",
            "lua_type": "{[string] = {C0: CFrame, C1: CFrame}",
            "source": {
                "line": 25,
                "path": "lib/RagdollFactory/Blueprint.lua"
            }
        }
    ],
    "name": "Blueprint",
    "desc": "",
    "source": {
        "line": 7,
        "path": "lib/RagdollFactory/Blueprint.lua"
    }
}