Skip to main content

BodyColorsDataUtils

Utility to transfer and manipulate body colors for a character

Types​

BodyColorsData​

</>
interface BodyColorsData {
headColor: Color3
leftArmColor: Color3
leftLegColor: Color3
rightArmColor: Color3
rightLegColor: Color3
torsoColor: Color3
}

Represents body colors data for a humanoid

Functions​

createBodyColorsData​

</>
BodyColorsDataUtils.createBodyColorsData(bodyColorsData: any) → BodyColorsData

Creates a new BodyColorsData

isBodyColorsData​

</>
BodyColorsDataUtils.isBodyColorsData(value: any) → boolean

Returns true if it's a body color data

fromUniformColor​

</>
BodyColorsDataUtils.fromUniformColor(color3: Color3) → BodyColorsData

Creates a new BodyColorsData from a single color

fromBodyColors​

</>
BodyColorsDataUtils.fromBodyColors(bodyColors: BodyColors) → BodyColorsData

Creates a new BodyColorsData from a BodyColors instance

isDataStoreSafeBodyColorsData​

</>
BodyColorsDataUtils.isDataStoreSafeBodyColorsData(value: any) → boolean

Returns true if the data is a datastore safe body color

toDataStoreSafeBodyColorsData​

</>
BodyColorsDataUtils.toDataStoreSafeBodyColorsData(bodyColorsData: BodyColorsData) → DataStoreSafeBodyColorsData

Gets a datastore safe version of body color

fromHumanoidDescription​

</>
BodyColorsDataUtils.fromHumanoidDescription(humanoidDescription: HumanoidDescription) → BodyColorsData

Constructs a BodyColorsData from a humanoidDescription

isUniformColor​

</>
BodyColorsDataUtils.isUniformColor(bodyColorsData: BodyColorsData) → boolean

Returns if the body colors data represents one solid color for all body parts.

toBodyColors​

</>
BodyColorsDataUtils.toBodyColors(bodyColorsData: BodyColorsData) → BodyColors

Constructs a BodyColors from the bodyColorsData

applyToBodyColors​

</>
BodyColorsDataUtils.applyToBodyColors(
bodyColorsData: BodyColorsData,
bodyColors: BodyColors
) → BodyColors

Applies body colors to the actual body color property

fromAttributes​

</>
BodyColorsDataUtils.fromAttributes(instance: Instance) → BodyColorsData

Extracts body colors from attributes

setAttributes​

</>
BodyColorsDataUtils.setAttributes(
instance: Instance,
bodyColorsData: BodyColorsData
) → ()

Sets attributes to store body colors.

applyToHumanoidDescription​

</>
BodyColorsDataUtils.applyToHumanoidDescription(
bodyColorsData: BodyColorsData,
humanoidDescription: HumanoidDescription
) → BodyColors

Applies body colors to the actual body color property

Show raw api
{
    "functions": [
        {
            "name": "createBodyColorsData",
            "desc": "Creates a new BodyColorsData",
            "params": [
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "isBodyColorsData",
            "desc": "Returns true if it's a body color data",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "fromUniformColor",
            "desc": "Creates a new BodyColorsData from a single color",
            "params": [
                {
                    "name": "color3",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "fromBodyColors",
            "desc": "Creates a new BodyColorsData from a BodyColors instance",
            "params": [
                {
                    "name": "bodyColors",
                    "desc": "",
                    "lua_type": "BodyColors"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "isDataStoreSafeBodyColorsData",
            "desc": "Returns true if the data is a datastore safe body color",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 97,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "toDataStoreSafeBodyColorsData",
            "desc": "Gets a datastore safe version of body color",
            "params": [
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DataStoreSafeBodyColorsData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 112,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "fromHumanoidDescription",
            "desc": "Constructs a BodyColorsData from a humanoidDescription",
            "params": [
                {
                    "name": "humanoidDescription",
                    "desc": "",
                    "lua_type": "HumanoidDescription"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 144,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "isUniformColor",
            "desc": "Returns if the body colors data represents one solid color for all body parts.",
            "params": [
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 163,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "toBodyColors",
            "desc": "Constructs a BodyColors from the bodyColorsData",
            "params": [
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColors"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 208,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "applyToBodyColors",
            "desc": "Applies body colors to the actual body color property",
            "params": [
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "BodyColorsData"
                },
                {
                    "name": "bodyColors",
                    "desc": "",
                    "lua_type": "BodyColors"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColors"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 224,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "fromAttributes",
            "desc": "Extracts body colors from attributes",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 258,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "setAttributes",
            "desc": "Sets attributes to store body colors.",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "BodyColorsData"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 284,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        },
        {
            "name": "applyToHumanoidDescription",
            "desc": "Applies body colors to the actual body color property",
            "params": [
                {
                    "name": "bodyColorsData",
                    "desc": "",
                    "lua_type": "BodyColorsData"
                },
                {
                    "name": "humanoidDescription",
                    "desc": "",
                    "lua_type": "HumanoidDescription"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BodyColors"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 305,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "BodyColorsData",
            "desc": "Represents body colors data for a humanoid",
            "fields": [
                {
                    "name": "headColor",
                    "lua_type": "Color3",
                    "desc": ""
                },
                {
                    "name": "leftArmColor",
                    "lua_type": "Color3",
                    "desc": ""
                },
                {
                    "name": "leftLegColor",
                    "lua_type": "Color3",
                    "desc": ""
                },
                {
                    "name": "rightArmColor",
                    "lua_type": "Color3",
                    "desc": ""
                },
                {
                    "name": "rightLegColor",
                    "lua_type": "Color3",
                    "desc": ""
                },
                {
                    "name": "torsoColor",
                    "lua_type": "Color3",
                    "desc": ""
                }
            ],
            "source": {
                "line": 27,
                "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
            }
        }
    ],
    "name": "BodyColorsDataUtils",
    "desc": "Utility to transfer and manipulate body colors for a character",
    "source": {
        "line": 6,
        "path": "src/bodycolorsutils/src/Shared/BodyColorsDataUtils.lua"
    }
}