Skip to main content

RagdollFactory

Properties​

RagdollConstructed​

This item is read only and cannot be modified. Read Only
</>
RagdollFactory.RagdollConstructed: Signal

Fires when a ragdoll is constructed by the factory.

Functions​

new​

</>
RagdollFactory.new(
model: Model,
blueprintOverride: Blueprint?
) → Ragdoll?

Constructs a ragdoll from a model that satisfies any of its blueprints. Returns nil if no blueprint is satisfied.

addBlueprint​

</>
RagdollFactory.addBlueprint(blueprint: Blueprint) → ()

Adds a blueprint to the factory. Retroactively updates all existing ragdolls to this type of ragdoll if they satisfy its requirements.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a ragdoll from a model that satisfies any of its blueprints. Returns nil if no blueprint is satisfied.",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "blueprintOverride",
                    "desc": "",
                    "lua_type": "Blueprint?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "lib/RagdollFactory/init.lua"
            }
        },
        {
            "name": "wrap",
            "desc": "Creates a Ragdoll from a model that already has its Constraints constructed. Used to replicate a ragdoll across server -> client boundary.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "blueprintOverride",
                    "desc": "",
                    "lua_type": "Blueprint?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll?\n"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "private": true,
            "source": {
                "line": 66,
                "path": "lib/RagdollFactory/init.lua"
            }
        },
        {
            "name": "addBlueprint",
            "desc": "Adds a blueprint to the factory. Retroactively updates all existing ragdolls to this type of ragdoll if they satisfy its requirements.",
            "params": [
                {
                    "name": "blueprint",
                    "desc": "",
                    "lua_type": "Blueprint"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 80,
                "path": "lib/RagdollFactory/init.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "RagdollConstructed",
            "desc": "Fires when a ragdoll is constructed by the factory.",
            "lua_type": "Signal",
            "readonly": true,
            "source": {
                "line": 27,
                "path": "lib/RagdollFactory/init.lua"
            }
        }
    ],
    "types": [],
    "name": "RagdollFactory",
    "desc": "",
    "source": {
        "line": 12,
        "path": "lib/RagdollFactory/init.lua"
    }
}