MenuV Documentation

MenuV global namespace

Alias: MenuV

MenuV library

MenuV#CloseMenu(MenuV, menu, callback=undefined)⇒void

Type: function

Close a menu

Parameters

MenuV : MenuVRequired
menu : Menu|stringRequired
Menu or Universally Unique Identifier (UUID)
callback : functionDefault: undefined
Trigger callback when function has been executed

Example #1

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
MenuV:CloseMenu(menu)

Example #2

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
MenuV:CloseMenu(menu, function()
  print('Menu closed :(')
end)

MenuV#CreateMenu(MenuV, title='MenuV', subtitle='', position='topleft', r=0, g=0, b=255, size='size-110', texture='default', dictionary='menuv', namespace='unknown', theme='default')

⇒Menu

Type: function

Create a MenuV menu

Parameters

MenuV : MenuVRequired
title : string|booleanDefault: 'MenuV'
Title that appears on the big banner.
subtitle : stringDefault: ''
Subtitle that appears in capital letters in a small black bar.
position : stringDefault: 'topleft'
Menu position on screen options: topleft | topcenter | topright | centerleft | center | centerright | bottomleft | bottomcenter | bottomright
r : numberDefault: 0
Primary color RGB red channel [0-255]
g : numberDefault: 0
Primary color RGB green channel [0-255]
b : numberDefault: 255
Primary color RGB blue channel [0-255]
size : stringDefault: 'size-110'
Menu size in % options: size-100 | size-110 | size-125 | size-150 | size-175 | size-200
texture : stringDefault: 'default'
Texture name for the banner image
dictionary : stringDefault: 'menuv'
Texture dictionary name for the banner image
namespace : stringDefault: 'unknown'
Namespace is required to set keybinds, make sure given namespace is unique for every menu.
theme : stringDefault: 'default'
Change the look of the menu, available options: default and native

Returns: Menu

Example #1

local menu = MenuV:CreateMenu('MenuV')

Example #2

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV')

Example #3

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft')

Example #4

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0)

Example #5

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125')

Example #6

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example')

Example #7

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv')

Example #8

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace')

Example #9

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')

MenuV#GetMenu(MenuV, uuid)⇒Menu|null

Type: function

Returns created menu matching UUID

Parameters

MenuV : MenuVRequired
uuid : stringRequired
Universally Unique Identifier (UUID)

Returns: Menu|null — Returns matching menu or nil

Example

local menu = MenuV:GetMenu('00000000-0000-0000-0000-000000000000')

MenuV#InheritMenu(MenuV, menu, overrides, namespace)⇒Menu

Type: function

Create a new menu from properties of this one (without items and events)

Parameters

MenuV : MenuVRequired
menu : MenuRequired
Menu to take properties from
overrides : tableRequired
A table with key values to override, see Menu options
namespace : stringRequired
Unique namespace, see Menu.Namespace

Returns: Menu — New menu with properties of this one

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local menu2 = MenuV:InheritMenu(menu, { title = 'Menu V2', subtitle = 'Welcome to MenuV2 :D', theme = 'default' })

MenuV#IsNamespaceAvailable(namespace)⇒boolean

Type: function

Checks if namespace is available

Parameters

namespace : stringRequired
Namespace, see Menu.Namespace

Returns: boolean — Return true if given namespace is available, otherwise false

Example

local available = MenuV:IsNamespaceAvailable('example_namespace')

MenuV#OpenMenu(MenuV, menu, callback=undefined)⇒void

Type: function

Open a menu

Parameters

MenuV : MenuVRequired
menu : Menu|stringRequired
Menu or Universally Unique Identifier (UUID)
callback : functionDefault: undefined
Trigger callback when function has been executed

Example #1

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
MenuV:OpenMenu(menu)

Example #2

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
MenuV:OpenMenu(menu, function()
  print('Menu is now open :D')
end)

ButtonItem:class global

Extends: Item

Button item for MenuV

ButtonItem#event:enter

Type: event

Event will be triggered when item becomes active/selected in NUI

Parameters

item : ItemRequired
Current active/selected item

Example

