Skip to main content

HSColorPicker

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

Functions​

ObserveIsPressed​

</>
HSColorPicker:ObserveIsPressed() → BoolValue

Gets whether the color picker is pressed or not.

SetHSVColor​

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

Sets the HSVColor as a Vector3

GetHSVColor​

</>
HSColorPicker:GetHSVColor() → Vector3

Gets the color as an HSV Vector3

SetColor​

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

Sets the color

GetColor​

</>
HSColorPicker:GetColor() → Color3

Gets the color

GetSizeValue​

</>
HSColorPicker:GetSizeValue() → 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": "ObserveIsPressed",
            "desc": "Gets whether the color picker is pressed or not.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BoolValue"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 81,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetHSVColor",
            "desc": "Sets the HSVColor as a Vector3",
            "params": [
                {
                    "name": "hsvColor",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 100,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "GetHSVColor",
            "desc": "Gets the color as an HSV Vector3",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetColor",
            "desc": "Sets the color",
            "params": [
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 119,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "GetColor",
            "desc": "Gets the color",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 129,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "GetSizeValue",
            "desc": "Gets the size value for the HSColorPicker.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 140,
                "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
            }
        },
        {
            "name": "SetTransparency",
            "desc": "Sets the transparency of the HSColorPicker",
            "params": [
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 153,
                "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": "height",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 164,
                "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\".",
    "source": {
        "line": 7,
        "path": "src/colorpicker/src/Client/HSV/HSColorPicker.lua"
    }
}