startShapeTestLosProbe

START_SHAPE_TEST_LOS_PROBE0x7EE9F5D83DD4F90E

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

SignatureJavaScript
startShapeTestLosProbe(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number,
  flags: number,
  entity: Entity,
  p8: number
): number
SignatureLua
startShapeTestLosProbe(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number,
  flags: integer,
  entity: Entity,
  p8: integer
): integer

Usage

JavaScript
const result = startShapeTestLosProbe(x1, y1, z1, x2, y2, z2, flags, entity, p8);
Lua
local result = startShapeTestLosProbe(x1, y1, z1, x2, y2, z2, flags, entity, p8)

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 = startShapeTestLosProbe(pos1, pos2, flags, entity, p8);
Lua · with vectors
local result = startShapeTestLosProbe(pos1, pos2, flags, entity, p8)

Parameters

ParameterTypeJavaScriptLua
x1floatnumbernumber
y1floatnumbernumber
z1floatnumbernumber
x2floatnumbernumber
y2floatnumbernumber
z2floatnumbernumber
flagsintnumberinteger
entityEntitynumberinteger
p8intnumberinteger

Returns

int JavaScript number, Lua integer

Notes

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

Asynchronously starts a line-of-sight (raycast) world probe shape test.

Use the handle with getShapeTestResult or getShapeTestResultIncludingMaterial until it returns 0 or 2.

p8 is a bit mask with bits 1, 2 and/or 4, relating to collider types; 4 should usually be used.

Reference

Namespace
Shape tests SHAPETEST
In the game
int START_SHAPE_TEST_LOS_PROBE(float x1, float y1, float z1, float x2, float y2, float z2, int flags, Entity entity, int p8)
Hash
0x7EE9F5D83DD4F90E

Open in the interactive natives reference