Skip to main content

HSVColorPicker

This item only works when running on the client. Client

A HSV color picker component which can be used to select colors using an interface standard to Roblox Studio.

Functions​

new​

</>
HSVColorPicker.new() → HSVColorPicker

Creates a new color picker!

local picker = HSVColorPicker.new()
picker:SetColor(Color3.new(0.5, 0.5, 0.5))
picker.Gui.Parent = screenGui

SetSize​

</>
HSVColorPicker:SetSize(height: number) → ()

Sets the height of the HSVColorPicker. This impacts the [GetSizeValue] return size. This is a general interface to size things.

SyncValue​

</>
HSVColorPicker:SyncValue(color3Value: Color3Value) → maid

Syncs the color picker with the Color3Value.

HintBackgroundColor​

</>
HSVColorPicker:HintBackgroundColor(color: Color3) → ()

Hints what the background color of the HSVColorPicker. This impacts some UI elements to ensure proper contrast.

SetHSVColor​

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

Set the current color in HSV formet.

GetHSVColor​

</>
HSVColorPicker:GetHSVColor() → Vector3

Get the current color in HSV formet as a Vector3.

SetColor​

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

Set the current color.

GetColor​

</>
HSVColorPicker:GetColor() → Color3

Get the current color.

GetSizeValue​

</>
HSVColorPicker:GetSizeValue() → Vector3

A size value that defines the aspect ratio and size of this picker. See [SetSize]

SetTransparency​

</>
HSVColorPicker:SetTransparency(transparency: number) → ()

Sets the transparency of the color

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new color picker!\n\n```lua\nlocal picker = HSVColorPicker.new()\npicker:SetColor(Color3.new(0.5, 0.5, 0.5))\npicker.Gui.Parent = screenGui\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HSVColorPicker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "SetSize",
            "desc": "Sets the height of the HSVColorPicker. This impacts the [GetSizeValue] return\nsize. This is a general interface to size things.",
            "params": [
                {
                    "name": "height",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 88,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "SyncValue",
            "desc": "Syncs the color picker with the Color3Value.",
            "params": [
                {
                    "name": "color3Value",
                    "desc": "",
                    "lua_type": "Color3Value"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "maid"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 101,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "HintBackgroundColor",
            "desc": "Hints what the background color of the HSVColorPicker. This impacts\nsome UI elements to ensure proper contrast.",
            "params": [
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 130,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "SetHSVColor",
            "desc": "Set the current color in HSV formet.",
            "params": [
                {
                    "name": "hsvColor",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 139,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "GetHSVColor",
            "desc": "Get the current color in HSV formet as a Vector3.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "SetColor",
            "desc": "Set the current color.",
            "params": [
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 159,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "GetColor",
            "desc": "Get the current color.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 169,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "GetSizeValue",
            "desc": "A size value that defines the aspect ratio and size of this picker. See [SetSize]",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 179,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        },
        {
            "name": "SetTransparency",
            "desc": "Sets the transparency of the color",
            "params": [
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 192,
                "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HSVColorPicker",
    "desc": "A HSV color picker component which can be used to select colors using\nan interface standard to Roblox Studio.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 8,
        "path": "src/colorpicker/src/Client/HSV/HSVColorPicker.lua"
    }
}