Radial menu

The radial menu is a wheel of items the player opens with the Open Radial Menu key (Config.radial.default_key, Z by default, and players can rebind it). Scripts add items to the main wheel and register submenus that items open. The player keeps moving while it's open; the camera, firing, melee and the pause menu are blocked.

Pressed while the wheel is open, the key closes it, from the main wheel or a submenu. The center button closes it too, on the main page, and so does selecting an item. The key doesn't open the wheel while it has no items, while another lation ui window or any other NUI has focus (an open dialog or menu, for example), while the pause menu is open, or after disableRadial(true).

addRadialItemCopy Anchor Link

exports.lation_ui:addRadialItem(items)

Adds items to the main wheel. An item with the same id as one already there replaces it. If the wheel is open on the main page, it updates at once.

Items stay in the wheel until something removes them, even after the resource that added them stops. Remove yours when your resource stops:

AddEventHandler('onResourceStop', function(resource)
    if resource == GetCurrentResourceName() then
        exports.lation_ui:removeRadialItem('vehicle')
    end
end)

removeRadialItemCopy Anchor Link

exports.lation_ui:removeRadialItem(id)

clearRadialItemsCopy Anchor Link

exports.lation_ui:clearRadialItems()

Removes every item from the main wheel, including the items other resources added. Prefer removeRadialItem for your own.

exports.lation_ui:clearRadialItems()

registerRadialCopy Anchor Link

exports.lation_ui:registerRadial(radial)

Registers a submenu. Registering an id again replaces it, and if that submenu is open, it updates at once.

hideRadialCopy Anchor Link

exports.lation_ui:hideRadial()

Closes the wheel.

-- Close the wheel before a cutscene starts
exports.lation_ui:hideRadial()
StartCutscene(0)

disableRadialCopy Anchor Link

exports.lation_ui:disableRadial(state)

-- No wheel while handcuffed
exports.lation_ui:disableRadial(true)

getCurrentRadialIdCopy Anchor Link

local id = exports.lation_ui:getCurrentRadialId()

if exports.lation_ui:getCurrentRadialId() == 'vehicle_radial' then
    exports.lation_ui:registerRadial({ id = 'vehicle_radial', items = BuildVehicleItems() }) -- refresh it in place
end

ItemsCopy Anchor Link

The wheel shows up to six items. With more, the sixth wedge becomes More and opens the next page. One or two items keep the three-wedge layout, with the third wedge left empty, as ox_lib's wheel does.

onSelectCopy Anchor Link

onSelect = function(menuId, index) end

Runs when the player clicks the item or presses Enter on it. The wheel closes first, unless the item has keepOpen or opens a submenu. A string instead of a function names an export of the resource that added the item (for a submenu item, the resource that registered the submenu), called with the same arguments.

-- onSelect = 'openMessages' calls this export of your own resource
exports('openMessages', function(menuId, index)
    print('Messages opened from', menuId or 'the main wheel')
end)

ControlsCopy Anchor Link

ExampleCopy Anchor Link

exports.lation_ui:registerRadial({
    id = 'vehicle_radial',
    items = {
        {
            label = 'Engine',
            icon = 'fas fa-power-off',
            onSelect = function(menuId, index)
                local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
                SetVehicleEngineOn(vehicle, not GetIsVehicleEngineRunning(vehicle), false, true)
            end
        },
        {
            label = 'Fuel',
            icon = 'fas fa-gas-pump',
            progress = 64,
            progressColor = '#10B981',
            readOnly = true
        }
    }
})

exports.lation_ui:addRadialItem({
    {
        id = 'vehicle',
        label = 'Vehicle',
        icon = 'fas fa-car',
        menu = 'vehicle_radial'
    },
    {
        id = 'messages',
        label = 'Messages',
        icon = 'fas fa-envelope',
        badge = 3,
        keepOpen = true,
        onSelect = 'openMessages' -- calls exports[this resource]:openMessages(menuId, index)
    }
})