Client
All exports with the options
argument expect a table with the targeting properties here.
For some examples you can refer to defaults.lua (opens in a new tab) or debug.lua (opens in a new tab).
disableTargeting
Toggle the availability of the targeting menu.
exports.ox_target:disableTargeting(state)
- state:
boolean
- Setting
state
totrue
will turn off the targeting eye if it is active and prevent it from reopening untilstate
is set tofalse
again.
- Setting
addGlobalOption
Creates new targetable options which are displayed at all times.
exports.ox_target:addGlobalOption(options)
- options:
TargetOptions
removeGlobalOption
Removes all options from the global options list with the option names.
exports.ox_target:removeGlobalOption(optionNames)
- optionNames:
string
orstring[]
addGlobalObject
Creates new targetable options for all Object entity types.
exports.ox_target:addGlobalObject(options)
- options:
TargetOptions
removeGlobalObject
Removes all options from the global Object list with the option names.
exports.ox_target:removeGlobalObject(optionNames)
- optionNames:
string
orstring[]
addGlobalPed
Creates new targetable options for all Ped entity types (excluding players).
exports.ox_target:addGlobalPed(options)
- options:
TargetOptions
removeGlobalPed
Removes all options from the global Ped list with the option names.
exports.ox_target:removeGlobalPed(optionNames)
- optionNames:
string
orstring[]
addGlobalPlayer
Creates new targetable options for all Player entities.
exports.ox_target:addGlobalPlayer(options)
- options:
TargetOptions
removeGlobalPlayer
Removes all options from the global Player list with the option names.
exports.ox_target:removeGlobalPlayer(optionNames)
- optionNames:
string
orstring[]
addGlobalVehicle
Creates new targetable options for all Vehicle entity types.
exports.ox_target:addGlobalVehicle(options)
- options:
TargetOptions
removeGlobalVehicle
Removes all options from the global Vehicle list with the option names.
exports.ox_target:removeGlobalVehicle(optionNames)
- optionNames:
string
orstring[]
addModel
Creates new targetable options for a specific model or list of models.
exports.ox_target:addModel(models, options)
- models:
number
orstring
orArray<number | string>
- options:
TargetOptions
removeModel
Removes all options from the models list with the option names.
exports.ox_target:removeModel(models, optionNames)
- models:
number
orstring
orArray<number | string>
- optionNames:
string
orstring[]
addEntity
Creates new targetable options for a specific network id or list of network ids (see NetworkGetNetworkIdFromEntity (opens in a new tab)).
exports.ox_target:addEntity(netIds, options)
- netIds:
number
ornumber[]
- options:
TargetOptions
removeEntity
Removes all options from the networked entities list with the option names.
exports.ox_target:removeEntity(netIds, optionNames)
- netIds:
number
ornumber[]
- optionNames:
string
orstring[]
addLocalEntity
Creates new targetable options for a specific entity handle or list of entity handles.
exports.ox_target:addLocalEntity(entities, options)
- entities:
number
ornumber[]
- options:
TargetOptions
removeLocalEntity
Removes all options from the entities list with the option names.
exports.ox_target:removeLocalEntity(entities, optionNames)
- entities:
number
ornumber[]
- optionNames:
string
orstring[]
addSphereZone
Creates a new targetable sphere zone.
exports.ox_target:addSphereZone(parameters)
- parameters:
table
- coords:
vector3
- name?:
string
- An optional name to refer to the zone instead of using the
id
.
- An optional name to refer to the zone instead of using the
- radius?:
number
- debug?:
boolean
- drawSprite?:
boolean
- Draw a sprite at the centroid of the zone. Defaults to
true
.
- Draw a sprite at the centroid of the zone. Defaults to
- options:
TargetOptions
- coords:
Return:
- id:
number
addBoxZone
Creates a new targetable box zone.
exports.ox_target:addBoxZone(parameters)
- parameters:
table
- coords:
vector3
- name?:
string
- An optional name to refer to the zone instead of using the
id
.
- An optional name to refer to the zone instead of using the
- size?:
vector3
- rotation?:
number
- debug?:
boolean
- drawSprite?:
boolean
- Draw a sprite at the centroid of the zone. Defaults to
true
.
- Draw a sprite at the centroid of the zone. Defaults to
- options:
TargetOptions
- coords:
Return:
- id:
number
addPolyZone
Creates a new targetable poly zone.
exports.ox_target:addPolyZone(parameters)
- parameters:
table
- points:
vector3[]
- An array of 3d points defining the polygon's shape.
- name?:
string
- An optional name to refer to the zone instead of using the
id
.
- An optional name to refer to the zone instead of using the
- thickness?:
number
- The height of the polygon, defaulting to
4
.
- The height of the polygon, defaulting to
- debug?:
boolean
- drawSprite?:
boolean
- Draw a sprite at the centroid of the zone. Defaults to
true
.
- Draw a sprite at the centroid of the zone. Defaults to
- options:
TargetOptions
- points:
Return:
- id:
number
removeZone
Removes a targetable zone with the given id (returned by addBoxZone/addSphereZone).
exports.ox_target:removeZone(id)
- id:
number
orstring
- The
number
id that is returned by addSphereZone, addBoxZone, or addPolyZone
OR - The
string
name given to the zone.
- The