Skip to main content

playerCharacterUtil

A simple utility module for working with the player's character.

Functions​

setCharacterTransparency​

</>
playerCharacterUtil.setCharacterTransparency(
playerCharacter: Model,
transparency: number
) → ()

Set's the transparency of all descendants (Baseparts and decals) in playerCharacter to transparency, except for the primary part.

distanceFromCharacter​

</>
playerCharacterUtil.distanceFromCharacter(
playerCharacter: Model?,
position: Vector3
) → number

Returns the distance from the playerCharacter's primary part to position.

If playerCharacter is nil or if the primary part doesn't exist, then this method will return math.huge.

Show raw api
{
    "functions": [
        {
            "name": "setCharacterTransparency",
            "desc": "Set's the transparency of all descendants (Baseparts and decals) in `playerCharacter` \nto `transparency`, except for the primary part.",
            "params": [
                {
                    "name": "playerCharacter",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 13,
                "path": "src/playerCharacterUtil/init.luau"
            }
        },
        {
            "name": "distanceFromCharacter",
            "desc": "Returns the distance from the `playerCharacter`'s primary part to `position`. \n\nIf `playerCharacter` is `nil` or if the primary part doesn't exist, then this method will return `math.huge`.",
            "params": [
                {
                    "name": "playerCharacter",
                    "desc": "",
                    "lua_type": "Model?"
                },
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "Vector3\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/playerCharacterUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "playerCharacterUtil",
    "desc": "A simple utility module for working with the player's character.",
    "source": {
        "line": 6,
        "path": "src/playerCharacterUtil/init.luau"
    }
}