Skip to main content

RagdollSystem

Properties​

RagdollFactory​

</>
RagdollSystem.RagdollFactory: RagdollFactory

Functions​

getRagdoll​

</>
RagdollSystem:getRagdoll(ragdollModel: Model) → Ragdoll?

Returns the ragdoll corresponding to the model or nil if there isn't one.

addRagdoll​

This item only works when running on the server. Server
</>
RagdollSystem:addRagdoll(ragdollModel: Model) → Ragdoll

Creates and caches a ragdoll corresponding to the Model.

removeRagdoll​

This item only works when running on the server. Server
</>
RagdollSystem:removeRagdoll(ragdollModel: Model) → ()

Destroys the ragdoll corresponding to the model and removes it from the cache.

getPlayerRagdoll​

This item only works when running on the server. Server
</>
RagdollSystem:getPlayerRagdoll(player: Player) → Ragdoll?

Returns the ragdoll corresponding to player's character or nil if there isnt one.

activateRagdoll​

</>
RagdollSystem:activateRagdoll(ragdollModel: Model) → ()

Activates ragdoll physics on the ragdoll.

deactivateRagdoll​

</>
RagdollSystem:deactivateRagdoll(ragdollModel: Model) → ()

Deactivates ragdoll physics on the ragdoll.

collapseRagdoll​

</>
RagdollSystem:collapseRagdoll(ragdollModel: Model) → ()

Activates ragdoll physics on the ragdoll, deactivates ragdoll physics after the ragdoll has remained still for 1.5 seconds.

getLocalRagdoll​

This item only works when running on the client. Client
</>
RagdollSystem:getLocalRagdoll() → Ragdoll?

Returns the ragdoll coresponding to the local player's character.

activateLocalRagdoll​

This item only works when running on the client. Client
</>
RagdollSystem:activateLocalRagdoll() → ()

Activates ragdoll physics on the local player's ragdoll.

deactivateLocalRagdoll​

This item only works when running on the client. Client
</>
RagdollSystem:deactivateLocalRagdoll() → ()

Deactivates ragdoll physics on the local player's ragdoll.

collapseLocalRagdoll​

This item only works when running on the client. Client
</>
RagdollSystem:collapseLocalRagdoll() → ()

Activates ragdoll physics on the local player's ragdoll, deactivates ragdoll physics after the ragdoll has remained still for 1.5 seconds.

Show raw api
{
    "functions": [
        {
            "name": "getRagdoll",
            "desc": "Returns the ragdoll corresponding to the model or nil if there isn't one.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll?\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 67,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "addRagdoll",
            "desc": "Creates and caches a ragdoll corresponding to the Model.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll\n"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 75,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "removeRagdoll",
            "desc": "Destroys the ragdoll corresponding to the model and removes it from the cache.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 85,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "getPlayerRagdoll",
            "desc": "Returns the ragdoll corresponding to player's character or nil if there isnt one.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll?\n"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 99,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "addPlayerRagdoll",
            "desc": "Creates and caches a ragdoll corresponding to the players character if it exists.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "character",
                    "desc": "",
                    "lua_type": "Model?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll?\n"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "private": true,
            "source": {
                "line": 108,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "removePlayerRagdoll",
            "desc": "Destroys the ragdoll corresponding to player's character and removes it from the cache.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "private": true,
            "source": {
                "line": 125,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "activateRagdoll",
            "desc": "Activates ragdoll physics on the ragdoll.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 140,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "deactivateRagdoll",
            "desc": "Deactivates ragdoll physics on the ragdoll.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 148,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "collapseRagdoll",
            "desc": "Activates ragdoll physics on the ragdoll, deactivates ragdoll physics after the ragdoll has remained still for 1.5 seconds.",
            "params": [
                {
                    "name": "ragdollModel",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 156,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "getLocalRagdoll",
            "desc": "Returns the ragdoll coresponding to the local player's character.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Ragdoll?\n"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 164,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "setLocalRagdoll",
            "desc": "Sets the local player's ragdoll.",
            "params": [
                {
                    "name": "ragdoll",
                    "desc": "",
                    "lua_type": "Ragdoll"
                }
            ],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "private": true,
            "source": {
                "line": 173,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "activateLocalRagdoll",
            "desc": "Activates ragdoll physics on the local player's ragdoll.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 182,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "deactivateLocalRagdoll",
            "desc": "Deactivates ragdoll physics on the local player's ragdoll.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 190,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "collapseLocalRagdoll",
            "desc": "Activates ragdoll physics on the local player's ragdoll, deactivates ragdoll physics after the ragdoll has remained still for 1.5 seconds.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 198,
                "path": "lib/init.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Remotes",
            "desc": "",
            "lua_type": "Remotes",
            "private": true,
            "source": {
                "line": 22,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "Signals",
            "desc": "",
            "lua_type": "Signals",
            "private": true,
            "source": {
                "line": 38,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "RagdollFactory",
            "desc": "",
            "lua_type": "RagdollFactory",
            "source": {
                "line": 42,
                "path": "lib/init.lua"
            }
        }
    ],
    "types": [
        {
            "name": "Remotes",
            "desc": "",
            "fields": [
                {
                    "name": "ActivateRagdoll",
                    "lua_type": "RemoteEvent",
                    "desc": ""
                },
                {
                    "name": "DeactivateRagdoll",
                    "lua_type": "RemoteEvent",
                    "desc": ""
                },
                {
                    "name": "CollapseeRagdoll",
                    "lua_type": "RemoteEvent",
                    "desc": ""
                }
            ],
            "private": true,
            "source": {
                "line": 17,
                "path": "lib/init.lua"
            }
        },
        {
            "name": "Signals",
            "desc": "",
            "fields": [
                {
                    "name": "ActivatePlayerRagdoll",
                    "lua_type": "Signal",
                    "desc": ""
                },
                {
                    "name": "DeactivatePlayerRagdoll",
                    "lua_type": "Signal",
                    "desc": ""
                },
                {
                    "name": "CollapsePlayerRagdoll",
                    "lua_type": "Signal",
                    "desc": ""
                },
                {
                    "name": "ActivateRagdoll",
                    "lua_type": "Signal",
                    "desc": ""
                },
                {
                    "name": "DeactivateRagdoll",
                    "lua_type": "Signal",
                    "desc": ""
                },
                {
                    "name": "CollapseRagdoll",
                    "lua_type": "Signal",
                    "desc": ""
                }
            ],
            "private": true,
            "source": {
                "line": 33,
                "path": "lib/init.lua"
            }
        }
    ],
    "name": "RagdollSystem",
    "desc": "",
    "source": {
        "line": 9,
        "path": "lib/init.lua"
    }
}