TasksClient

taskGuardSphereDefensiveArea

TASK_GUARD_SPHERE_DEFENSIVE_AREA0xC946FE14BE0EB5E2

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

SignatureJavaScript
taskGuardSphereDefensiveArea(
  ped: Ped,
  defendPositionX: number,
  defendPositionY: number,
  defendPositionZ: number,
  heading: number,
  maxPatrolProximity: number,
  time: number,
  x: number,
  y: number,
  z: number,
  defensiveAreaRadius: number
): void
SignatureLua
taskGuardSphereDefensiveArea(
  ped: Ped,
  defendPositionX: number,
  defendPositionY: number,
  defendPositionZ: number,
  heading: number,
  maxPatrolProximity: number,
  time: integer,
  x: number,
  y: number,
  z: number,
  defensiveAreaRadius: number
)

Usage

JavaScript
taskGuardSphereDefensiveArea(
  ped, defendPositionX, defendPositionY, defendPositionZ, heading, maxPatrolProximity, time, x,
  y, z, defensiveAreaRadius
);
Lua
taskGuardSphereDefensiveArea(
    ped, defendPositionX, defendPositionY, defendPositionZ, heading, maxPatrolProximity, time,
    x, y, z, defensiveAreaRadius
)

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
taskGuardSphereDefensiveArea(
  ped, defendPosition, heading, maxPatrolProximity, time, pos, defensiveAreaRadius
);
Lua · with vectors
taskGuardSphereDefensiveArea(
    ped, defendPosition, heading, maxPatrolProximity, time, pos, defensiveAreaRadius
)

Parameters

ParameterTypeJavaScriptLua
pedPednumberinteger
defendPositionXfloatnumbernumber
defendPositionYfloatnumbernumber
defendPositionZfloatnumbernumber
headingfloatnumbernumber
maxPatrolProximityfloatnumbernumber
timeintnumberinteger
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
defensiveAreaRadiusfloatnumbernumber

Returns

Nothing. In JavaScript the call evaluates to undefined.

Reference

Namespace
Tasks TASK
In the game
void TASK_GUARD_SPHERE_DEFENSIVE_AREA(Ped ped, float defendPositionX, float defendPositionY, float defendPositionZ, float heading, float maxPatrolProximity, int time, float x, float y, float z, float defensiveAreaRadius)
Hash
0xC946FE14BE0EB5E2

Open in the interactive natives reference