Skip to main content

Highlight

Properties​

Position​

</>
Highlight.Position: Vector2

The Grid position of the Highlight.

Size​

</>
Highlight.Size: Vector2

The Grid size of the Highlight.

Color​

</>
Highlight.Color: Color3

The color of the Highlight.

ItemManager​

This item is read only and cannot be modified. Read Only
</>
Highlight.ItemManager: ItemManagerObject

The current ItemManager that the Highlight effects. Change via Highlight:SetItemManager().

ItemManagerChanged​

This item is read only and cannot be modified. Read OnlySignal
</>
Highlight.ItemManagerChanged: RBXScriptSignal

An event signal that fires every time the ItemManager is switched.

Functions​

new​

</>
Highlight.new(properties: Types.HighlightProperties) → Types.HighlightObject

Creates a new Highlight object

SetItemManager​

</>
Highlight:SetItemManager(
priority: number,
itemManager: Types.ItemManagerObject
) → ()

Change the ItemManager that the Highlight effects.

Destroy​

</>
Highlight:Destroy() → ()

Destroy the Highlight object.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new Highlight object",
            "params": [
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "Types.HighlightProperties"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.HighlightObject\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "src/Highlight.lua"
            }
        },
        {
            "name": "SetItemManager",
            "desc": "Change the ItemManager that the Highlight effects.",
            "params": [
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "itemManager",
                    "desc": "",
                    "lua_type": "Types.ItemManagerObject"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 81,
                "path": "src/Highlight.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroy the Highlight object.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/Highlight.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Position",
            "desc": "The Grid position of the Highlight.",
            "lua_type": "Vector2",
            "source": {
                "line": 21,
                "path": "src/Highlight.lua"
            }
        },
        {
            "name": "Size",
            "desc": "The Grid size of the Highlight.",
            "lua_type": "Vector2",
            "source": {
                "line": 27,
                "path": "src/Highlight.lua"
            }
        },
        {
            "name": "Color",
            "desc": "The color of the Highlight.",
            "lua_type": "Color3",
            "source": {
                "line": 33,
                "path": "src/Highlight.lua"
            }
        },
        {
            "name": "ItemManager",
            "desc": "The current ItemManager that the Highlight effects. Change via `Highlight:SetItemManager()`.",
            "lua_type": "ItemManagerObject",
            "readonly": true,
            "source": {
                "line": 40,
                "path": "src/Highlight.lua"
            }
        },
        {
            "name": "ItemManagerChanged",
            "desc": "An event signal that fires every time the ItemManager is switched.",
            "lua_type": "RBXScriptSignal",
            "tags": [
                "Signal"
            ],
            "readonly": true,
            "source": {
                "line": 48,
                "path": "src/Highlight.lua"
            }
        }
    ],
    "types": [],
    "name": "Highlight",
    "desc": "",
    "source": {
        "line": 15,
        "path": "src/Highlight.lua"
    }
}