TasksClient

isScenarioOccupied

IS_SCENARIO_OCCUPIED0x788756D73AC2E07C

The GTA V native IS_SCENARIO_OCCUPIED of the TASK namespace, as LS:MP client scripts call it: the global function isScenarioOccupied, in JavaScript and in Lua.

SignatureJavaScript
isScenarioOccupied(
  x: number,
  y: number,
  z: number,
  maxRange: number,
  onlyUsersActuallyAtScenario: boolean
): boolean
SignatureLua
isScenarioOccupied(
  x: number,
  y: number,
  z: number,
  maxRange: number,
  onlyUsersActuallyAtScenario: boolean
): boolean

Usage

JavaScript
const result = isScenarioOccupied(x, y, z, maxRange, onlyUsersActuallyAtScenario);
Lua
local result = isScenarioOccupied(x, y, z, maxRange, onlyUsersActuallyAtScenario)

Three consecutive numbers can be given as one vector: { x, y, z } (or [x, y, z]) in JavaScript, a Vector3 in Lua.

JavaScript · with vectors
const result = isScenarioOccupied(pos, maxRange, onlyUsersActuallyAtScenario);
Lua · with vectors
local result = isScenarioOccupied(pos, maxRange, onlyUsersActuallyAtScenario)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
maxRangefloatnumbernumber
onlyUsersActuallyAtScenarioBOOLbooleanboolean

Returns

BOOL JavaScript boolean, Lua boolean

Reference

Namespace
Tasks TASK
In the game
BOOL IS_SCENARIO_OCCUPIED(float x, float y, float z, float maxRange, BOOL onlyUsersActuallyAtScenario)
Hash
0x788756D73AC2E07C

Open in the interactive natives reference