startShapeTestCapsule

START_SHAPE_TEST_CAPSULE0x28579D1B8F8AAC80

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

SignatureJavaScript
startShapeTestCapsule(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number,
  radius: number,
  flags: number,
  entity: Entity,
  p9: number
): number
SignatureLua
startShapeTestCapsule(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number,
  radius: number,
  flags: integer,
  entity: Entity,
  p9: integer
): integer

Usage

JavaScript
const result = startShapeTestCapsule(x1, y1, z1, x2, y2, z2, radius, flags, entity, p9);
Lua
local result = startShapeTestCapsule(x1, y1, z1, x2, y2, z2, radius, flags, entity, p9)

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

Parameters

ParameterTypeJavaScriptLua
x1floatnumbernumber
y1floatnumbernumber
z1floatnumbernumber
x2floatnumbernumber
y2floatnumbernumber
z2floatnumbernumber
radiusfloatnumbernumber
flagsintnumberinteger
entityEntitynumberinteger
p9intnumberinteger

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.

Raycast from point to point, where the ray has a radius.

flags:
vehicles=10
peds =12

Iterating through flags yields many ped / vehicle/ object combinations

p9 = 7, but no idea what it does

Entity is an entity to ignore

Reference

Namespace
Shape tests SHAPETEST
In the game
int START_SHAPE_TEST_CAPSULE(float x1, float y1, float z1, float x2, float y2, float z2, float radius, int flags, Entity entity, int p9)
Hash
0x28579D1B8F8AAC80
Formerly
_CAST_3D_RAY_POINT_TO_POINT

Open in the interactive natives reference