item:On('enter', function(item)
    print('You have entered this item :)')
end)

ButtonItem#event:leave

Type: event

Event will be triggered when item becomes inactive/unselected in NUI

Parameters

item : ItemRequired
Current inactive/unselected item

Example

item:On('leave', function(item)
    print('You have unselected this item :(')
end)

ButtonItem#event:select

Type: event

Event will be triggered when user pressed ENTER on item

Parameters

item : ButtonItemRequired
Current selected item

Example

item:On('select', function(item)
    print('You have updated this item :)')
end)

ButtonItem#event:update

Type: event

Event will be triggered when item's value changed

Parameters

item : ItemRequired
Current updated item
key : stringRequired
Current updated key
value : anyRequired
Current updated value
oldValue : anyRequired
Previous value

Example

item:On('update', function(item, key, value, oldValue)
    print('You have updated this item :)')
end)

CheckboxItem:class global

Extends: Item

Checkbox item for MenuV

CheckboxItem.Value:boolean static

Value: false

Type: boolean

Value of CheckboxItem

CheckboxItem#event:change

Type: event

Event will be triggered when user changed checkbox state

Parameters

item : CheckboxItemRequired
Current changed checkbox item
newValue : booleanRequired
New state of checkbox
oldValue : booleanRequired
Previous state of checkbox

Example

item:On('change', function(item, newValue, oldValue)
    print('You have changed them checkbox state :)')
end)

CheckboxItem#event:check

Type: event

Event will be triggered when user check the checkbox

Parameters

item : CheckboxItemRequired
Current checked checkbox item

Example

item:On('check', function(item)
    print('You have set the checkbox state to checked :D')
end)

CheckboxItem#event:enter

Type: event

Event will be triggered when item becomes active/selected in NUI

Parameters

item : ItemRequired
Current active/selected item

Example

item:On('enter', function(item)
    print('You have entered this item :)')
end)

CheckboxItem#event:leave

Type: event

Event will be triggered when item becomes inactive/unselected in NUI

Parameters

item : ItemRequired
Current inactive/unselected item

Example

item:On('leave', function(item)
    print('You have unselected this item :(')
end)

CheckboxItem#event:uncheck

Type: event

Event will be triggered when user uncheck the checkbox

Parameters

item : CheckboxItemRequired
Current unchecked checkbox item

Example

item:On('uncheck', function(item)
    print('You have set the checkbox state to unchecked :(')
end)

CheckboxItem#event:update

Type: event

Event will be triggered when item's value changed

Parameters

item : ItemRequired
Current updated item
key : stringRequired
Current updated key
value : anyRequired
Current updated value
oldValue : anyRequired
Previous value

Example

item:On('update', function(item, key, value, oldValue)
    print('You have updated this item :)')
end)

ConfirmItem:class global

Extends: Item

Confirm item for MenuV

ConfirmItem#Confirm()⇒void

Type: function

Confirm this item, set confirm state to true

ConfirmItem#Deny()⇒void

Type: function

Deny this item, set confirm state to false

ConfirmItem.Value:boolean static

Value: false

Type: boolean

Value of ConfirmItem

ConfirmItem#event:change

Type: event

Event will be triggered when user changed confirm state

Parameters

item : ConfirmItemRequired
Current changed confirm item
newValue : booleanRequired
New state of confirm
oldValue : booleanRequired
Previous state of confirm

Example

item:On('change', function(item, newValue, oldValue)
    print('You have changed them confirm state :)')
end)

ConfirmItem#event:confirm

Type: event

Event will be triggered when user confirm the ConfirmItem

Parameters

item : ConfirmItemRequired
Current confirmed confirm item

Example

item:On('confirm', function(item)
    print('You have confirmed the confirm item :D')
end)

ConfirmItem#event:deny

Type: event

Event will be triggered when user denied the ConfirmItem

Parameters

item : ConfirmItemRequired
Current denied confirm item

Example

item:On('deny', function(item)
    print('You have denied the confirm item :D')
end)

ConfirmItem#event:enter

Type: event

Event will be triggered when item becomes active/selected in NUI

