Skip to main content

playerCharacterAccessoryUtil

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

Functions​

accessories​

</>
playerCharacterAccessoryUtil.accessories(
playerCharacter: Model,
accessoryType: Enum.AccessoryType
) → {Accessory}

Returns an array of all accessories of type accesstoryType in playerCharacter.

Show raw api
{
    "functions": [
        {
            "name": "accessories",
            "desc": " \nReturns an array of all accessories of type `accesstoryType` in `playerCharacter`.",
            "params": [
                {
                    "name": "playerCharacter",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "accessoryType",
                    "desc": "",
                    "lua_type": "Enum.AccessoryType\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Accessory }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 12,
                "path": "src/playerCharacterAccessoryUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "playerCharacterAccessoryUtil",
    "desc": "A simple utility module for working with the player's character's accessories.",
    "source": {
        "line": 6,
        "path": "src/playerCharacterAccessoryUtil/init.luau"
    }
}