Skip to main content

Ragdoll

This class wraps around a Model and enables ragdoll physics by finding or creating physics constraints for it based on a Blueprint. The Model must contain a Humanoid, a HumanoidRootPart, and have Motor6D or AnimationConstraint descendants as joints.

Properties​

Character​

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

The model this ragdoll wraps.

Humanoid​

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

The Humanoid descendant of this Ragdoll's Character.

HumanoidRootPart​

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

The root part of this Ragdoll's Character.

RagdollBegan​

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

A 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)

Collapsed​

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

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

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.

collapseLowDetail​

</>
Ragdoll:collapseLowDetail() → ()

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

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": "_insertNoCollisionConstraint",
            "desc": "Inserts a NoCollisionConstraint into the ragdoll. Used to fine-tune the ragdoll's limb collisions. ",
            "params": [
                {
                    "name": "limb0",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "limb1",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 294,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "activateRagdollPhysics",
            "desc": "Activates ragdoll physics.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 305,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "activateRagdollPhysicsLowDetail",
            "desc": "Activates ragdoll physics in low detail mode.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 319,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "deactivateRagdollPhysics",
            "desc": "Deactivates ragdoll physics.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 333,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "collapse",
            "desc": "Activates ragdoll physics, then deactivates it when the ragdoll has remained still.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 376,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "collapseLowDetail",
            "desc": "Activates ragdoll physics in low detail mode, then deactivates it when the ragdoll has remained still.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 389,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "freeze",
            "desc": "Anchors all of the ragdoll's BaseParts.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 402,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "unfreeze",
            "desc": "Returns all of the ragdoll's BaseParts to their original settings.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 417,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "isRagdolled",
            "desc": "Returns true if ragdoll physics is active on this ragdoll.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 432,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "isCollapsed",
            "desc": "Returns true if the ragdoll has callapsed.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 439,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "isFrozen",
            "desc": "Returns true if the ragdoll is frozen.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 446,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "destroy",
            "desc": "Destroys the ragdoll.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 453,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Alias for destroy().",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 464,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "_constraintsFolder",
            "desc": "The root container for the ragdoll's internally created constraints.",
            "lua_type": "Folder",
            "private": true,
            "source": {
                "line": 21,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_noCollisionConstraintsFolder",
            "desc": "The folder containing all internally created NoCollisionConstraints.",
            "lua_type": "Folder",
            "private": true,
            "source": {
                "line": 27,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_socketFolder",
            "desc": "The folder containing all internally created BallSocketConstraints.",
            "lua_type": "Folder",
            "private": true,
            "source": {
                "line": 33,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_noCollisionConstraints",
            "desc": "",
            "lua_type": "{ NoCollisionConstraint }",
            "private": true,
            "source": {
                "line": 38,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_sockets",
            "desc": "",
            "lua_type": "{ BallSocketConstraint }",
            "private": true,
            "source": {
                "line": 43,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_limbs",
            "desc": "Array of the Ragdoll's direct children BaseParts exluding the root part.",
            "lua_type": "{ BasePart }",
            "private": true,
            "source": {
                "line": 49,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_accessoryHandles",
            "desc": "",
            "lua_type": "{ BasePart }",
            "private": true,
            "source": {
                "line": 54,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "_joints",
            "desc": "",
            "lua_type": "{ AnimationConstraint | Motor6D }",
            "private": true,
            "source": {
                "line": 59,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "Character",
            "desc": "The model this ragdoll wraps.",
            "lua_type": "Model",
            "readonly": true,
            "source": {
                "line": 65,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "Humanoid",
            "desc": "The Humanoid descendant of this Ragdoll's Character.",
            "lua_type": "Humanoid",
            "readonly": true,
            "source": {
                "line": 71,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "HumanoidRootPart",
            "desc": "The root part of this Ragdoll's Character.",
            "lua_type": "BasePart",
            "readonly": true,
            "source": {
                "line": 77,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "RagdollBegan",
            "desc": "A 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": 90,
                "path": "lib/RagdollFactory/Ragdoll/init.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": 102,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "Collapsed",
            "desc": "A signal fired when ragdoll:collapse() is called.",
            "lua_type": "Signal",
            "readonly": true,
            "source": {
                "line": 108,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        },
        {
            "name": "Destroying",
            "desc": "A signal fired when ragdoll:destroy() is called.",
            "lua_type": "Signal",
            "readonly": true,
            "source": {
                "line": 114,
                "path": "lib/RagdollFactory/Ragdoll/init.lua"
            }
        }
    ],
    "types": [],
    "name": "Ragdoll",
    "desc": "This class wraps around a [Model] and enables ragdoll physics by finding or\ncreating physics constraints for it based on a [Blueprint]. The Model must\ncontain a [Humanoid], a HumanoidRootPart, and have [Motor6D] or\n[AnimationConstraint] descendants as joints.",
    "source": {
        "line": 12,
        "path": "lib/RagdollFactory/Ragdoll/init.lua"
    }
}