Skip to main content

LifelikeCharactersService

A simple package to automatically bring characters to life by doing the following:

  • Better footstep sounds
  • Seeing your body in first person
  • Head following camera angle in first & third person.

Functions​

getClient​

This item only works when running on the client. Client
</>
LifelikeCharactersService.getClient() → LifelikeCharactersServiceClient

Returns the client API. This can only be called on the client.

getServer​

This item only works when running on the server. Server
</>
LifelikeCharactersService.getServer() → LifelikeCharactersServiceServer

Returns the server API. This can only be called on the server.

saplingPackageStart​

Lifecycle
</>
LifelikeCharactersService.saplingPackageStart() → ()

Lifecycle function called by sapling to setup the package.

Show raw api
{
    "functions": [
        {
            "name": "getClient",
            "desc": "Returns the client API. This can only be called on the client.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "LifelikeCharactersServiceClient"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 25,
                "path": "packages/lifelikeCharactersService/source/init.luau"
            }
        },
        {
            "name": "getServer",
            "desc": "Returns the server API. This can only be called on the server.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "LifelikeCharactersServiceServer"
                }
            ],
            "function_type": "static",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 36,
                "path": "packages/lifelikeCharactersService/source/init.luau"
            }
        },
        {
            "name": "saplingPackageStart",
            "desc": "Lifecycle function called by sapling to setup the package.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "tags": [
                "Lifecycle"
            ],
            "source": {
                "line": 45,
                "path": "packages/lifelikeCharactersService/source/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "LifelikeCharactersService",
    "desc": "A simple package to automatically bring characters to life by doing the following:\n- Better footstep sounds\n- Seeing your body in first person\n- Head following camera angle in first & third person.",
    "source": {
        "line": 17,
        "path": "packages/lifelikeCharactersService/source/init.luau"
    }
}