Skip to main content

RagdollService

This item only works when running on the server. Server

Initializes ragdoll related binders

Functions​

Init​

</>
RagdollService:Init(serviceBag: ServiceBag) → ()

Initializes the ragdoll service on the server. Should be done via ServiceBag.

SetRagdollOnFall​

</>
RagdollService:SetRagdollOnFall(ragdollOnFall: boolean) → ()

Sets whether ragdolls should ragdoll on fall.

SetRagdollOnDeath​

</>
RagdollService:SetRagdollOnDeath(ragdollOnDeath: boolean) → ()

Sets whether ragdolls should unragdoll automatically.

SetUnragdollAutomatically​

</>
RagdollService:SetUnragdollAutomatically(unragdollAutomatically: boolean) → ()

Sets whether ragdolls should unragdoll automatically.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the ragdoll service on the server. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 17,
                "path": "src/ragdoll/src/Server/RagdollService.lua"
            }
        },
        {
            "name": "SetRagdollOnFall",
            "desc": "Sets whether ragdolls should ragdoll on fall.",
            "params": [
                {
                    "name": "ragdollOnFall",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/ragdoll/src/Server/RagdollService.lua"
            }
        },
        {
            "name": "SetRagdollOnDeath",
            "desc": "Sets whether ragdolls should unragdoll automatically.",
            "params": [
                {
                    "name": "ragdollOnDeath",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 56,
                "path": "src/ragdoll/src/Server/RagdollService.lua"
            }
        },
        {
            "name": "SetUnragdollAutomatically",
            "desc": "Sets whether ragdolls should unragdoll automatically.",
            "params": [
                {
                    "name": "unragdollAutomatically",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 67,
                "path": "src/ragdoll/src/Server/RagdollService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RagdollService",
    "desc": "Initializes ragdoll related binders",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "src/ragdoll/src/Server/RagdollService.lua"
    }
}