A client side library to use the JO Menu in your scripts.
JO Menu is a NUI menu fully optimized and mouse and keyboard ready.

Usage

Download an example of menu resource

Constructor

Create a new menu

Syntax

lua

jo.menu.create(id, data)

Parameters

id : string

Unique ID of the menu

data : table Optional

Menu configuration data

data.title : string - The big title of the menu
data.subtitle : string - The subtitle of the menu
data.numberOnScreen : integer - Maximum number of items visibles at the same time
default : 8 Optional
data.distanceToClose : float - Distance at which the menu will self close if the player is moving away
default: false
data.onEnter : function - Fired when the menu is opened Optional
data.onBack : function - Fired when the backspace/Escape is pressed Optional
data.onExit : function - Fired when the menu is exited Optional

Return Value

Type : MenuClass

The newly created menu object

Example

lua

--The unique ID of the menu
local id = "UniqueId1"
--The menu data
local data = {
  title = "Menu",        --The big title of the menu
  subtitle = "Elements", --The subtitle of the menu
  numberOnScreen = 8,    --The number of item display before add a scroll
  onEnter = function(currentData)
    print("Enter in menu " .. id)
  end,
  onBack = function(currentData)
    print("Backspace/Esc pressed in menu " .. id)
  end,
  onExit = function(currentData)
    print("Exit menu " .. id)
  end,
}
local menu = jo.menu.create(id, data)

MenuClass Methods

MenuClass:addItem()

Add an item to a menu

Syntax

lua

MenuClass:addItem(p, item)

Parameters

p : integer|table

Position index or item table if used as single parameter

item : table Optional

The item to add - if not provided, p is used as the item

item.title : string - The item label
item.child : string - The menu to open when Enter is pressed
default: false Optional
item.visible : boolean - If the item is visible in the menu
default: true Optional
item.data : table - Variable to store custom data in the item Optional
item.description : string - Description text for the item Optional
item.prefix : string - The little icon before the title from nui\menu\assets\images\icons folder Optional
item.icon : string - The left icon filename from nui\menu\assets\images\icons folder Optional
item.iconRight : string - The right icon filename from nui\menu\assets\images\icons folder Optional
item.iconClass : string - CSS class for the icon Optional
item.price : table - The price of the item. Use 0 to display "free"
default: false Optional
item.price.money : number - The price in $ Optional
item.price.gold : number - The price in gold Optional
item.priceTitle : string - Replace the "Price" label Optional
item.priceRight : boolean - Display the price at the right of the item title Optional
item.statistics : table - List of statistics to display for the item Optional
item.disabled : boolean - If the item is disabled (grey) in the menu Optional
item.textRight : string - The label displayed at the right of the item Optional
item.previewPalette : boolean - Display a color square at the right of the item
default: true Optional
item.sliders : table - List of sliders for the item Optional
item.onActive : function - Fired when the item is selected Optional
item.onClick : function - Fired when Enter is pressed on the item Optional
item.onChange : function - Fired when a slider value changes Optional
item.onExit : function - Fired when the item is exited Optional

Return Value

Type : table

The added item

Example

lua

-- Create a menu
local menu = jo.menu.create("shopMenu", {
  title = "General Store",
  subtitle = "Available Items"
})

-- Add items using single parameter (adds to the end of the list)
menu:addItem({
  title = "Hunting Knife",
  description = "A sharp knife for skinning animals",
  prefix = "knife", -- Icon before the title
  price = { money = 12.50 },
  statistics = {
    { label = "Damage", type = "bar", value = { 7, 10 } },
    { label = "Durability", type = "bar", value = { 8, 10 } }
  },
  onClick = function(currentData)
    print("Purchasing Hunting Knife")
    -- Code to purchase the item would go here
  end
})

-- Add item at specific position (position 1 - at the beginning)
menu:addItem(1, {
  title = "Horse Brush",
  description = "Keep your horse clean and happy",
  price = { money = 5.75 },
  icon = "brush",     -- Left icon
  disabled = false,
  textRight = "New!", -- Text shown on the right
  onClick = function(currentData)
    print("Purchasing Horse Brush")
    -- Code to purchase the item would go here
  end
})