Parameters

item : ItemRequired
Current active/selected item

Example

item:On('enter', function(item)
    print('You have entered this item :)')
end)

ConfirmItem#event:leave

Type: event

Event will be triggered when item becomes inactive/unselected in NUI

Parameters

item : ItemRequired
Current inactive/unselected item

Example

item:On('leave', function(item)
    print('You have unselected this item :(')
end)

ConfirmItem#event:update

Type: event

Event will be triggered when item's value changed

Parameters

item : ItemRequired
Current updated item
key : stringRequired
Current updated key
value : anyRequired
Current updated value
oldValue : anyRequired
Previous value

Example

item:On('update', function(item, key, value, oldValue)
    print('You have updated this item :)')
end)

Item:class global

Item for MenuV

Item#GetParentMenu(item)⇒Menu

Type: function

Returns the Menu where item is added to (Parent Menu)

Parameters

item : ItemRequired
Item to get parent menu from

Returns: Menu — Parent's menu

Item#GetValue(item)⇒any|nil

Type: function

Get current item's value with some validation, see Item.Value

Parameters

item : ItemRequired
Item to get value from

Returns: any|nil — Return current valid value or nil

Item#On(item, event, func)⇒void

Type: function

Parameters

item : ItemRequired
Item to register function for
event : stringRequired
Name of on event to trigger
func : functionRequired
Function to trigger

Item.Description:string static

Value: ''

Type: string

Description of menu item

Item.Disabled:boolean static

Value: ''

Type: boolean

Disabled state of menu item

Item.Icon:string static

Value: 'none'

Type: string

Icon of menu item

Item.Label:string static

Value: ''

Type: string

Label of menu item

Item.SaveOnUpdate:boolean static

Value: false

Type: boolean

When item value changed, force to save changes

Item.UUID:string static readonly

Type: string

Universally Unique Identifier (UUID)

Item.Value:any static

Value: ''

Type: any

Value of menu item

Item#event:enter

Type: event

Event will be triggered when item becomes active/selected in NUI

Parameters

item : ItemRequired
Current active/selected item

Example

item:On('enter', function(item)
    print('You have entered this item :)')
end)

Item#event:leave

Type: event

Event will be triggered when item becomes inactive/unselected in NUI

Parameters

item : ItemRequired
Current inactive/unselected item

Example

item:On('leave', function(item)
    print('You have unselected this item :(')
end)

Item#event:update

Type: event

Event will be triggered when item's value changed

Parameters

item : ItemRequired
Current updated item
key : stringRequired
Current updated key
value : anyRequired
Current updated value
oldValue : anyRequired
Previous value

Example

item:On('update', function(item, key, value, oldValue)
    print('You have updated this item :)')
end)

Menu#AddButton(menu, options={})⇒ButtonItem

Type: function

This function will add a button item to Menu

Parameters

menu : MenuRequired
Menu to add button for
options : tableDefault: {}
Button information
options.icon : stringDefault: ''
Emoji as item prefex, see emojipedia.org
options.label : stringDefault: ''
Label on button
options.description : stringDefault: ''
Button description when this button is active
options.value : any|MenuDefault: nil
Button menu value, when value is a Menu, MenuV will open that Menu on button select
options.disabled : booleanDefault: false
When this option is true, button isn't selectable anymore

Returns: ButtonItem — New button item

Example #1

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local button = menu:AddButton({ icon = '😃', label = 'Example Button', value = 10, description = 'Example button' })

Example #2

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local menu2 = menu:InheritMenu({title = 'MenuV 2.0', subtitle = 'Inherit menu of `menu`', theme = 'default' })
local button = menu:AddButton({ icon = '😃', label = 'Open Menu2', value = menu2, description = 'Open menu 2.0' })

Menu#AddCheckbox(menu, options={})⇒CheckboxItem

Type: function

This function will add a checkbox item to Menu

Parameters

