Skip to main content

HumanoidDescriptionUtils

Handles actions involving HumanoidDescription objects, including loading character appearance.

Functions​

promiseApplyDescription​

</>
HumanoidDescriptionUtils.promiseApplyDescription(
humanoid: Humanoid,
description: HumanoidDescription
) → Promise

Promises to apply a humaoid description

promiseApplyDescriptionReset​

</>
HumanoidDescriptionUtils.promiseApplyDescriptionReset(
humanoid: Humanoid,
description: HumanoidDescription,
assetTypeVerification: AssetTypeVerification
) → Promise

Promises to apply a humaoid description reset call

promiseApplyFromUserName​

</>
HumanoidDescriptionUtils.promiseApplyFromUserName(
humanoid: Humanoid,
userName: string
) → Promise

Applies humanoid description from userName.

promiseFromUserName​

</>
HumanoidDescriptionUtils.promiseFromUserName(userName: string) → Promise<HumanoidDescription>

Retrieves a humanoid description from username

promiseFromUserId​

</>
HumanoidDescriptionUtils.promiseFromUserId(userId: number) → Promise<HumanoidDescription>

Retrieves a humanoid description from userId

getAssetIdsFromString​

</>
HumanoidDescriptionUtils.getAssetIdsFromString(
assetString: string--

A comma seperated value of asset ids which should be numbers

) → {number}

Retrieves the assetIds from an assetId, in the format that is known to us.

getAssetPromisesFromString​

</>
HumanoidDescriptionUtils.getAssetPromisesFromString(
assetString: string--

A comma seperated value of asset ids which should be numbers

) → {Promise<Instance>}
Show raw api
{
    "functions": [
        {
            "name": "promiseApplyDescription",
            "desc": "Promises to apply a humaoid description",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "description",
                    "desc": "",
                    "lua_type": "HumanoidDescription"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        },
        {
            "name": "promiseApplyDescriptionReset",
            "desc": "Promises to apply a humaoid description reset call",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "description",
                    "desc": "",
                    "lua_type": "HumanoidDescription"
                },
                {
                    "name": "assetTypeVerification",
                    "desc": "",
                    "lua_type": "AssetTypeVerification"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        },
        {
            "name": "promiseApplyFromUserName",
            "desc": "Applies humanoid description from userName.",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "userName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        },
        {
            "name": "promiseFromUserName",
            "desc": "Retrieves a humanoid description from username",
            "params": [
                {
                    "name": "userName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<HumanoidDescription>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        },
        {
            "name": "promiseFromUserId",
            "desc": "Retrieves a humanoid description from userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<HumanoidDescription>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        },
        {
            "name": "getAssetIdsFromString",
            "desc": "Retrieves the assetIds from an assetId, in the format that is known to us.",
            "params": [
                {
                    "name": "assetString",
                    "desc": "A comma seperated value of asset ids which should be numbers",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ number }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 117,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        },
        {
            "name": "getAssetPromisesFromString",
            "desc": "From stuff like [HumanoidDescription.HatAccessory].",
            "params": [
                {
                    "name": "assetString",
                    "desc": "A comma seperated value of asset ids which should be numbers",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Promise<Instance> }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 140,
                "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HumanoidDescriptionUtils",
    "desc": "Handles actions involving HumanoidDescription objects, including loading character appearance.",
    "source": {
        "line": 5,
        "path": "src/humanoiddescriptionutils/src/Shared/HumanoidDescriptionUtils.lua"
    }
}