Ox Target
Functions
Client

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 to true will turn off the targeting eye if it is active and prevent it from reopening until state is set to false again.

isActive

Checks if the targeting system is currently active.

exports.ox_target:isActive()

Return:

  • boolean - Returns true if the targeting system is active, otherwise false.

getTargetOptions

Retrieves targeting options for a specific entity.

exports.ox_target:getTargetOptions(entity, entityType, model)
  • entity?: number - The entity handle
  • entityType?: number - The type of entity (1 for peds, 2 for vehicles, 3 for objects)
  • model?: number - The model hash of the entity

Return:

  • table - Returns a table containing the target options for the entity:
    • global: Options for the entity type (peds, vehicles, or objects)
    • model: Options for the specific model
    • entity: Options for the networked entity
    • localEntity: Options for the local entity

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 or string[]

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 or string[]

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 or string[]

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 or string[]

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 or string[]

addModel

Creates new targetable options for a specific model or list of models.

exports.ox_target:addModel(models, options)
  • models: number or string or Array<number | string>
  • options: TargetOptions

removeModel

Removes all options from the models list with the option names.

exports.ox_target:removeModel(models, optionNames)
  • models: number or string or Array<number | string>
  • optionNames: string or string[]

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 or number[]
  • options: TargetOptions

removeEntity

Removes all options from the networked entities list with the option names.

exports.ox_target:removeEntity(netIds, optionNames)
  • netIds: number or number[]
  • optionNames: string or string[]

addLocalEntity

Creates new targetable options for a specific entity handle or list of entity handles.

exports.ox_target:addLocalEntity(entities, options)
  • entities: number or number[]
  • options: TargetOptions

removeLocalEntity

Removes all options from the entities list with the option names.

exports.ox_target:removeLocalEntity(entities, optionNames)
  • entities: number or number[]
  • optionNames: string or string[]

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.
    • radius?: number
    • debug?: boolean
    • drawSprite?: boolean
      • Draw a sprite at the centroid of the zone. Defaults to true.
    • options: TargetOptions

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.
    • size?: vector3
    • rotation?: number
    • debug?: boolean
    • drawSprite?: boolean
      • Draw a sprite at the centroid of the zone. Defaults to true.
    • options: TargetOptions

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.
    • thickness?: number
      • The height of the polygon, defaulting to 4.
    • debug?: boolean
    • drawSprite?: boolean
      • Draw a sprite at the centroid of the zone. Defaults to true.
    • options: TargetOptions

Return:

  • id: number

zoneExists

Checks if a zone with the given ID exists.

exports.ox_target:zoneExists(id)

Return:

  • boolean - Returns true if the zone exists, otherwise false.

removeZone

Removes a targetable zone with the given id (returned by addBoxZone/addSphereZone).

exports.ox_target:removeZone(id)
TargetOptions