menu : MenuRequired
Menu to add checkbox item for
options : tableDefault: {}
Checkbox information
options.icon : stringDefault: ''
Emoji as item prefex, see emojipedia.org
options.label : stringDefault: ''
Label on checkbox
options.description : stringDefault: ''
Checkbox description when this checkbox item is active
options.value : booleanDefault: false
Checkbox item value
options.disabled : booleanDefault: false
When this option is true, checkbox isn't selectable anymore

Returns: CheckboxItem — New checkbox item

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local checkbox = menu:AddCheckbox({ icon = '💡', label = 'Checkbox Example', value = false })

Menu#AddConfirm(menu, options={})⇒ConfirmItem

Type: function

This function will add a confirm item to Menu

Parameters

menu : MenuRequired
Menu to add confirm item for
options : tableDefault: {}
Confirm information
options.icon : stringDefault: ''
Emoji as item prefex, see emojipedia.org
options.label : stringDefault: ''
Label on confirm item
options.description : stringDefault: ''
Confirm description when this confirm item is active
options.value : booleanDefault: false
Confirm menu value
options.disabled : booleanDefault: false
When this option is true, confirm item isn't selectable anymore

Returns: ConfirmItem — New confirm item

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local confirm = menu:AddConfirm({ icon = '🔥', label = 'Example Confirm', value = false })

Menu#AddRange(menu, options={})⇒RangeItem

Type: function

This function will add a range item to Menu

Parameters

menu : MenuRequired
Menu to add range item for
options : tableDefault: {}
Range information
options.icon : stringDefault: ''
Emoji as item prefex, see emojipedia.org
options.label : stringDefault: ''
Label on range item
options.description : stringDefault: ''
Range item description when this range item is active
options.value : numberDefault: 0
Range item value
options.min : numberDefault: 0
Minimal range value
options.max : numberDefault: 0
Maximal range value
options.disabled : booleanDefault: false
When this option is true, range item isn't selectable anymore

Returns: RangeItem — New range item

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local range = menu:AddRange({ icon = '⚽', label = 'Example Range Item', min = 0, max = 10, value = 0, saveOnUpdate = true })

Menu#AddSlider(menu, options={})⇒SliderItem

Type: function

This function will add a slider item to Menu

Parameters

menu : MenuRequired
Menu to add slider for
options : tableDefault: {}
Slider information
options.icon : stringDefault: ''
Emoji as item prefex, see emojipedia.org
options.label : stringDefault: ''
Label on slider
options.description : stringDefault: ''
Slider description when this slider is active
options.value : numberDefault: 1
Slider menu value, must be a valid index of SliderItem.Values
options.values : tableDefault: []
List of values
value.label : stringDefault: 'Value'
Label of value item
value.description : stringDefault: ''
Description of value item
value.value : anyDefault: null
Value of value item
options.disabled : booleanDefault: false
When this option is true, slider isn't selectable anymore

Returns: SliderItem — New slider item

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local slider = menu:AddSlider({ icon = '❤️', label = 'Example Slider', value = 'demo', values = {
            { label = 'Demo Item', value = 'demo', description = 'Demo Item 1' },
            { label = 'Demo Item 2', value = 'demo2', description = 'Demo Item 2' },
            { label = 'Demo Item 3', value = 'demo3', description = 'Demo Item 3' },
            { label = 'Demo Item 4', value = 'demo4', description = 'Demo Item 4' }
        }})

Menu#ClearItems(menu, update=true)⇒void

Type: function

Clear all items in menu

Parameters

menu : MenuRequired
Menu
update : booleanDefault: true
Force NUI update

Example #1

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:ClearItems()

Example #2

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:ClearItems(false)

Menu#Close(menu)⇒void

Type: function

Close this menu

Parameters

menu : MenuRequired
Menu

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:Close()

Menu#InheritMenu(menu, overrides, namespace)⇒Menu

Create a new menu from properties of this one (without items and events)

Parameters

menu : MenuRequired
Menu
overrides : tableRequired
A table with key values to override, see Menu options
namespace : stringRequired
Unique namespace, see Menu.Namespace

Returns: Menu — New menu with properties of this one

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local menu2 = menu:InheritMenu({title = 'MenuV 2.0', subtitle = 'Inherit menu of `menu`', theme = 'default' })

