Skip to main content

FootStepSystem

This item only works when running on the client. Client

Functions​

updateSoundForMaterial​

</>
FootStepSystem.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​

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

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

setupFootsteps​

</>
FootStepSystem.setupFootsteps() → ()

Connects the needed events.

Show raw api
{
    "functions": [
        {
            "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": 121,
                "path": "packages/lifelikeCharactersService/source/modules/FootstepSystem.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": 128,
                "path": "packages/lifelikeCharactersService/source/modules/FootstepSystem.luau"
            }
        },
        {
            "name": "setupFootsteps",
            "desc": "Connects the needed events.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 135,
                "path": "packages/lifelikeCharactersService/source/modules/FootstepSystem.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FootStepSystem",
    "desc": "",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 71,
        "path": "packages/lifelikeCharactersService/source/modules/FootstepSystem.luau"
    }
}