Skip to main content

RagdollClient

This item only works when running on the client. Client

Client side ragdolling meant to be used with a binder. This class exports a Binder. While a humanoid is bound with this class, it is ragdolled.

tip

Initialize this whole system through RagdollServiceClient.

serviceBag:GetService(require("RagdollClient"))

Functions

new

RagdollClient.new(
humanoidHumanoid,
serviceBagServiceBag
) → RagdollClient

Constructs a new RagdollClient. This module exports a Binder.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RagdollClient. This module exports a [Binder].",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RagdollClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/ragdoll/src/Client/Classes/RagdollClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RagdollClient",
    "desc": "Client side ragdolling meant to be used with a binder. This class exports a [Binder].\nWhile a humanoid is bound with this class, it is ragdolled.\n\n:::tip\nInitialize this whole system through [RagdollServiceClient].\n:::\n\n```\nserviceBag:GetService(require(\"RagdollClient\"))\n```",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 16,
        "path": "src/ragdoll/src/Client/Classes/RagdollClient.lua"
    }
}