Prompt Options

Last updated on

Each call to show takes a group table. Each item in prompts is a PromptEntry.

Prompt group

Prompt entry

A prompt needs a label and at least one of control, keybind, key, keyboard, gamepad, or icon. Prefer control or keybind. Icons are resolved from the live mapping, including player remaps. key / keyboard / gamepad are optional overrides.

{
    id = 'engine',
    label = 'Engine',
    control = 23,
    holdTime = 1500,
}

Actions

One action runs when the prompt fires, in this order:

1. onSelect
2. export
3. event
4. serverEvent
5. command

Press fires the action immediately. holdTime waits until the hold completes. onPressed / onHold / onReleased still run as hooks.

{
    id = 'lock',
    label = 'Lock',
    control = 182,
    event = 'myresource:lockVehicle',
}

{
    id = 'engine',
    label = 'Engine',
    control = 23,
    holdTime = 1500,
    serverEvent = 'myresource:toggleEngine',
}

{
    id = 'emote',
    label = 'Wave',
    control = 47,
    command = 'e wave',
}

The callback or event receives:

export is called as exports[resource][export](nil, data) on the resource that registered the prompt.

Restrictions

Same filters as Interact. A prompt is hidden (and cannot fire) until every check passes. Filters re-run while the group is open.

{
    id = 'lockpick',
    label = 'Lockpick',
    control = 38,
    groups = { police = 0, mechanic = 2 },
    items = { lockpick = 1 },
    allowInVehicle = true,
    canInteract = function(entity, distance, coords, name)
        return distance < 2.0 and not IsPedDeadOrDying(cache.ped, true)
    end,
}

Jobs and gangs come from the running framework (qbx, qb, esx, ox_core, ND). Item counts use wasabi_inventory when it is started, otherwise ox_inventory.

canInteract is called as canInteract(entity, distance, coords, name), same as Interact. Set entity or coords on the group or the prompt so distance is measured from the player to that point. If neither is set, entity is 0 and coords is the player.

World targets pass the entity or the coord in for you. See World targets.

Live remapping

Open prompts keep their icons in sync with the player's current binds.

auto mode also swaps keyboard vs gamepad icons when the last input device changes. key / keyboard / gamepad override the live glyph when you set them.

{ id = 'enter', label = 'Enter', control = 38 }
{ id = 'use', label = 'Use', keybind = 'my_use' }

Positions

Named slots:

top-left, top-center, top-right, middle-left, center, middle-right, bottom-left, bottom-center, bottom-right.

Aliases: top, bottom, left, right, center-left, center-right, center-top, center-bottom.

Custom:

prompts.setPosition('vehicle', { x = 82, y = 18, origin = 'top-right' })

x and y are percents of the screen. origin is the transform origin (defaults to center).

Gamepad names

Names follow Xbox layout. PlayStation icons remap automatically.

Keyboard names include letters, F1 to F12, Shift, Ctrl, Alt, Enter, Space, LMB, RMB, and similar aliases.

Arrays draw combo keys:

{ keyboard = { 'Ctrl', 'E' }, gamepad = 'A', label = 'Interact' }