Skip to main content

LifelikeCharactersServiceClient

This item only works when running on the client. Client

Functions​

setHeadRotationReplicationRate​

</>
LifelikeCharactersServiceClient.setHeadRotationReplicationRate(rate: number) → ()

Override the head replication rate, by default the rate is 1/20.

WARNING

You shouldn't mess with this too much as higher values can cause bandwidth issues.

setFirstPersonOffset​

</>
LifelikeCharactersServiceClient.setFirstPersonOffset(offset: number) → ()

Sets how far farward the camera will be in first person compared to normal. Note that the negative scale is farward relative to the head.

setHeadRotationClampValues​

</>
LifelikeCharactersServiceClient.setHeadRotationClampValues(
lower: number?,
upper: number?
) → ()

setCustomHeadOffset​

</>
LifelikeCharactersServiceClient.setCustomHeadOffset(headOffset: number?) → ()

updateSoundForMaterial​

</>
LifelikeCharactersServiceClient.updateSoundForMaterial(
material: Material,
sound: string?
) → ()

Sets the sound for the passed material to be sound where if sound is nil then the fallback sound is used, this by default is the normal roblox walking sound however this can be overrided with LifelikeCharactersServiceClient.changeFallbackSound.

changeFallbackSound​

</>
LifelikeCharactersServiceClient.changeFallbackSound(sound: string) → ()

Change the default footstep sound that is used when a Material doesnt have a sound set.

Show raw api
{
    "functions": [
        {
            "name": "setHeadRotationReplicationRate",
            "desc": "Override the head replication rate, by default the rate is `1/20`.\n\n:::warning\nYou shouldn't mess with this too much as higher values can cause bandwidth issues.\n:::",
            "params": [
                {
                    "name": "rate",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 36,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        },
        {
            "name": "setFirstPersonOffset",
            "desc": "Sets how far farward the camera will be in first person compared to normal. Note that\nthe negative scale is farward relative to the head.",
            "params": [
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        },
        {
            "name": "setHeadRotationClampValues",
            "desc": "[HeadSystem.setBounds]",
            "params": [
                {
                    "name": "lower",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "upper",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 51,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        },
        {
            "name": "setCustomHeadOffset",
            "desc": "[HeadSystem.setCustomHeadOffset]",
            "params": [
                {
                    "name": "headOffset",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        },
        {
            "name": "updateSoundForMaterial",
            "desc": "Sets the sound for the passed `material` to be `sound` where if `sound` is nil then the fallback sound is used, this by default is\nthe normal roblox walking sound however this can be overrided with [LifelikeCharactersServiceClient.changeFallbackSound].",
            "params": [
                {
                    "name": "material",
                    "desc": "",
                    "lua_type": "Material"
                },
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 68,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        },
        {
            "name": "changeFallbackSound",
            "desc": "Change the default footstep sound that is used when a [Material] doesnt have a sound set.",
            "params": [
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        },
        {
            "name": "setup",
            "desc": "This function is called for you when the package starts. You do NOT need to call this.\n\nIf you call this function it will error.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 85,
                "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "LifelikeCharactersServiceClient",
    "desc": "Can be accessed via [LifelikeCharactersService.getClient].",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 27,
        "path": "packages/lifelikeCharactersService/source/LifelikeCharactersServiceClient.luau"
    }
}