Target (client). Client-only targeting (ox_target, tgiann-target, core_focus, qb-target, sleepless_interact, interact, or bl_sprites).

Target (client)

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

Each option needs a unique name and display label.

No server implementation.

Zones

`addBoxZone(payload)`

addBoxZone(payload)

Param	Type
`payload`	TargetBoxZone

| Returns | number | string — zone id |

Usage Example

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)`

addSphereZone(payload)

Param	Type
`payload`	TargetSphereZone

| Returns | number | string — zone id |

Usage Example

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)`

Param	Type
`zoneId`	`string` \| `number`

bridge.target.removeZone('shop_zone')

Entities

`addLocalEntity(entities, options)`

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

Param	Type
`entities`	`number` \| `number[]`
`options`	`TargetOption` \| `TargetOption[]`

`removeLocalEntity(entities, optionNames?)`

removeLocalEntity(entities, optionNames)

Param	Type
`entities`	`number` \| `number[]`
`optionNames`	`string` \| `string[]?`

Usage Example

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

`addEntity(netIds, options)`

Param	Type
`netIds`	`number` \| `number[]`
`options`	`TargetOption` \| `TargetOption[]`

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

`removeEntity(netIds, optionNames?)`

Param	Type
`netIds`	`number` \| `number[]`
`optionNames`	`string` \| `string[]?`

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

Global targets

`addGlobalPed(options)`

No-op on interact — that resource has no global-ped API.

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

`removeGlobalPed(optionNames?)`

bridge.target.removeGlobalPed('talk_npc')

`addGlobalPlayer(options)`

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

`removeGlobalPlayer(optionNames?)`

bridge.target.removeGlobalPlayer('search_player')

`addGlobalVehicle(options)`

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

`removeGlobalVehicle(optionNames?)`

bridge.target.removeGlobalVehicle('lockpick_door')

Models

`addModel(models, options)`

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

Param	Type
`models`	`string` \| `number` \| `string[]` \| `number[]`
`options`	`TargetOption` \| `TargetOption[]`

`removeModel(models, optionNames?)`

removeModel(models, optionNames)

Param	Type
`models`	`string` \| `number` \| `string[]` \| `number[]`
`optionNames`	`string` \| `string[]?`

Usage Example

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

`disableTargeting(disable)`

disableTargeting(disable)

Param	Type
`disable`	`boolean`

Usage Example

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

Types

`TargetOption`

Field	Type
`name`	`string`
`label`	`string`
`icon`	`string?`
`distance`	`number?`
`groups`	`table?`
`items`	`string` \| `string[]?`
`anyItem`	`boolean?`
`canInteract`	`fun(entity: number, distance: number, coords: vector3, name: string, bone?: number): boolean`
`onSelect`	`fun(data: table)?`
`event`	`string?`
`serverEvent`	`string?`
`args`	`any?`

`TargetBoxZone`

Field	Type
`name`	`string?`
`coords`	`vector3` \| `vector3[]`
`size`	`vector3?`
`rotation`	`number?`
`debug`	`boolean?`
`options`	`TargetOption` \| `TargetOption[]`

`TargetSphereZone`

Field	Type
`name`	`string?`
`coords`	`vector3`
`radius`	`number?`
`debug`	`boolean?`
`options`	`TargetOption` \| `TargetOption[]`

Client

On this page