Skip to main content

Character

This item only works when running on the client. Client

A table of utility functions for working with the Character that can be used to speed up the process of writing repository scripts for client objects.

Functions​

getHitbox​

</>
Character.getHitbox(
mode: HitboxModes,
params: OverlapParams?
) → {BasePart}

Returns a static hitbox attached to the character based on the provided mode. See the documentation on hitbox modes for more information.

takeDamage​

</>
Character.takeDamage(damage: BasePart | number | string) → ()

See CharacterManager for more info.

validateDamageBrick​

</>
Character.validateDamageBrick(brick: BasePart) → (string | number)?

See CharacterManager for more info.

getHumanoid​

</>
Character.getHumanoid() → Humanoid?

See CharacterManager for more info.

changeHumanoidProperty​

</>
Character.changeHumanoidProperty(
property: string,
value: any,
tweenInfo: TweenInfo?
) → ()

See CharacterManager for more info.

startBoost​

</>
Character.startBoost(boostData: CharacterManager_Types.BoostData) → ()

See CharacterManager for more info.

removeBoost​

</>
Character.removeBoost(boostData: CharacterManager_Types.BoostData) → ()

See CharacterManager for more info.

getActiveBoosts​

</>
Character.getActiveBoosts() → {CharacterManager_Types.BoostData}

See CharacterManager for more info.

getActiveBoost​

</>
Character.getActiveBoost(
boostType: string,
isPad: boolean?
) → CharacterManager_Types.BoostData?

See CharacterManager for more info.

getBoostModule​

</>
Character.getBoostModule(boostType: string) → CharacterManager_Types.Boost?

See CharacterManager for more info.

carryPart​

</>
Character.carryPart(
weldState: boolean,
weldTo: BasePart,
animationDisabled: boolean
) → ()

Makes the character carry the weldTo part, welding it to the character and displaying a carry animation on the character. The carry animation manipulates the character's shoulders directly instead of using an AnimationTrack.

If weldState is false, the character will stop carrying the part and the carry animation will stop.

getCharacter​

</>
Character.getCharacter() → ()

Returns a table of character instances, such as:

  • The Character itself
  • The Character's humanoid
  • The Character's RootPart
  • The Character's PrimaryPart

When the character respawns, all of the values will update accordingly.

Show raw api
{
    "functions": [
        {
            "name": "getHitbox",
            "desc": "Returns a static hitbox attached to the character based on the provided `mode`.\nSee [the documentation on hitbox modes](/docs/misc#hitbox-modes) for more information.",
            "params": [
                {
                    "name": "mode",
                    "desc": "",
                    "lua_type": "HitboxModes"
                },
                {
                    "name": "params",
                    "desc": "",
                    "lua_type": "OverlapParams?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ BasePart }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "takeDamage",
            "desc": "See [CharacterManager](/api/CharacterManager#Damage) for more info.",
            "params": [
                {
                    "name": "damage",
                    "desc": "",
                    "lua_type": "BasePart | number | string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 84,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "validateDamageBrick",
            "desc": "See [CharacterManager](/api/CharacterManager#ValidateDamageBrick) for more info.",
            "params": [
                {
                    "name": "brick",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(string | number)?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "getHumanoid",
            "desc": "See [CharacterManager](/api/CharacterManager#GetHumanoid) for more info.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Humanoid?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 102,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "changeHumanoidProperty",
            "desc": "See [CharacterManager](/api/CharacterManager#ChangeHumanoidProperty) for more info.",
            "params": [
                {
                    "name": "property",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "tweenInfo",
                    "desc": "",
                    "lua_type": "TweenInfo?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 111,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "startBoost",
            "desc": "See [CharacterManager](/api/CharacterManager#StartBoost) for more info.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 120,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "removeBoost",
            "desc": "See [CharacterManager](/api/CharacterManager#RemoveBoost) for more info.",
            "params": [
                {
                    "name": "boostData",
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 129,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "getActiveBoosts",
            "desc": "See [CharacterManager](/api/CharacterManager#GetActiveBoosts) for more info.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ CharacterManager_Types.BoostData }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 138,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "getActiveBoost",
            "desc": "See [CharacterManager](/api/CharacterManager#GetActiveBoost) for more info.",
            "params": [
                {
                    "name": "boostType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "isPad",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CharacterManager_Types.BoostData?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "getBoostModule",
            "desc": "See [CharacterManager](/api/CharacterManager#GetActiveBoost) for more info.",
            "params": [
                {
                    "name": "boostType",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CharacterManager_Types.Boost?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 156,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "carryPart",
            "desc": "Makes the character carry the `weldTo` part, welding it to the character\nand displaying a carry animation on the character. The carry animation\nmanipulates the character's shoulders directly instead of using an\nAnimationTrack.\n\nIf `weldState` is `false`, the character will stop carrying the part and\nthe carry animation will stop.",
            "params": [
                {
                    "name": "weldState",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "weldTo",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "animationDisabled",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 175,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        },
        {
            "name": "getCharacter",
            "desc": "Returns a table of character instances, such as:\n- The Character itself\n- The Character's humanoid\n- The Character's RootPart\n- The Character's PrimaryPart\n\nWhen the character respawns, all of the values will update accordingly.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 279,
                "path": "mirror/Kit.Utility.Character.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Character",
    "desc": "A table of utility functions for working with the Character that can be used to speed up the process of writing repository scripts for client objects.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 12,
        "path": "mirror/Kit.Utility.Character.luau"
    }
}