Menu#On(menu, event, func)⇒string

Type: function

Parameters

menu : MenuRequired
Menu to register function for
event : stringRequired
Name of on event to trigger
func : functionRequired
Function to trigger

Returns: string — Universally Unique Identifier (UUID)

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:On('open', function(m)
  print('Menu is now open :D')
end)

Menu#Open(menu)⇒void

Type: function

Open this menu

Parameters

menu : MenuRequired
Menu

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:Open()

Menu#OpenWith(menu, defaultType, defaultKey)⇒void

Type: function

Parameters

menu : MenuRequired
Menu
defaultType : stringRequired
Default input type, like: KEYBOARD, MOUSE_BUTTON etc.
defaultKey : stringRequired
Default input button, like: E, F12, LEFT_BUTTON etc.

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:OpenWith('keyboard', 'F1')

Menu#RemoveOnEvent(menu, event, uuid)⇒void

Type: function

Remove a registered on event

Parameters

menu : MenuRequired
Menu to remove event for
event : stringRequired
Name of on event to remove
uuid : stringRequired
Universally Unique Identifier (UUID) of registered on event

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local event_uuid = menu:On('open', function(m)
  print('Menu is now open :D')
end)
menu:RemoveOnEvent('open', event_uuid)

Menu#SetPosition(menu, position)⇒void

Type: function

Change menu's position

Parameters

menu : MenuRequired
Menu
position : stringRequired
Menu position on screen
options:
topleft | topcenter | topright | centerleft | center | centerright | bottomleft | bottomcenter | bottomright

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:SetPosition('bottomright')

Menu#SetSubtitle(menu, subtitle)⇒void

Change menu's subtitle

Parameters

menu : MenuRequired
Menu
subtitle : stringRequired
Subtitle of menu

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:SetSubtitle('Example Subtitle')

Menu#SetTitle(menu, title)⇒void

Type: function

Change menu's title

Parameters

menu : MenuRequired
Menu
title : stringRequired
Title of menu

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
menu:SetTitle('Example Title')

Menu#ToTable(menu)⇒void

Type: function

Transform Menu to table

Parameters

menu : MenuRequired
Menu

Example

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'example', 'menuv', 'example_namespace', 'native')
local menuData = menu:ToTable()

Menu~options:object inner

CreateMenu options

Parameters

options.namespace : stringDefault: unknown
Namespace is required to set keybinds, make sure given namespace is unique for every menu.
options.title : boolean|stringDefault: MenuV
Title that appears on the big banner.
options.subtitle : stringDefault: ""
Subtitle that appears in capital letters in a small black bar.
options.position : stringDefault: "topleft"
Menu position on screen options:
topleft | topcenter | topright | centerleft | center | centerright | bottomleft | bottomcenter | bottomright
options.r : numberDefault: 0
Primary color RGB red channel [0-255]
options.g : numberDefault: 0
Primary color RGB green channel [0-255]
options.b : numberDefault: 255
Primary color RGB blue channel [0-255]
options.size : stringDefault: size-110
Menu size in %
options:
size-100 | size-110 | size-125 | size-150 | size-175 | size-200
options.dictionary : stringDefault: menuv
Texture dictionary name for the banner image
options.texture : stringDefault: default
Texture name for the banner image
options.events : tableDefault: {}
Custom events to add
options.validate : functionDefault: nil
Custom Menu.Validate function
options.newIndex : functionDefault: nil
Custom Menu.NewIndex function

Menu#event:close

Type: event

Event will be triggered when menu is closed

Parameters

menu : MenuRequired
Current closed menu

Example

menu:On('close', function(menu)
    print('You have now closed the menu :)')
end)

Menu#event:open

Type: event

Event will be triggered when menu is opened

Parameters

menu : MenuRequired
Current opened menu

Example

menu:On('open', function(menu)
    print('You have now opened the menu :)')
end)

RangeItem:class global

Extends: Item

Range item for MenuV

RangeItem#SetMaxValue(input)⇒void

Type: function

Change RangeItem.Max

Parameters

input : numberRequired
New maximal value

RangeItem#SetMinValue(input)⇒void

