Skip to main content

RagdollHumanoidOnDeathClient

This item only works when running on the client. Client

Ragdolls the humanoid on death. Should be bound via RagdollBindersClient.

Functions​

new​

</>
RagdollHumanoidOnDeathClient.new(
humanoid: Humanoid,
serviceBag: ServiceBag
) → RagdollHumanoidOnDeathClient

Constructs a new RagdollHumanoidOnDeathClient. This module exports a Binder.

disableParticleEmittersAndFadeOutYielding​

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts. Yields
</>
RagdollHumanoidOnDeathClient.disableParticleEmittersAndFadeOutYielding(
character: Model,
duration: number
) → ()

Disables all particle emitters and fades them out. Yields for the duration.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RagdollHumanoidOnDeathClient. This module exports a [Binder].",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RagdollHumanoidOnDeathClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "src/ragdoll/src/Client/Classes/RagdollHumanoidOnDeathClient.lua"
            }
        },
        {
            "name": "disableParticleEmittersAndFadeOutYielding",
            "desc": "Disables all particle emitters and fades them out. Yields for the duration.",
            "params": [
                {
                    "name": "character",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "duration",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "yields": true,
            "source": {
                "line": 76,
                "path": "src/ragdoll/src/Client/Classes/RagdollHumanoidOnDeathClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RagdollHumanoidOnDeathClient",
    "desc": "Ragdolls the humanoid on death. Should be bound via [RagdollBindersClient].",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/ragdoll/src/Client/Classes/RagdollHumanoidOnDeathClient.lua"
    }
}