Neverlose
Ask or search…
⌃K
Comment on page
💻

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

Name
Type
Description
name
string
Hotkey name
mode
number
Hotkey mode (1: Hold, 2: Toggle)
value
any
Hotkey value
active
boolean
Hotkey state
reference
MenuItem
Pointer to the menu item

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

Group
Tab
ui.create(group: string): MenuGroup
Name
Type
Description
group
string
Group name
Creates and returns a menu group object.
ui.create(tab: string, group: string[, column: number]): MenuGroup
Name
Type
Description
tab
string
Tab name
group
string
Group name
column
number
Optional. Column ID (1: Left 2: Right or nil for automatic alignment.)
Creates and returns a menu group object.

find

Item example
Sub-item example
Group example
Global item example
ESP Item Example
ui.find(category: string, tab: string, group: string, item: string): MenuItem
Name
Type
Description
category
string
Category name, e.g. "Aimbot" or "Visuals".
tab
string
Tab name that belongs to the category.
group
string
Name of group with the item.
item
string
The needed item.
Returns the MenuItem object that corresponds to the specified path.
​
ui.find(category: string, tab: string, sub_tab: string, group: string, item: string): MenuItem
Name
Type
Description
category
string
Category name, e.g. "Aimbot" or "Visuals".
tab
string
Tab name that belongs to the category.
sub_tab
string
Sub-tab name.
group
string
Name of group with the item.
item
string
The needed item.
Returns the MenuItem object that corresponds to the specified path.
ui.find(category: string, tab: string, group: string, item: string, sub_item): MenuItem
Name
Type
Description
category
string
Category name, e.g. "Aimbot" or "Visuals".
tab
string
Tab name that belongs to the category.
group
string
Name of group with the item.
item
string
The item with a group (gear) attached.
sub_item
string
The sub-item in the item group.
Returns the MenuItem object that corresponds to the specified path.
​
ui.find(category: string, tab: string, sub_tab: string, group: string, item: string, sub_item): MenuItem
Name
Type
Description
category
string
Category name, e.g. "Aimbot" or "Visuals".
tab
string
Tab name that belongs to the category.
sub_tab
string
Sub-tab name.
group
string
Name of group with the item.
item
string
The item with a group (gear) attached.
sub_item
string
The sub-item in the item group.
Returns the MenuItem object that corresponds to the specified path.
ui.find(category: string, tab: string, group: string): MenuGroup
Name
Type
Description
category
string
Category name, e.g. "Aimbot" or "Visuals".
tab
string
Tab name that belongs to the category.
group
string
Name of the needed group.
Returns the MenuGroup object that corresponds to the specified path.
​
ui.find(category: string, tab: string, sub_tab_name: string, group: string): MenuGroup
Name
Type
Description
category
string
Category name, e.g. "Aimbot" or "Visuals".
tab
string
Tab name that belongs to the category.
sub_tab
string
Sub-tab name.
group
string
Name of the needed group.
ui.find(group_name: string, item_name: string): MenuItem
Name
Type
Description
group_name
string
Global group name, e.g. "Settings".
item_name
string
Item name, e.g. "Dpi Scale".
Returns the MenuItem object that corresponds to the specified path.
ui.find(category: string, tab: string, sub_tab: string, group: string, item_category: string, item: string): ESPGroup
Name
Type
Description
category
string
​
tab
string
​
sub_tab
string
​
group
string
​
item_category
string
​
item
string
​
Returns the ESPGroup object that corresponds to the specified path.
This can return multiple items or nil on failure.
ui.sidebar([name: string, icon_name: string]): string, string
Name
Type
Description
name
string
Optional. Sidebar tab name
icon_name
string
Optional. Icon name (Brand icons are currently not supported)
Gets or sets the sidebar tab name and an icon.

localize

ui.localize(lang: string, str: string[, localized: string]): string / nil
Name
Type
Description
lang
string
Language code.
str
string
String to localize or to get the localized string from.
localized
string
Optional. The localized variant.
Returns the localized string for the specified language code. If localized is present, the str will be localized accordingly.

:switch

group:switch(name: string[, init: boolean]): MenuItem
Name
Type
Description
name
string
Item name
init
boolean
Default value
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
Name
Type
Description
name
string
Item name
min
number
Minimum allowed value
max
number
Maximum allowed value
init
number
Default value
scale
number
Display value multiplier. Can be used for decimal places.
tooltip
string / function
A string appends itself to the display value. A function allows you to access the raw display value and displays anything it returns.
Creates and returns a menu item object, or throws an error on failure.

