Menu Library

Menu Library

Menu.lua is an easy-to-use Menu Library for Lmaobox. It allows you to create interactive menus for your scripts to configure and customize your features. Please note that you only have to create the menus and components once (when initializing your script for example) and do not need to call it in the Draw or CreateMove callback. You can find an example script here

If you want to use the Color Picker then you'll need to place GradientMask.png inside the Textures folder in %localappdata%! You can find it in Lmaobox-LUA/Menu/Textures and it should be available under %localappdata%/Textures/GradientMask.png.

Usage

Place the Menu.lua in the same folder as your script and load the Menu module at the beginning of you script using:

local MenuLib = require("Menu")

If you want to make your Menus optional, independant from Menu.lua, then you can do this:

local menuLoaded, MenuLib = pcall(require, "Menu")
if (menuLoaded) then
  -- Your menu code here
end

After you've loaded the Menu module, you can create a new Menu (flags are optional):

local menu = MenuLib.Create("Title", flags)

...and add your components:

[Menu]:AddComponent(<Component>)

If you want to remove a menu again, use:

MenuLib.RemoveMenu(<Menu>)

Components

The Menu Library allows you to use various UI components that are already fully implemented and working. But you can also create your own components if you want.

Label

Simple label with a given text.

MenuLib.Label("Text")

Checkbox

Allows you to toggle between on/off.

MenuLib.Checkbox("Label", value)
[Checkbox]:GetValue() -- Current state (bool)
[Checkbox]:IsChecked() -- Is the checkbox checked? (bool)

Button

Runs a given callback when the button is being pressed.

MenuLib.Button("Label", callback)

Slider

Allows you to select a value between a given minimum and maximum

MenuLib.Slider("Label", min, max, value)
[Slider]:GetValue() -- Current value (number)

Textbox

Allows you to enter a text. It's very basic though and only allows a small set of characters.

MenuLib.Textbox("Label", value)
[Textbox]:GetValue() -- Current text (string)

Keybind

Allows you to enter a keybind.

MenuLib.Keybind("Label", key)
[Keybind]:GetValue() -- Current key (number)

Color Picker

Allows you to easily pick a color. Requires GradientMask.png

MenuLib.Colorpicker("Label", color)
[Colorpicker]:GetColor() -- Returns the selected color (table)

Color format: { 255, 0, 0, 255 } or { 255, 0, 0 }

Combobox

Allows you to select one of many given options in a dropdown.

local combo = {
  "Option 1",
  "Option 2",
  [...]
}
MenuLib.Combo("Label", combo)
[Combo]:Select(index) -- Selects item at index
[Combo]:GetSelectedIndex() -- Selected item index (number)
[Combo]:IsSelected(option) -- Returns wether the option is selected (bool)

Multi Combobox

Allows you to select multiple options in a dropdown.

local multiCombo = {
  ["Option 1"] = true,
  ["Options 2"] = false,
  ["Options 3"] = true
  [...]
}
MenuLib.MultiCombo("Label", multiCombo)
[MultiCombo]:Select(index) -- Selects option by name
[MultiCombo]:IsSelected(option) -- Returns wether the option is selected (bool)
[MultiCombo].Options -- Table of options and their current state (string, bool)

Menu

A window that contains components

[Menu]:SetTitle(title) -- Sets the window title
[Menu]:SetPosition(x, y) -- Sets the window position
[Menu]:SetSize(width, height) -- Sets the window size
[Menu]:AddComponent(component) -- Adds the given component to the menu
[Menu]:RemoveComponent(component) -- Removes a given component from the menu

Properties for all components and menus:

[Element].Visible
[Element].ID
[Element]:SetVisible(state)

You can access and change the menu style using [Menu].Style:

Style.Space = 4,
Style.Font = draw.CreateFont("Verdana", 14, 510),
Style.Outline = false,
Style.WindowBg = { 30, 30, 30, 255 },
Style.TitleBg = { 55, 100, 215, 255 },
Style.Text = { 255, 255, 255, 255 },
Style.Item = { 50, 50, 50, 255 },
Style.ItemHover = { 65, 65, 65, 255 },
Style.ItemActive = { 80, 80, 80, 255 },
Style.Highlight = { 180, 180, 180, 100 }

Example menu style

Flags

Flags allow you to modify the drawing of windows. Here's an example on using flags:

Menus.Create("Flag Menu", MenuFlags.NoTitle | MenuFlags.NoDrag)

Available flags: Menu Flags:

MenuFlags.NoTitle -- No title bar
MenuFlags.NoBackground -- No window background
MenuFlags.NoDrag -- Disable dragging
MenuFlags.AutoSize -- Auto size height to contents
MenuFlags.ShowAlways -- Show menu when ingame

Component Flags:

ItemFlags.FullWidth -- Fill width of menu
ItemFlags.Active -- Item is always active

Have fun creating menus!