Target (client)

Client-only targeting (ox_target, tgiann-target, core_focus, qb-target, or sleepless_interact).

Each option needs a unique name and display label.

No server implementation.

Zones

addBoxZone(payload)

Signature: addBoxZone(payload: TargetBoxZone): number | string

| Returns | number | string — zone id |

bridge.target.addBoxZone({
    name = 'shop_zone',
    coords = vec3(100.0, 200.0, 30.0),
    size = vec3(2, 2, 2),
    rotation = 0,
    options = {
        {
            name = 'open_shop',
            label = 'Open Shop',
            icon = 'fa-solid fa-cart-shopping',
            onSelect = function() end,
        },
    },
})

addSphereZone(payload)

Signature: addSphereZone(payload: TargetSphereZone): number | string

| Returns | number | string — zone id |

bridge.target.addSphereZone({
    name = 'atm_zone',
    coords = vec3(0, 0, 0),
    radius = 1.5,
    options = { { name = 'use_atm', label = 'Use ATM', onSelect = function() end } },
})

removeZone(zoneId)

Signature: removeZone(zoneId: string | number): void

bridge.target.removeZone('shop_zone')

Entities

addLocalEntity(entities, options)

Signature: addLocalEntity(entities: number | number[], options: TargetOption | TargetOption[]): void

bridge.target.addLocalEntity(entity, {
    {
        name = 'open_stash',
        label = 'Open stash',
        distance = 2.0,
        onSelect = function(data) end,
    },
})

removeLocalEntity(entities, optionNames?)

Signature: removeLocalEntity(entities: number | number[], optionNames?: string | string[]): void

bridge.target.removeLocalEntity(entity, 'open_stash')

addEntity(netIds, options)

Signature: addEntity(netIds: number | number[], options: TargetOption | TargetOption[]): void

bridge.target.addEntity(netId, {
    { name = 'inspect', label = 'Inspect', onSelect = function() end },
})

removeEntity(netIds, optionNames?)

Signature: removeEntity(netIds: number | number[], optionNames?: string | string[]): void

bridge.target.removeEntity(netId, 'inspect')

Global targets

addGlobalPed(options)

Signature: addGlobalPed(options: TargetOption | TargetOption[]): void

bridge.target.addGlobalPed({
    {
        name = 'talk_npc',
        label = 'Talk',
        distance = 2.0,
        onSelect = function(data) end,
    },
})

removeGlobalPed(optionNames?)

Signature: removeGlobalPed(optionNames?: string | string[]): void

bridge.target.removeGlobalPed('talk_npc')

addGlobalPlayer(options)

Signature: addGlobalPlayer(options: TargetOption | TargetOption[]): void

bridge.target.addGlobalPlayer({
    {
        name = 'search_player',
        label = 'Search',
        onSelect = function() end,
    },
})

removeGlobalPlayer(optionNames?)

Signature: removeGlobalPlayer(optionNames?: string | string[]): void

bridge.target.removeGlobalPlayer('search_player')

addGlobalVehicle(options)

Signature: addGlobalVehicle(options: TargetOption | TargetOption[]): void

removeGlobalVehicle(optionNames?)

Signature: removeGlobalVehicle(optionNames?: string | string[]): void

bridge.target.addGlobalVehicle({
    {
        name = 'lockpick_door',
        label = 'Lockpick',
        items = 'lockpick',
        onSelect = function() end,
    },
})
 
bridge.target.removeGlobalVehicle('lockpick_door')

Models

addModel(models, options)

Signature: addModel(models: string | number | string[] | number[], options: TargetOption | TargetOption[]): void

bridge.target.addModel('prop_atm_01', {
    { name = 'use_atm', label = 'Use ATM', onSelect = function() end },
})

removeModel(models, optionNames?)

Signature: removeModel(models: string | number | string[] | number[], optionNames?: string | string[]): void

bridge.target.removeModel('prop_atm_01', 'use_atm')

disableTargeting(disable)

Signature: disableTargeting(disable: boolean): void

bridge.target.disableTargeting(true)  -- disable all targeting
bridge.target.disableTargeting(false) -- re-enable

Types

TargetOption

TargetBoxZone

TargetSphereZone