Type: function

Change RangeItem.Min

Parameters

input : numberRequired
New minimal value

RangeItem.Max:number static

Value: 0

Type: number

Maximal possible value

RangeItem.Min:number static

Value: 0

Type: number

Minimal possible value

RangeItem.Value:number static

Value: 0

Type: number

Value of range item (default lowest possible value)

RangeItem#event:change

Type: event

Event will be triggered when user changed range state

Parameters

item : RangeItemRequired
Current changed range item
newValue : numberRequired
New value of range item
oldValue : numberRequired
Previous value of range item

Example

item:On('change', function(item, newValue, oldValue)
    print('You have changed them range :)')
end)

RangeItem#event:enter

Type: event

Event will be triggered when item becomes active/selected in NUI

Parameters

item : ItemRequired
Current active/selected item

Example

item:On('enter', function(item)
    print('You have entered this item :)')
end)

RangeItem#event:leave

Type: event

Event will be triggered when item becomes inactive/unselected in NUI

Parameters

item : ItemRequired
Current inactive/unselected item

Example

item:On('leave', function(item)
    print('You have unselected this item :(')
end)

RangeItem#event:select

Type: event

Event will be triggered when user pressed 'ENTER' in range item

Parameters

item : RangeItemRequired
Current selected range item
value : numberRequired
Value of range item

Example

item:On('select', function(item, value)
    print('You have select a range option :)')
end)

RangeItem#event:update

Type: event

Event will be triggered when item's value changed

Parameters

item : ItemRequired
Current updated item
key : stringRequired
Current updated key
value : anyRequired
Current updated value
oldValue : anyRequired
Previous value

Example

item:On('update', function(item, key, value, oldValue)
    print('You have updated this item :)')
end)

SliderItem:class global

Extends: Item

Slider item for MenuV

SliderItem#AddValue(item, value)⇒void

Type: function

Add a value to slider

Parameters

item : SliderItemRequired
SliderItem to add a value for
value : tableRequired
Value information
value.label : stringDefault: 'Value'
Label of value item
value.description : stringDefault: ''
Description of value item
value.value : anyDefault: null
Value of value item

SliderItem#AddValues(item, ...values)⇒void

Type: function

Add a list of values to slider

Parameters

item : SliderItemRequired
SliderItem to add values for
...values : ...tableRequired
Value information
value.label : stringDefault: 'Value'
Label of value item
value.description : stringDefault: ''
Description of value item
value.value : anyDefault: null
Value of value item

SliderItem.Value:number static

Value: 1

Type: number

Value of slider item (current selected index)

SliderItem#event:change

Type: event

Event will be triggered when user changed slider state

Parameters

item : SliderItemRequired
Current changed slider item
newValue : numberRequired
New index of slider item
oldValue : numberRequired
Previous index of slider item

Example

item:On('change', function(item, newValue, oldValue)
    print('You have changed them slider :)')
end)

SliderItem#event:enter

Type: event

Event will be triggered when item becomes active/selected in NUI

Parameters

item : ItemRequired
Current active/selected item

Example

item:On('enter', function(item)
    print('You have entered this item :)')
end)

SliderItem#event:leave

Type: event

Event will be triggered when item becomes inactive/unselected in NUI

Parameters

item : ItemRequired
Current inactive/unselected item

Example

item:On('leave', function(item)
    print('You have unselected this item :(')
end)

SliderItem#event:select

Type: event

Event will be triggered when user pressed 'ENTER' in slider item

Parameters

item : SliderItemRequired
Current selected slider item
value : anyRequired
Value from selected option

Example

item:On('select', function(item, value)
    print('You have select a slider option :)')
end)

SliderItem#event:update

Type: event

Event will be triggered when item's value changed

Parameters

item : ItemRequired
Current updated item
key : stringRequired
Current updated key
value : anyRequired
Current updated value
oldValue : anyRequired
Previous value

Example

item:On('update', function(item, key, value, oldValue)
    print('You have updated this item :)')
end)

table:object global

Object

threads:Array<number> global

List of threads

Documentation built with Docma.