💻ui

Example available!

Functions:

get_alpha

ui.get_alpha(): number

Returns the menu opacity as a unit interval (value in the range [0, 1]).

get_size

ui.get_size(): vector

Returns the current menu size.

get_position

ui.get_position(): vector

Returns the current menu position.

get_mouse_position

ui.get_mouse_position(): vector

Returns the current mouse position.

get_binds

ui.get_binds(): table

Returns a table of pointers to hotkeys.

struct Hotkey

get_style

ui.get_style([ name: string ]): color / table

Returns the color of the Style Option. Pass nil to return a table with the style options.

get_icon

ui.get_icon(name: string): string

Returns the unicode converted string corresponding the fontawesome icon.

create

find

This can return multiple items or nil on failure.

sidebar

ui.sidebar([name: string, icon_name: string]): string, string

Gets or sets the sidebar tab name and an icon.

localize

ui.localize(lang: string, str: string[, localized: string]): string / nil

Returns the localized string for the specified language code. If localized is present, the str will be localized accordingly.

🔗 MenuGroup

:switch

group:switch(name: string[, init: boolean]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:slider

group:slider(name: string, min: number, max: number[, init: number, scale: number, tooltip: function]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:combo

group:combo(name: string, items: any[, ...]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:selectable

group:selectable(name: string, items: any[, ...]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:color_picker

Creates and returns a menu item object, or throws an error on failure.

:button

group:button(name: string[, callback: function, alt_style: boolean]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:hotkey

group:hotkey(name: string[, default_key: number): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:input

group:input(name: string[, text: string]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:list

group:list(name: string, items: any[, ...]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:listable

group:listable(name: string, items: any[, ...]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:label

group:label(text: string): MenuItem

Creates and returns a menu item object, or throws an error on failure.

:texture

📌 Create the texture via the :load_image function.

group:texture(texture: ImgObject[, size: vector, color: color, mode: string, rounding: number]): MenuItem

Creates and returns a menu item object, or throws an error on failure.

🔗 MenuItem

:get

item:get(): any

Returns the value of the menu item.

:id

item:id(): number

Returns the unique id of the menu item.

:list

item:list(): table

Returns the list of items. combo / selectable menu item objects only.

:type

item:type(): string

Returns the type of the menu item.

:override

item:override(value: any[, ...])

Overrides the item value without changing the menu / config values. If the value argument is nil or missing, the override is undone.

:get_override

item:get_override(): any

Returns the value of the menu item it's overriden to.

:update

item:update(...)

Updates the values of the menu item.

:reset

item:reset()

Resets the menu item to it's original value.

:set

item:set(value: any[, ...])

Sets the value of the menu item.

:name

item:name([value: any])

Gets or sets the name of the menu item.

:tooltip

item:tooltip([value: any])

Gets or sets the tooltip of the menu item (depending on the presence of the value parameter).

:visibility

item:visibility([state: boolean])

Gets or sets the menu item visibility depending on the value of state.

:disabled

item:disabled([state: boolean])

Gets or sets the menu item disabled state depending on the value of state.

:set_callback

item:set_callback(callback: function[, force_call: boolean])

Sets the callback to the specified menu item.

:unset_callback

item:unset_callback(callback: function)

Unsets the callback that was set via the :set_callback function.

:color_picker

Attaches a color picker to the current menu item object.

:create

item:create(): MenuGroup

Attaches a group (gear) to the current menu item object.

:parent

item:parent(): MenuItem / MenuGroup

Returns the parent object of the menu item.