-- Add another item with sliders
menu:addItem({
  title = "Hunting Outfit",
  description = "Camouflage clothing for hunting",
  price = { money = 45.00, gold = 5 },
  sliders = {
    {
      title = "Colors",
      current = 1,
      values = { "Brown", "Green", "Black" }
    }
  },
  onChange = function(currentData)
    local selectedColor = currentData.item.sliders[1].value.label
    print("Selected color: " .. selectedColor)
  end
})

-- Add a child menu item (opens another menu when selected)
menu:addItem({
  title = "Weapons →",
  child = "weaponsMenu", -- This will open the "weaponsMenu" when activated
  icon = "revolver"
})

-- Send the menu to the NUI layer
menu:send()

-- Set this menu as the current menu and show it
jo.menu.setCurrentMenu("shopMenu")
jo.menu.show(true)

MenuClass:refresh()

Refresh the menu display without changing the current state
Used when menu items have been modified

Syntax

lua

MenuClass:refresh()

Example

lua

local menu = jo.menu.create(id, data)
menu:addItem({ title = "Item 1" })
menu:send()
menu:addItem({ title = "Item 2" })
menu:refresh()

MenuClass:reset()

Reset the menu to its initial state
Moves the cursor back to the first item

Syntax

lua

MenuClass:reset()

Example

lua

menu:reset()

MenuClass:send()

Send the menu data to the NUI layer

Syntax

lua

MenuClass:send()

Example

lua

local menu = jo.menu.create(id, data)
menu:send()

MenuClass:setCurrentIndex()

Change the current active item index

Syntax

lua

MenuClass:setCurrentIndex(index)

Parameters

index : integer

The item index to switch to

Example

lua

local menu = jo.menu.create(id, data)

menu:addItem({
  title = "Item 1",
})

menu:addItem({
  title = "Item 2",
})

menu:addItem({
  title = "Item 3",
})

menu:setCurrentIndex(2) -- set item 2 as active

MenuClass:sort()

Sort menu items alphabetically by title

Syntax

lua

MenuClass:sort(first, last)

Parameters

first : integer Optional

Position of the first element to sort
default: 1

last : integer Optional

Position of the last element to sort
default: #self.items

Example

lua

-- Sort all menu items alphabetically by title
menu:sort()

-- Sort only items 2 through 5
menu:sort(2, 5)

MenuClass:updateItem()

Update a specific property of a menu item

Syntax

lua

MenuClass:updateItem(index, key, value)

Parameters

index : integer

The index of the item to update

key : string

The property name to update

value : any

The new value for the property

Example

lua

-- Update the title of the second item
menu:updateItem(2, "title", "New Title")

-- Disable the third item
menu:updateItem(3, "disabled", true)

MenuClass:use()

Set this menu as the current active menu

Syntax

lua

MenuClass:use(keepHistoric, resetMenu)

Parameters

keepHistoric : boolean Optional

Whether to keep navigation history
default: true

resetMenu : boolean Optional

Whether to reset the menu state
default: true

Example

lua

-- Set this menu as the current active menu
-- Keep navigation history and reset the cursor position
menu:use(true, true)

-- Set this menu as the current active menu
-- Don't keep navigation history
menu:use(false)

JO Functions

Add an item to a menu by its ID

Syntax

lua

jo.menu.addItem(id, p, item)

Parameters

id : string

The menu ID

p : integer|table

Position index or item table if used as single parameter

item : table Optional

The item to add - if not provided, p is used as the item

