Interactions

Goal: write and understand every menu option. File to edit: config_interactions.lua (client side). Restart the resource after a change: options are built once, at start.

The lists

A list’s options are shown in file order. On a vehicle, the original ox_target options (doors, hood, trunk) appear before those of VehicleInteractions, followed by model options and zone options.

Common fields

Action types

An option declares its action with onSelect, a type or a builtin. When onSelect is present, it takes priority.

For client_event and server_event, an args = { … } field adds arguments after the passed object. For server_event, the passed object is { serverId, netId, coords, name, kind }.

Target object

onSelect callbacks, client_event events, exports and the args function of a server_action receive:

{
    name = 'check_plate', label = 'Read the plate', icon = 'fa-solid fa-id-card',
    onSelect = function(target)
        print(target.kind, target.plate, target.netId)
    end
},

Builtins

Built-ins are integrated features. Each one is only accepted in some lists: elsewhere, the engine ignores it with a warning. Sensitive built-ins keep their server permission even if you remove the permission field from the entry.

In the Models and Zones lists, only weather_menu is accepted: the other built-ins declare specific lists that do not include these two types.

Models

Config.ModelInteractions = {
    {
        models = { 'prop_atm_01', 'prop_atm_02' },
        options = {
            { name = 'atm_use', label = 'Use the ATM', icon = 'fa-solid fa-money-bill', type = 'client_event', event = 'my_bank:openAtm' },
        },
    },
}

my_bank:openAtm is an example name. models accepts names or hashes. Model options enable the outline (ox_target:drawOutline) on those objects.

Zones

Config.ZoneInteractions = {
    {
        shape = 'box', name = 'pd_duty', coords = vec3(441.0, -981.0, 30.7), size = vec3(1.5, 1.5, 2.0), rotation = 0,
        options = {
            { name = 'pd_duty', label = 'Go on duty', icon = 'fa-solid fa-clipboard', jobs = { 'police' }, type = 'server_event', event = 'my_pd:duty' },
        },
    },
    {
        shape = 'sphere', coords = vec3(-1037.5, -2737.8, 20.2), radius = 1.2,
        options = {
            { name = 'info_desk', label = 'Front desk', icon = 'fa-solid fa-circle-info', type = 'command', command = 'help' },
        },
    },
}

Fields read by the registry: shape, coords, size, radius, rotation, debug, drawSprite, name and options. Only 'box' and 'sphere' are supported: any other shape value is treated as a box. Polygon zones exist through the addPolyZone export (see API) but not through Config.ZoneInteractions.

Simplified format and native format

config_interactions.lua uses a simplified format, translated by the engine into ox_target’s native format:

In your own resources, ox_target exports (addGlobalVehicle, addModel…) expect the native format: menuName and openMenu, not menu and opens. The type, builtin, permission and jobs fields do not exist there.

Common mistakes

• Invisible option: permission missing from Config.Permissions, menu without a matching category, or feature disabled.
• Built-in in the wrong list: F8 shows a warning that the built-in cannot be used in that list.
• enabled = function() depending on the player: evaluated at start, before the character is loaded. Use canInteract for a dynamic condition.
• server_event for a sensitive action: the server checks nothing; use a server_action.