Menu items

Everything a player sees in the menu comes from Config.Menu in stg-radialmenu/config.lua. Other scripts can also add and remove entries while the server runs, see Exports.

Entry format

Each entry is one slice of the menu. An entry either runs an action or opens a submenu:

Config.Menu = {
    {
        id = 'police',
        label = 'Police',
        description = 'Emergency, status, house and action tools',
        icon = 'fa-solid fa-shield-halved',
        jobs = { 'police' },
        submenu = {
            {
                id = 'emergencybutton',
                label = 'Emergency Button',
                icon = 'fa-solid fa-bell',
                action = function()
                    TriggerEvent('police:client:SendPoliceEmergencyAlert')
                end
            },
        }
    },
}

• Entries appear in the order of the table. Each level shows 6 slices per page. With more than 6, a Next Page button appears. Back returns to the previous page or the parent menu.
• When an entry has both action and submenu, the action runs and the submenu never opens.
• jobs, inVehicle and nearVehicle work on every level, not only on the main menu.

Actions

An action is plain client Lua, so it can do anything a client script can:

action = function()
    TriggerEvent('qb-phone:client:GiveContactDetails')   -- client event
    TriggerServerEvent('police:server:SearchPlayer')     -- server event
    ExecuteCommand('e sit')                              -- chat command
end

The default menu calls QBCore resources. Replace each event with the one from the script you use, or remove the entry.

Visibility

Built in actions

The script ships these client events so the menu works without extra resources.

Clothing

action = function()
    TriggerEvent('stg-radialmenu:ToggleClothing', 'Top')
end

The first press takes the piece off with an animation, the second press puts the same piece back.

• Top opens or closes supported jackets, Shirt takes the whole top layer off.
• Bag switches supported bags between their two styles, Bagoff takes the bag off.
• hair ties up supported hair styles, visor flips supported helmet visors.
• TriggerEvent('stg-radialmenu:ResetClothing') puts back everything that was taken off.

Vehicle doors

action = function()
    TriggerEvent('stg-radialmenu:client:openDoor', 5)
end

Opens the door when it is closed and closes it when it is open. It works on the vehicle the player sits in, otherwise on the vehicle in front of them. When someone else is driving that vehicle, the door is moved for them too.

Exports

Other resources can change the menu at runtime with two client exports. Call them from a client script.

addRadialItem

exports['stg-radialmenu']:addRadialItem({
    id = 'myscript_menu',
    label = 'My Script',
    description = 'Open my script',
    icon = 'fa-solid fa-star',
    jobs = { 'police' },
    action = function()
        TriggerEvent('myscript:client:open')
    end
})

Takes one entry in the entry format and adds it to the end of the main menu. The entry can have its own submenu. Back from a submenu more than one level deep inside an added entry returns straight to the main menu.

removeRadialItem

exports['stg-radialmenu']:removeRadialItem('myscript_menu')

Removes the main menu entry with this id. Entries inside a submenu cannot be removed this way.

Good practice

• Every call adds a new entry, even with an id that already exists. Add each entry once, and remove it before adding it again.
• Entries added with the export are lost when stg-radialmenu restarts. Start your script after [STG] so the export exists when it runs.
• Remove your entries when your own resource stops, so the menu does not keep actions from a stopped script:

AddEventHandler('onResourceStop', function(resource)
    if resource == GetCurrentResourceName() then
        exports['stg-radialmenu']:removeRadialItem('myscript_menu')
    end
end)