item.title : string - The item label
item.child : string - The menu to open when Enter is pressed
default: false Optional
item.visible : boolean - If the item is visible in the menu
default: true Optional
item.data : table - Variable to store custom data in the item Optional
item.description : string - Description text for the item Optional
item.prefix : string - The little icon before the title from nui\menu\assets\images\icons folder Optional
item.icon : string - The left icon filename from nui\menu\assets\images\icons folder Optional
item.iconRight : string - The right icon filename from nui\menu\assets\images\icons folder Optional
item.iconClass : string - CSS class for the icon Optional
item.price : table - The price of the item. Use 0 to display "free"
default: false Optional
item.price.money : number - The price in $ Optional
item.price.gold : number - The price in gold Optional
item.priceTitle : string - Replace the "Price" label Optional
item.priceRight : boolean - Display the price at the right of the item title Optional
item.statistics : table - List of statistics to display for the item Optional
item.disabled : boolean - If the item is disabled (grey) in the menu Optional
item.textRight : string - The label displayed at the right of the item Optional
item.previewPalette : boolean - Display a color square at the right of the item
default: true Optional
item.sliders : table - List of sliders for the item Optional
item.onActive : function - Fired when the item is selected Optional
item.onClick : function - Fired when Enter is pressed on the item Optional
item.onChange : function - Fired when a slider value changes Optional
item.onExit : function - Fired when the item is exited Optional

Example

lua

-- Add a new item to a menu by its ID
local menuId = "mainMenu"
jo.menu.addItem(menuId, {
  title = "New Option",
  description = "This is a new menu option",
  onClick = function(currentData)
    print("New option clicked")
  end
})

-- Add a new item at a specific position (3rd position)
jo.menu.addItem(menuId, 3, {
  title = "Insert at position 3",
  description = "This item will be inserted at position 3"
})

Delete a menu from memory

Syntax

lua

jo.menu.delete(id)

Parameters

id : string

The menu ID to delete

Example

lua

local id = "UniqueId1"
jo.menu.delete(id)

Check if the active button has changed since last update

Syntax

lua

jo.menu.doesActiveButtonChange()

Return Value

Type : boolean

Returns true if the active button has changed

Example

lua

-- Check if the selected button has changed since last update
if jo.menu.doesActiveButtonChange() then
  print("Player selected a different button")
end

Fire an event across all menu levels (current menu and current item)

Syntax

lua

jo.menu.fireAllLevelsEvent(eventName, ...)

Parameters

eventName : string

The name of the event to fire

... : any Optional

Additional arguments to pass to the event handlers

Example

lua

-- Fire a custom event across all menu levels
jo.menu.fireAllLevelsEvent("onCustomEvent", "Parameter 1", 42, { data = "Extra data" })

Fire an event for a specific menu item

Syntax

lua

jo.menu.fireEvent(item, eventName, ...)

Parameters

item : table

The item to trigger the event on

eventName : string

The name of the event to fire

... : any Optional

Additional arguments to pass to the event handler

Example

lua

-- Get the current item and fire a custom event on it
local currentItem = jo.menu.getCurrentItem()
jo.menu.fireEvent(currentItem, "onClick")

-- Fire a custom event on a specific menu
local menu = jo.menu.get("mainMenu")
jo.menu.fireEvent(menu, "onExit")

Force the menu to go back to the previous menu

Syntax

lua

jo.menu.forceBack()

Example

lua

-- Force the menu to go back to the previous menu
jo.menu.forceBack()

Get a menu instance by its ID

Syntax

lua

jo.menu.get(id)

Parameters

id : string

The menu ID

Return Value

Type : MenuClass

The menu object

Example

lua

-- Get a menu instance by its ID
local menuId = "mainMenu"
local menu = jo.menu.get(menuId)

