Skip to main content

HSColorPicker

This item only works when running on the client. Client

Picker for hue and Saturation in HSV. See HSVColorPicker for the full color picker, which also allows you to select "Value".

Functions​

new​

</>
HSColorPicker.new() → HSColorPicker

ObserveIsPressed​

</>
HSColorPicker.ObserveIsPressed(self: HSColorPicker) → BoolValue

Gets whether the color picker is pressed or not.

SetHSVColor​

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

Sets the HSVColor as a Vector3

GetHSVColor​

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

Gets the color as an HSV Vector3

SetColor​

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

Sets the color

GetColor​

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

Gets the color

GetSizeValue​

</>
HSColorPicker.GetSizeValue(self: HSColorPicker) → Vector3

Gets the size value for the HSColorPicker.

SetTransparency​

</>
HSColorPicker.SetTransparency(
transparency: number
) → ()

Sets the transparency of the HSColorPicker

SetSize​

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

Sets the size of the color picker. This is in "line height" units.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HSColorPicker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "ObserveIsPressed",
            "desc": "Gets whether the color picker is pressed or not.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BoolValue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 104,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetHSVColor",
            "desc": "Sets the HSVColor as a Vector3",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                },
                {
                    "name": "hsvColor",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 123,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "GetHSVColor",
            "desc": "Gets the color as an HSV Vector3",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 133,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetColor",
            "desc": "Sets the color",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 142,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "GetColor",
            "desc": "Gets the color",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 152,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "GetSizeValue",
            "desc": "Gets the size value for the HSColorPicker.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 163,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetTransparency",
            "desc": "Sets the transparency of the HSColorPicker",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                },
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 176,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetSize",
            "desc": "Sets the size of the color picker. This is in \"line height\" units.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPicker"
                },
                {
                    "name": "height",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 187,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HSColorPicker",
    "desc": "Picker for hue and Saturation in HSV. See [HSVColorPicker] for the full color picker,\nwhich also allows you to select \"Value\".",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 9,
        "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
    }
}