:combo

group:combo(name: string, items: any[, ...]): MenuItem
Name
Type
Description
name
string
Item name
items
any
One or more comma separated values that will be added to the combo. Alternatively, a table of strings that will be added
...
​
​
Creates and returns a menu item object, or throws an error on failure.

:selectable

group:selectable(name: string, items: any[, ...]): MenuItem
Name
Type
Description
name
string
Item name
items
any
One or more comma separated values that will be added to the combo. Alternatively, a table of strings that will be added
...
​
​
Creates and returns a menu item object, or throws an error on failure.

:color_picker

Simple
Multi-Color
group:color_picker(name: string[, color: color]): MenuItem
Name
Type
Description
name
string
Item name
color
color
Optional. Initial color value
group:color_picker(name: string, colors: table): MenuItem
Name
Type
Description
name
string
Item name
colors
table
Table containing tables with a string index, and those tables should contain one or multiple color objects. Check UI examples.
Creates and returns a menu item object, or throws an error on failure.

:button

group:button(name: string[, callback: function, alt_style: boolean]): MenuItem
Name
Type
Description
name
string
Item name
callback
function
Optional. Function that will be called when the button is clicked
alt_style
boolean
Optional. Pass true to enable the alternative style for the specified button
Creates and returns a menu item object, or throws an error on failure.

:hotkey

group:hotkey(name: string[, default_key: number): MenuItem
Name
Type
Description
name
string
Item name
default_key
number
Optional. Default key
Creates and returns a menu item object, or throws an error on failure.

:input

group:input(name: string[, text: string]): MenuItem
Name
Type
Description
name
string
Item name
text
string
Optional. Default value
Creates and returns a menu item object, or throws an error on failure.

:list

group:list(name: string, items: any[, ...]): MenuItem
Name
Type
Description
name
string
Item name
items
any
One or more comma separated values that will be added to the combo. Alternatively, a table of strings that will be added
...
​
​
Creates and returns a menu item object, or throws an error on failure.

:listable

group:listable(name: string, items: any[, ...]): MenuItem
Name
Type
Description
name
string
Item name
items
any
One or more comma separated values that will be added to the combo. Alternatively, a table of strings that will be added
...
​
​
Creates and returns a menu item object, or throws an error on failure.

:label

group:label(text: string): MenuItem
Name
Type
Description
text
string
Label text
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
Name
Type
Description
texture
ImgObject
Image object
size
vector
Optional. Size of the image
color
color
Optional. Color of the texture
mode
string
Optional. f for fill, r for repeat
rounding
number
Optional. Image border rounding
Creates and returns a menu item object, or throws an error on failure.

: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[, ...])
Name
Type
Description
value
any
The value to which the menu item will be set
...
​
​
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(...)
Name
Type
Description
...
any
​
Updates the values of the menu item.

:reset

item:reset()
Resets the menu item to it's original value.

:set

item:set(value: any[, ...])
Name
Type
Description
value
any
The value to which the menu item will be set
...
​
​
Sets the value of the menu item.

:name

item:name([value: any])
Name
Type
Description
value
any
New name
Gets or sets the name of the menu item.

:tooltip

item:tooltip([value: any])
Name
Type
Description
value
any
New tooltip text
Gets or sets the tooltip of the menu item (depending on the presence of the value parameter).

:visibility

item:visibility([state: boolean])
Name
Type
Description
state
boolean
New visibility state
Gets or sets the menu item visibility depending on the value of state.

:disabled

item:disabled([state: boolean])
Name
Type
Description
state
boolean
New disabled state
Gets or sets the menu item disabled state depending on the value of state.

:set_callback

item:set_callback(callback: function[, force_call: boolean])
Name
Type
Description
callback
function
Function that will be called when the menu item is interacted with
force_call
boolean
Pass true to call the callback function after setup
Sets the callback to the specified menu item.

:unset_callback

item:unset_callback(callback: function)
Name
Type
Description
callback
function
Lua function that was passed to the :set_callback function
Unsets the callback that was set via the :set_callback function.

:color_picker

Simple
Multi-Color
item:color_picker([color: color]): MenuItem
Name
Type
Description
color
color
Optional. Initial color value
item:color_picker([colors: table]): MenuItem
Name
Type
Description
colors
table
Table containing tables with a string index, and those tables should contain one or multiple color objects. Check UI examples.
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.
Previous
math
Next
network
Last modified 7mo ago