MiscClient

clearAreaOfPeds

CLEAR_AREA_OF_PEDS0xBE31FD6CE464AC59

The GTA V native CLEAR_AREA_OF_PEDS of the MISC namespace, as LS:MP client scripts call it: the global function clearAreaOfPeds, in JavaScript and in Lua.

SignatureJavaScript
clearAreaOfPeds(
  x: number,
  y: number,
  z: number,
  radius: number,
  flags: number
): void
SignatureLua
clearAreaOfPeds(
  x: number,
  y: number,
  z: number,
  radius: number,
  flags: integer
)

Usage

JavaScript
clearAreaOfPeds(x, y, z, radius, flags);
Lua
clearAreaOfPeds(x, y, z, radius, flags)

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
clearAreaOfPeds(pos, radius, flags);
Lua · with vectors
clearAreaOfPeds(pos, radius, flags)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
radiusfloatnumbernumber
flagsintnumberinteger

Returns

Nothing. In JavaScript the call evaluates to undefined.

Notes

From the community native database. Names are LS:MP’s; samples may be written for C++ or another framework.

Example:       clearAreaOfPeds(0, 0, 0, 10000, 1);

Reference

Namespace
Misc MISC
In the game
void CLEAR_AREA_OF_PEDS(float x, float y, float z, float radius, int flags)
Hash
0xBE31FD6CE464AC59

Open in the interactive natives reference