Skip to main content

RagdollServiceClient

This item only works when running on the client. Client

Initializes the RagdollService on the client.

Functions​

Init​

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

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

SetScreenShakeEnabled​

</>
RagdollServiceClient:SetScreenShakeEnabled(value: boolelan) → ()

Sets screen shake enabled for the local player

GetScreenShakeEnabled​

</>
RagdollServiceClient:GetScreenShakeEnabled() → boolean

Returns wheher screenshake is enabled.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the ragdoll service on the client. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 21,
                "path": "src/ragdoll/src/Client/RagdollServiceClient.lua"
            }
        },
        {
            "name": "SetScreenShakeEnabled",
            "desc": "Sets screen shake enabled for the local player",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolelan"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 44,
                "path": "src/ragdoll/src/Client/RagdollServiceClient.lua"
            }
        },
        {
            "name": "GetScreenShakeEnabled",
            "desc": "Returns wheher screenshake is enabled.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 54,
                "path": "src/ragdoll/src/Client/RagdollServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RagdollServiceClient",
    "desc": "Initializes the RagdollService on the client.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/ragdoll/src/Client/RagdollServiceClient.lua"
    }
}