Skip to main content

HSColorPickerCursor

The actual cursor for the HSV (it's a plus). See HSVColorPicker.

Functions​

HintBackgroundColor​

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

Hints the background color so contrast can be set appropriately.

SetHeight​

</>
HSColorPickerCursor.SetHeight(
height: number
) → ()

Sets the size of the cursor.

SetPosition​

</>
HSColorPickerCursor.SetPosition(
position: Vector2
) → ()

Sets the Vector2 position in scale (from 0 to 1).

GetPosition​

</>
HSColorPickerCursor.GetPosition(self: HSColorPickerCursor) → Vector2

Gets the position of the cursor in scale

SetTransparency​

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

Sets the transparency of the cusor

Show raw api
{
    "functions": [
        {
            "name": "HintBackgroundColor",
            "desc": "Hints the background color so contrast can be set appropriately.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPickerCursor"
                },
                {
                    "name": "color",
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/colorpicker/src/Client/Cursor/HSColorPickerCursor.lua"
            }
        },
        {
            "name": "SetHeight",
            "desc": "Sets the size of the cursor.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPickerCursor"
                },
                {
                    "name": "height",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/colorpicker/src/Client/Cursor/HSColorPickerCursor.lua"
            }
        },
        {
            "name": "SetPosition",
            "desc": "Sets the Vector2 position in scale (from 0 to 1).",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPickerCursor"
                },
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 88,
                "path": "src/colorpicker/src/Client/Cursor/HSColorPickerCursor.lua"
            }
        },
        {
            "name": "GetPosition",
            "desc": "Gets the position of the cursor in scale",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPickerCursor"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 99,
                "path": "src/colorpicker/src/Client/Cursor/HSColorPickerCursor.lua"
            }
        },
        {
            "name": "SetTransparency",
            "desc": "Sets the transparency of the cusor",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "HSColorPickerCursor"
                },
                {
                    "name": "transparency",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/colorpicker/src/Client/Cursor/HSColorPickerCursor.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HSColorPickerCursor",
    "desc": "The actual cursor for the HSV (it's a plus). See [HSVColorPicker].",
    "source": {
        "line": 7,
        "path": "src/colorpicker/src/Client/Cursor/HSColorPickerCursor.lua"
    }
}