-- Now you can work with this menu instance
if menu then
  print("Menu title: " .. menu.title)
  print("Number of items: " .. #menu.items)
end

Get data about the current menu state

Syntax

lua

jo.menu.getCurrentData()

Return Value

Type : table

Current menu data including menu ID and selected item

Example

lua

-- Get data about the current menu state
local currentData = jo.menu.getCurrentData()
print("Current menu ID: " .. tostring(currentData.menu))
print("Current item index: " .. tostring(currentData.index))

Get the currently selected menu item

Syntax

lua

jo.menu.getCurrentItem()

Return Value

Type : table

The currently selected item

Example

lua

-- Get the currently selected menu item
local currentItem = jo.menu.getCurrentItem()

-- Access properties of the current item
if currentItem then
  print("Selected item: " .. currentItem.title)
  if currentItem.description then
    print("Description: " .. currentItem.description)
  end
end

Get the currently active menu

Syntax

lua

jo.menu.getCurrentMenu()

Return Value

Type : MenuClass

The currently active menu

Example

lua

-- Get the currently active menu
local currentMenu = jo.menu.getCurrentMenu()

-- Access properties of the current menu
if currentMenu then
  print("Active menu title: " .. currentMenu.title)
  print("Number of items: " .. #currentMenu.items)
end

Get data about the previous menu state

Syntax

lua

jo.menu.getPreviousData()

Return Value

Type : table

Previous menu data including menu ID and selected item

Example

lua

-- Get data about the previous menu state
local previousData = jo.menu.getPreviousData()
print("Previous menu ID: " .. tostring(previousData.menu))
print("Previous item index: " .. tostring(previousData.index))

Check if any menu is currently open

Syntax

lua

jo.menu.isOpen()

Return Value

Type : boolean

Returns true if a menu is open

Example

lua

local isOpen = jo.menu.isOpen()
print(isOpen)

Syntax

lua

jo.menu.onChange(cb)

Parameters

cb : function

The callback function to register

Example

lua

-- Register a callback function for menu change events
jo.menu.onChange(function(currentData)
  print("Menu changed to: " .. tostring(currentData.menu))
  print("Selected item: " .. tostring(currentData.item.title))

  -- You can handle different menus here
  if currentData.menu == "mainMenu" then
    -- Do something specific for the main menu
  elseif currentData.menu == "settingsMenu" then
    -- Do something specific for the settings menu
  end
end)

A function to play a NUI sound

Syntax

lua

jo.menu.playAudio(sound)

Parameters

sound : string

Example

lua

jo.menu.playAudio('coins')

Refresh a menu by its ID

Syntax

lua

jo.menu.refresh(id)

Parameters

id : string

The menu ID to refresh

Example

lua

-- Refresh a menu by its ID to update its display
local menuId = "mainMenu"
jo.menu.refresh(menuId)

Reset a menu by its ID

Syntax

lua

jo.menu.reset(id)

Parameters

id : string

The menu ID to reset

Example

lua

-- Reset a menu by its ID
-- This moves the cursor back to the first item
local menuId = "mainMenu"
jo.menu.reset(menuId)

Send a menu to the NUI layer by its ID

Syntax

lua

jo.menu.send(id)

Parameters

id : string

The menu ID

Example

lua

-- Send a menu to the NUI layer by its ID
local menuId = "mainMenu"
jo.menu.send(menuId)

-- Send without resetting cursor position
jo.menu.send(menuId, false)

Set or replace a menu instance

Syntax

lua

jo.menu.set(id, menu)

Parameters

id : string

The menu ID

menu : MenuClass

The menu object to set

Example

lua

-- Create a new menu instance
local newMenu = {
  id = "customMenu",
  title = "Custom Menu",
  subtitle = "Created with jo.menu.set",
  items = {
    { title = "Option 1" },
    { title = "Option 2" }
  }
}

-- Set this as a menu by its ID
jo.menu.set("customMenu", newMenu)

Set a menu as the current active menu

Syntax

lua

jo.menu.setCurrentMenu(id, keepHistoric, resetMenu)

Parameters

id : string

ID of the menu to activate

keepHistoric : boolean Optional

Keep the menu navigation history
default: true

resetMenu : boolean Optional

Clear and redraw the menu before displaying
default: true

Example

lua

local id = "UniqueId1"
local keepHistoric = true
local resetMenu = true
jo.menu.setCurrentMenu(id, keepHistoric, resetMenu)

Show or hide a menu

Syntax

lua

jo.menu.show(show, keepInput, hideRadar, animation, hideCursor)

Parameters

show : boolean

Whether to show or hide the menu

keepInput : boolean Optional

Whether to keep game input controls active
default: true

hideRadar : boolean Optional

Whether to hide the radar when menu is shown
default: true

animation : boolean Optional

Whether to use animation when showing/hiding the menu
default: true

hideCursor : boolean Optional

Whether to hide the cursor
default: false

Example

lua

local visible = true
local keepInput = true
local hideRadar = true
jo.menu.show(visible, keepInput, hideRadar)

Sort menu items alphabetically by title using menu ID

Syntax

lua

jo.menu.sort(id, first, last)

Parameters

id : string

The menu ID

first : integer Optional

Position of the first element to sort
default: 1

last : integer Optional

Position of the last element to sort
default: #self.items

Example

lua

-- Sort all items in a menu alphabetically by title
local menuId = "mainMenu"
jo.menu.sort(menuId)

-- Sort only items 2 through 5
jo.menu.sort(menuId, 2, 5)

Update a specific property of a menu item by menu ID

Syntax

lua

jo.menu.updateItem(id, index, key, value)

Parameters

id : string

The menu ID

index : integer

The index of the item to update

key : string

The property name to update

value : any

The new value for the property

Example

lua

-- Update the title of the second item in a menu
local menuId = "mainMenu"
jo.menu.updateItem(menuId, 2, "title", "New Title")

-- Disable the third item
jo.menu.updateItem(menuId, 3, "disabled", true)

Update menu language text

Syntax

lua

jo.menu.updateLang(lang)

Parameters

lang : table

List of translated strings

lang.of : string - The bottom right text displaying current item number
default : "%1 of %2" Optional
lang.selection : string - The "Selection" text
default : "Selection" Optional
lang.devise : string - The devise text
default : "$" Optional
lang.number : string - The number text
default : "Number %1" Optional
lang.free : string - The "Free" text
default : "Free" Optional
lang.variation : string - The variatio, text
default : "Variation" Optional

Example

lua

-- Update menu language text
jo.menu.updateLang({
  of = "%1 of %2",
  selection = "Selection",
  devise = "$",
  number = "Number %1",
  free = "Free",
  variation = "Variation"
})

Set the volume level for menu sound effects

Syntax

lua

jo.menu.updateVolume(volume)

Parameters

volume : number

Volume of sound effects 0.0 to 1.0

Example

lua

-- Set the volume level for menu sound effects
-- Volume range is 0.0 to 1.0
jo.menu.updateVolume(0.8)

Variables

CurrentData

The argument pass on each function

keys

CurrentData.menu : string

The unique ID of the menu

CurrentData.item : table

The item active in the menu

By default, the library is released with resource to replace the old framework menu.

VORP

Replace the vorp_menu resource by the one delivered with the library

RSG

Replace the rsg-menubase resource by the one delivered with the library

RedEM:RP

Replace the redemrp_menu_base resource by the one delivered with the library

New assets

Add a new icon

Add you .png file in the nui\menu\assets\images\icons folder

Item variations

Sliders

4 types of sliders are available on the menu: Default, Grid, Palette & Switch.
You can use multiples sliders on the same item.
Use currentData.item.sliders[X].value to get the current value of the slider.
Here is an example of an item with sliders of the 4 types:

Default

The default slider based on the original game design. Usefull to choose between item variations like clothes.

Syntax

lua

{title = "", current = 1, values = {item1,item2,..}}

Keys

title : string

The label on the top of variations

current : integer

The current item selected

values : table

The table of item variations. 1 entry = 1 rectangle

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  sliders = {
    {
      title = 'Variations',
      current = 2,
      values = {
        "value1",
        { var = 4 },
        { yourKey = "your Value" },
        'value2',
        5,
        10,
      }
    },
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Grid

The grid slider is usefull to define a value between a min and max value.
You can use one or two dimensions of slider.
One dimension: Two dimensions:

TIP

To get the values of the slider, .value is a table with two arguments:
currentData.item.sliders[X].value[1] for the horizontal axe (or for one dimension slider)
currentData.item.sliders[X].value[2] for the vertical axe

Syntax

lua

{type = "grid", labels = {'left','right','up','down'}, values = {
  {current = 0.5,max = 1.0, min = -1.0, gap = 0.01},
  {current = 0.5,max = 10.0, min = 0.0, gap = 0.01}, --for two dimensions
}}

Keys

type : string

The type of slider

labels : table

The 4 labels in the order : left, right, top, bottom

values : table

The slider definitions.
1 entry = 1 dimension slider
2 entries = 2 dimensions sliders values[x].current : float - the current value of the slider values[x].min : float - the minimal value (cursor on the full left/top) values[x].max : float - the minimal value (cursor on the full right/bottom)

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  sliders = {
    {
      type = "grid",
      labels = { 'left', 'right', 'up', 'down' },
      values = {
        { current = 0.5, max = 1.0,  min = -1.0 },
        { current = 0.5, max = 10.0, min = 0.0 }, --for two dimensions
      }
    },
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Palette

The palette slider is usefull to select a color.

Syntax

lua

{type = "palette", title = "tint", tint = "tint_makeup", max = 63, current = 14}

Keys

type : string

The type of slider

title : table

The top label on the slider

tint : string

The name of the gradient :
"tint_generic_clean", "tint_hair", "tint_horse", "tint_horse_leather", "tint_leather" & "tint_makeup"

max : integer

The number of varations

current : integer

The current variation

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  sliders = {
    { type = "palette", title = "tint", tint = "tint_makeup", max = 63, current = 14 }
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Switch

The switch slider is display on the right of the item label.

Syntax

lua

{type = "switch", current = 1, values = {
  {label = "", data = {}},
  {label = "", data = {}}
}}

Keys

type : string

The type of slider

current : integer

The current variation

values : table

The list of variations
values[x].label is the label displayed

Example

lua

local menu = jo.menu.create('menu1',{})
menu:addItem({
  title = "Item",
  sliders = {
    { type = "switch", current = 1, values = {
      {label = "value 1", myKey = 4},
      {label = "value 2", data = "what you want"}
    }
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Statistics

Statistics table is displayed at the bottom of the menu. 5 types of statistics are available: Bar, Bar-style, Icon, Texts and Weapon-bar
Multiple statistics can be use for the same item.
Here is an example of an item with 5 statistics of the 5 types:

Bar

A statistic with 10 bars

Syntax

lua

{label = "", type = "bar", value = {current,max}}

Keys

label : string

the left label

type : string

value : table

For the left to the right, current are white, max are grey, all the rest is dark grey
value.current : integer (0<>10 - the number of white bar
value.max : integer (0<>10 - the number of grey bar

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  statistics = {
    { label = "The label", type = "bar", value = { 3, 8 } }
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Bar-style

A statistic with unlimted bar defined with CSS classes

Syntax

lua

{label = "", type = "bar-style", value = {'','',''}}

Keys

label : string

the left label

type : string

value : table

A list of string to define the CSS classes of bar, 1 string = 1 bar
If the string is empty, the bar is dark grey. CSS classes:
active : Opacity = 1
fgold : Gold
fred : Red
possible : Opacity = 0.5
CSS classes can be combinated

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  statistics = {
    {
      label = "The label",
      type = "bar-style",
      value = {
        "active",      --the 1st bar: opacity = 1
        "active fgold", --the 2nd bar: opacity = 1 + gold
        "active fred", --the 3rd bar: opacity = 1 + red
        "possible fred", --the 4th bar: opacity = 0.5 + red
        "possible",    --the 4th bar: opacity = 0.5
        "",            --the 5th bar: opacity = 0.2
      }
    },
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Icon

A statistic with icons on the right

Syntax

lua

{label = "", type = "icon", value = {{icon = '', opacity = 1.0}}}

Keys

label : string

the left label

type : string

value : table

A list of table to define the icon from left to right, 1 table = 1 icon
icon : string - Icon filename from nui\menu\assets\images\icons\ folder
opacity : float (0.0<>1.0) - The opacity of the icon

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  statistics = {
    {
      label = "The label",
      type = "icon",
      value = {
        { icon = "player_health", opacity = 1 }, --the 1st icon
        { icon = "player_health", opacity = 0.75 }, --the 2nd icon
        { icon = "player_health", opacity = 0.3 } --the 3rd icon
      }
    },
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Texts

Basic statistic with two labels

Syntax

lua

{label = "", value = ""}

Keys

label : string

The left label

value : string

The right label

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  statistics = {
    { label = "The label", value = "The value" }
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Weapon-bar

A statistic with the weapon bar design. Useful to display a percent of completion

Syntax

lua

{label = "", type="weapon-bar", value = {current,max}}

Keys

label : string

The left label

type : string

value : table

The percent of completion is calculated by value.current\value.max
value.current : float - the current value of the statistic
value.max : float - the max value the statistic can reach

Example

lua

local menu = jo.menu.create('menu1', {})
menu:addItem({
  title = "Item",
  statistics = {
    { label = "The label", type = "weapon-bar", value = { 60, 100 } }
  }
})
menu:send()
jo.menu.setCurrentMenu('menu1')
jo.menu.show(true)

Animation

Blip

Callback

Component

Database

Dataview

Date

Debugger

Emit

Entity

File

Framework Bridge

Game Events

Gizmo

Hook

Input

Light

Math

Me

Menu

Notification

Nui

Ped Texture

Print

Promise

Prompts

Native

NUI

Raw Keys

Screen

String

Table

Timeout

Trigger Event

Ui

Utils

Waiter

JO Menu Client ​

Usage ​

Constructor ​

jo.menu.create() ​

Syntax ​

Parameters ​

Return Value ​

Example ​

MenuClass Methods ​

MenuClass:addItem() ​

Syntax ​

Parameters ​

Return Value ​

Example ​

MenuClass:refresh() ​

Syntax ​

Example ​

MenuClass:reset() ​

Syntax ​

Example ​

MenuClass:send() ​

Syntax ​

Example ​

MenuClass:setCurrentIndex() ​

Syntax ​

Parameters ​

Example ​

MenuClass:sort() ​

Syntax ​

Parameters ​

Example ​

MenuClass:updateItem() ​

Syntax ​

Parameters ​

Example ​

MenuClass:use() ​

Syntax ​

Parameters ​

Example ​

JO Functions ​

jo.menu.addItem() ​

Syntax ​

Parameters ​

JO Menu Client

Usage

Constructor

jo.menu.create()

Syntax

Parameters

Return Value

Example

MenuClass Methods

MenuClass:addItem()

Syntax

Parameters

Return Value

Example

MenuClass:refresh()

Syntax

Example

MenuClass:reset()

Syntax

Example

MenuClass:send()

Syntax

Example

MenuClass:setCurrentIndex()

Syntax

Parameters

Example

MenuClass:sort()

Syntax

Parameters

Example

MenuClass:updateItem()

Syntax

Parameters

Example

MenuClass:use()

Syntax

Parameters

Example

JO Functions

jo.menu.addItem()

Syntax

Parameters

Example

jo.menu.delete()

Syntax

Parameters

Example

jo.menu.doesActiveButtonChange()

Syntax

Return Value

Example

jo.menu.fireAllLevelsEvent()

Syntax

Parameters

Example

jo.menu.fireEvent()

Syntax

Parameters

Example

jo.menu.forceBack()

Syntax

Example

jo.menu.get()

Syntax

Parameters

Return Value

Example

jo.menu.getCurrentData()

Syntax

Return Value

Example

jo.menu.getCurrentItem()

Syntax

Return Value

Example

jo.menu.getCurrentMenu()

Syntax

Return Value

Example