Use these client-side exports to dynamically add items, create nested menus, remove items, or control the radial menu from any resource.
Add a simple item and test it:
Open the radial menu (default F1) and select the item. Remove it with:
Every menu item follows this structure. Root items and sub-items share the same fields with minor differences noted below.
| Field | Type | Required | Description |
|---|---|---|---|
label | string | Yes | Text shown in the menu. title is accepted as a fallback. |
icon | table | Yes | { address = 'fa-solid fa-icon' } — FontAwesome class or image URL. |
trigger | table | Yes | Action to perform on click. Use {} for submenu-only parents. |
closeRadialMenu | boolean | No | Close the entire radial menu after clicking. Default false. |
closeSubMenu | boolean | No | Close the submenu panel after clicking. Used in sub-items. Default false. |
canAccess | function | No | Return true to show, false to hide. Evaluated every time the menu opens. |
subMenu | table | No | Array of child items (max 2 levels deep). |
id | string | number | No | Unique identifier. Required for removal or when used as a submenu child. |
Each trigger table supports one or more of the following:
All three trigger types can coexist on the same item. Each one that is present will execute when the item is selected.
Use canAccess to conditionally show or hide items based on game state:
canAccess is evaluated each time the radial menu opens, not at registration time. Errors are caught with pcall and logged — a failing canAccess hides the item.
Adds a menu item to the radial menu. Returns the assigned menuID.
Parameters:
subMenu of an existing parentExamples:
When using numeric IDs, keep them sequential (1, 2, 3, ...). Reusing an existing ID overwrites that item.
Parameters:
Removes all items from the radial menu, including static config items and all stored function references.
This is a full reset — config items (Config.menuItems) are also cleared. Use with caution.
Parameters:
true — disable the radial menufalse — enable the radial menunil (or omitted) — toggle the current state
Programmatically closes the radial menu from any script.
Converts an OxLib/QBX-style item into the native onex format. Accepts a single item table or an array of items.
Simplified input format:
onex-radialmenu provides qbx_radialmenu and qb-radialmenu via the provide directive. Existing scripts that call exports['qb-radialmenu'] or exports['qbx_radialmenu'] will automatically route to onex-radialmenu — no code changes needed.
These wrappers accept the simplified format (see ConvertToOnexRadial) and internally convert before adding.
6 Root Slots — The radial menu supports up to 6 root-level items. When more items are present, the UI automatically creates a "More" overflow entry on the 6th slot.
Auto-Cleanup — When a resource that added items via exports stops or restarts, all its dynamically added items are automatically removed. No manual cleanup needed.
Static vs Dynamic — Items in Config.menuItems are static (loaded once at startup). Items added via exports are dynamic (merged each time the menu opens).
Submenu Depth — Submenus support up to 2 levels of nesting (root → submenu → nested submenu).
label, icon, and trigger.event.name and event.type ('client' or 'server'), and verify the event handler exists.'fa-solid fa-car') or a valid image URL.F1) and that disableRadial(false) is set.canAccess returns true. Errors in canAccess will hide the item silently (check server console for logged errors).Last updated 2 months ago