Skip to main content

ValueColorPicker

This item only works when running on the client. Client

Picker for value in HSV. See HSVColorPicker for usage.

Functions​

SetSize​

</>
ValueColorPicker.SetSize(
height: number
) → ()

Sets the size (height) of the value color picker

HintBackgroundColor​

</>
ValueColorPicker.HintBackgroundColor(
color: Color3
) → ()

Hints what the background color should be to ensure contrast

SetHSVColor​

</>
ValueColorPicker.SetHSVColor(
hsvColor: Vector3
) → ()

Sets the HSV Color for the value picker

GetHSVColor​

</>
ValueColorPicker.GetHSVColor(self: ValueColorPicker) → Vector3

Returns the HSV color3

SetColor​

</>
ValueColorPicker.SetColor(
color: Color3
) → ()

Setes the current color

GetColor​

</>
ValueColorPicker.GetColor(self: ValueColorPicker) → Color3

Gets the current color

Show raw api
{
    "functions": [
        {
            "name": "SetSize",
            "desc": "Sets the size (height) of the value color picker",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ValueColorPicker"
                },
                {
                    "name": "height",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 139,
                "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
            }
        },
        {
            "name": "HintBackgroundColor",
            "desc": "Hints what the background color should be to ensure contrast",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ValueColorPicker"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 150,
                "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
            }
        },
        {
            "name": "SetHSVColor",
            "desc": "Sets the HSV Color for the value picker",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ValueColorPicker"
                },
                {
                    "name": "hsvColor",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 163,
                "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
            }
        },
        {
            "name": "GetHSVColor",
            "desc": "Returns the HSV color3",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ValueColorPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 174,
                "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
            }
        },
        {
            "name": "SetColor",
            "desc": "Setes the current color",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ValueColorPicker"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 183,
                "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
            }
        },
        {
            "name": "GetColor",
            "desc": "Gets the current color",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "ValueColorPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 191,
                "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ValueColorPicker",
    "desc": "Picker for value in HSV. See [HSVColorPicker] for usage.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 8,
        "path": "src/colorpicker/src/Client/HSV/ValueColorPicker.lua"
    }
}