Skip to main content

NeoHotbar

Functions​

Start​

</>
NeoHotbar:Start() → ()

Initializes NeoHotbar and deploys its UI with default settings.

SetEnabled​

</>
NeoHotbar:SetEnabled(
Enabled: boolean--

Whether or not to enable NeoHotbar.

) → ()

Sets whether NeoHotbar or not is enabled. Disabling hides the hotbar and turns off keybinds.

SetToolTipsEnabled​

</>
NeoHotbar:SetToolTipsEnabled(
Enabled: boolean--

Whether or not to enable.

) → ()

Sets whether or not ToolTips are enabled.

SetManagementEnabled​

</>
NeoHotbar:SetManagementEnabled(
Enabled: boolean--

Whether or not to enable.

) → ()

Sets whether or not players can rearrange the tools in their hotbar.

SetContextMenuEnabled​

</>
NeoHotbar:SetContextMenuEnabled(
Enabled: boolean--

Whether or not to enable.

) → ()

Sets whether or not players can open the context menu. (the one that appears when you right click on a tool)

OverrideGui​

</>
NeoHotbar:OverrideGui(
CustomGuiSet: Folder,--

The parent folder containing your custom Gui objects.

DefaultEffectsEnabled: boolean?--

Whether or not to enable NeoHotbar's built-in UI effects. Not compatible with ultra-customized themes.

) → ()

Overrides NeoHotbar's UI with a new set of Gui objects.

ResetGui​

</>
NeoHotbar:ResetGui() → ()

Reset NeoHotbar's UI back to the default.

AddCustomButton​

</>
NeoHotbar:AddCustomButton(
ButtonName: string,--

The name/identifier of the button to be added.

IconImage: string,--

The image URI to be used on the button icon. E.g. "rbxassetid://".

Callback: any,--

The function called upon button activation (click/touch/etc).

GamepadKeybind: EnumItem?--

A gamepad keycode to trigger your custom button.

) → ()

Adds a custom button to the hotbar, prepended to the left-most side.

RemoveCustomButton​

</>
NeoHotbar:RemoveCustomButton(
ButtonName: string--

The name of the button to be removed.

) → ()

Removes the specified custom button from the hotbar.

FindCustomButton​

</>
NeoHotbar:FindCustomButton(
ButtonName: string--

The name of the button to be searched for.

) → ()

Returns the specified custom button if found.

Show raw api
{
    "functions": [
        {
            "name": "Start",
            "desc": "Initializes NeoHotbar and deploys its UI with default settings.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 27,
                "path": "src/init.lua"
            }
        },
        {
            "name": "SetEnabled",
            "desc": "Sets whether NeoHotbar or not is enabled. Disabling hides the hotbar and turns off keybinds.",
            "params": [
                {
                    "name": "Enabled",
                    "desc": "Whether or not to enable NeoHotbar.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 113,
                "path": "src/init.lua"
            }
        },
        {
            "name": "SetToolTipsEnabled",
            "desc": "Sets whether or not ToolTips are enabled.",
            "params": [
                {
                    "name": "Enabled",
                    "desc": "Whether or not to enable.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 132,
                "path": "src/init.lua"
            }
        },
        {
            "name": "SetManagementEnabled",
            "desc": "Sets whether or not players can rearrange the tools in their hotbar.",
            "params": [
                {
                    "name": "Enabled",
                    "desc": "Whether or not to enable.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 148,
                "path": "src/init.lua"
            }
        },
        {
            "name": "SetContextMenuEnabled",
            "desc": "Sets whether or not players can open the context menu. *(the one that appears when you right click on a tool)*",
            "params": [
                {
                    "name": "Enabled",
                    "desc": "Whether or not to enable.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 164,
                "path": "src/init.lua"
            }
        },
        {
            "name": "OverrideGui",
            "desc": "Overrides NeoHotbar's UI with a new set of Gui objects.",
            "params": [
                {
                    "name": "CustomGuiSet",
                    "desc": "The parent folder containing your custom Gui objects.",
                    "lua_type": "Folder"
                },
                {
                    "name": "DefaultEffectsEnabled",
                    "desc": "Whether or not to enable NeoHotbar's built-in UI effects. Not compatible with ultra-customized themes.",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 181,
                "path": "src/init.lua"
            }
        },
        {
            "name": "ResetGui",
            "desc": "Reset NeoHotbar's UI back to the default.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 202,
                "path": "src/init.lua"
            }
        },
        {
            "name": "AddCustomButton",
            "desc": "Adds a custom button to the hotbar, prepended to the left-most side.",
            "params": [
                {
                    "name": "ButtonName",
                    "desc": "The name/identifier of the button to be added.",
                    "lua_type": "string"
                },
                {
                    "name": "IconImage",
                    "desc": "The image URI to be used on the button icon. E.g. \"rbxassetid://\".",
                    "lua_type": "string"
                },
                {
                    "name": "Callback",
                    "desc": "The function called upon button activation (click/touch/etc).",
                    "lua_type": "any"
                },
                {
                    "name": "GamepadKeybind",
                    "desc": "A gamepad keycode to trigger your custom button.",
                    "lua_type": "EnumItem?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 222,
                "path": "src/init.lua"
            }
        },
        {
            "name": "RemoveCustomButton",
            "desc": "Removes the specified custom button from the hotbar.",
            "params": [
                {
                    "name": "ButtonName",
                    "desc": "The name of the button to be removed.",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 254,
                "path": "src/init.lua"
            }
        },
        {
            "name": "FindCustomButton",
            "desc": "Returns the specified custom button if found.",
            "params": [
                {
                    "name": "ButtonName",
                    "desc": "The name of the button to be searched for.",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 279,
                "path": "src/init.lua"
            }
        },
        {
            "name": "_CreateGui",
            "desc": "Builds NeoHotbar's UI. Only intended for internal use.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 290,
                "path": "src/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "NeoHotbar",
    "desc": "",
    "source": {
        "line": 19,
        "path": "src/init.lua"
    }
}