startShapeTestBox

START_SHAPE_TEST_BOX0xFE466162C4401D18

The GTA V native START_SHAPE_TEST_BOX of the SHAPETEST namespace, as LS:MP client scripts call it: the global function startShapeTestBox, in JavaScript and in Lua.

SignatureJavaScript
startShapeTestBox(
  x: number,
  y: number,
  z: number,
  dimX: number,
  dimY: number,
  dimZ: number,
  rotX: number,
  rotY: number,
  rotZ: number,
  p9: any,
  flags: number,
  entity: Entity,
  p12: any
): number
SignatureLua
startShapeTestBox(
  x: number,
  y: number,
  z: number,
  dimX: number,
  dimY: number,
  dimZ: number,
  rotX: number,
  rotY: number,
  rotZ: number,
  p9: any,
  flags: integer,
  entity: Entity,
  p12: any
): integer

Usage

JavaScript
const result = startShapeTestBox(
  x, y, z, dimX, dimY, dimZ, rotX, rotY, rotZ, p9, flags, entity, p12
);
Lua
local result = startShapeTestBox(
    x, y, z, dimX, dimY, dimZ, rotX, rotY, rotZ, p9, flags, entity, p12
)

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 = startShapeTestBox(pos, dim, rot, p9, flags, entity, p12);
Lua · with vectors
local result = startShapeTestBox(pos, dim, rot, p9, flags, entity, p12)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
dimXfloatnumbernumber
dimYfloatnumbernumber
dimZfloatnumbernumber
rotXfloatnumbernumber
rotYfloatnumbernumber
rotZfloatnumbernumber
p9Anyanyany
flagsintnumberinteger
entityEntitynumberinteger
p12Anyanyany

Returns

int JavaScript number, Lua integer

Reference

Namespace
Shape tests SHAPETEST
In the game
int START_SHAPE_TEST_BOX(float x, float y, float z, float dimX, float dimY, float dimZ, float rotX, float rotY, float rotZ, Any p9, int flags, Entity entity, Any p12)
Hash
0xFE466162C4401D18

Open in the interactive natives reference