Skip to main content

Ragdoll

Properties​

Character​

This item is read only and cannot be modified. Read Only
</>
Ragdoll.Character: Model

The model this ragdoll corresponds to.

Humanoid​

This item is read only and cannot be modified. Read Only
</>
Ragdoll.Humanoid: Humanoid

HumanoidRootPart​

This item is read only and cannot be modified. Read Only
</>
Ragdoll.HumanoidRootPart: BasePart

RagdollBegan​

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

An signal fired when ragdoll physics has begun.

	ragdoll.RagdollBegan:Connect(function()
		--Do something when ragdoll physics has begun
	end)

RagdollEnded​

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

A signal fired when ragdoll physics has ended.

	ragdoll.RagdollEnded:Connect(function()
		--Do something when ragdoll physics has ended
	end)

Destroying​

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

A signal fired when ragdoll:destroy() is called.

Functions​

activateRagdollPhysics​

</>
Ragdoll:activateRagdollPhysics() → ()

Activates ragdoll physics.

activateRagdollPhysicsLowDetail​

</>
Ragdoll:activateRagdollPhysicsLowDetail() → ()

Activates ragdoll physics in low detail mode.

deactivateRagdollPhysics​

</>
Ragdoll:deactivateRagdollPhysics() → ()

Deactivates ragdoll physics.

collapse​

</>
Ragdoll:collapse() → ()

Activates ragdoll physics, then deactivates it when the ragdoll has remained still for 1.5 seconds.

collapseLowDetail​

</>
Ragdoll:collapseLowDetail() → ()

Activates ragdoll physics in low detail mode, then deactivates it when the ragdoll has remained still for 1.5 seconds.

freeze​

</>
Ragdoll:freeze() → ()

Anchors all of the ragdoll's BaseParts.

unfreeze​

</>
Ragdoll:unfreeze() → ()

Returns all of the ragdoll's BaseParts to their original settings.

isRagdolled​

</>
Ragdoll:isRagdolled() → boolean

Returns true if ragdoll physics is active on this ragdoll.

isCollapsed​

</>
Ragdoll:isCollapsed() → boolean

Returns true if the ragdoll has callapsed.

isFrozen​

</>
Ragdoll:isFrozen() → boolean

Returns true if the ragdoll is frozen.

destroy​

</>
Ragdoll:destroy() → ()

Destroys the ragdoll.

Destroy​

</>
Ragdoll:Destroy() → ()

Alias for destroy().

Show raw api
{
    "functions": [
        {
            "name": "_recordOriginalSettings",
            "desc": "Records the original settings of the BaseParts, Motor6Ds, Accessory Handles, and Humanoid of the ragdoll.",
            "params": [
                {
                    "name": "ragdoll",
                    "desc": "",
                    "lua_type": "Ragdoll"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 177,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "_setupLimb",
            "desc": "Creates the attachments and constraints connecting two parts of the rig.",
            "params": [
                {
                    "name": "ragdoll",
                    "desc": "",
                    "lua_type": "Ragdoll"
                },
                {
                    "name": "sourceLimb",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "affectedLimb",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "cframe0",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "cframe1",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "blueprint",
                    "desc": "",
                    "lua_type": "Blueprint"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 229,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "_setupLimbs",
            "desc": "Loops through all motor6Ds and attaches their Part1s to the ragdoll.",
            "params": [
                {
                    "name": "ragdoll",
                    "desc": "",
                    "lua_type": "Ragdoll"
                },
                {
                    "name": "blueprint",
                    "desc": "",
                    "lua_type": "Blueprint"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 276,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "activateRagdollPhysics",
            "desc": "Activates ragdoll physics.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 329,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "activateRagdollPhysicsLowDetail",
            "desc": "Activates ragdoll physics in low detail mode.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 343,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "deactivateRagdollPhysics",
            "desc": "Deactivates ragdoll physics.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 357,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "collapse",
            "desc": "Activates ragdoll physics, then deactivates it when the ragdoll has remained still for 1.5 seconds.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 399,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "collapseLowDetail",
            "desc": "Activates ragdoll physics in low detail mode, then deactivates it when the ragdoll has remained still for 1.5 seconds.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 445,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "freeze",
            "desc": "Anchors all of the ragdoll's BaseParts.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 458,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "unfreeze",
            "desc": "Returns all of the ragdoll's BaseParts to their original settings.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 473,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "isRagdolled",
            "desc": "Returns true if ragdoll physics is active on this ragdoll.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 488,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "isCollapsed",
            "desc": "Returns true if the ragdoll has callapsed.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 495,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "isFrozen",
            "desc": "Returns true if the ragdoll is frozen.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 502,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "destroy",
            "desc": "Destroys the ragdoll.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 509,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Alias for destroy().",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 519,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Character",
            "desc": "The model this ragdoll corresponds to.",
            "lua_type": "Model",
            "readonly": true,
            "source": {
                "line": 18,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "Humanoid",
            "desc": "",
            "lua_type": "Humanoid",
            "readonly": true,
            "source": {
                "line": 23,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "HumanoidRootPart",
            "desc": "",
            "lua_type": "BasePart",
            "readonly": true,
            "source": {
                "line": 28,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "RagdollBegan",
            "desc": "An signal fired when ragdoll physics has begun.\n\n```lua\n\tragdoll.RagdollBegan:Connect(function()\n\t\t--Do something when ragdoll physics has begun\n\tend)\n```",
            "lua_type": "Signal",
            "readonly": true,
            "source": {
                "line": 41,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "RagdollEnded",
            "desc": "A signal fired when ragdoll physics has ended.\n\n```lua\n\tragdoll.RagdollEnded:Connect(function()\n\t\t--Do something when ragdoll physics has ended\n\tend)\n```",
            "lua_type": "Signal",
            "readonly": true,
            "source": {
                "line": 53,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        },
        {
            "name": "Destroying",
            "desc": "A signal fired when ragdoll:destroy() is called.",
            "lua_type": "Signal",
            "readonly": true,
            "source": {
                "line": 59,
                "path": "lib/RagdollFactory/Ragdoll.lua"
            }
        }
    ],
    "types": [],
    "name": "Ragdoll",
    "desc": "",
    "source": {
        "line": 12,
        "path": "lib/RagdollFactory/Ragdoll.lua"
    }
}