WaterClient1 output

testProbeAgainstWater

TEST_PROBE_AGAINST_WATER0xFFA5D878809819DB

The GTA V native TEST_PROBE_AGAINST_WATER of the WATER namespace, as LS:MP client scripts call it: the global function testProbeAgainstWater, in JavaScript and in Lua.

SignatureJavaScript
testProbeAgainstWater(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number
): [ok: boolean, result: { x: number, y: number, z: number }]
SignatureLua
testProbeAgainstWater(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number
): boolean, Vector3

Usage

JavaScript
const [ok, result] = testProbeAgainstWater(x1, y1, z1, x2, y2, z2);
Lua
local ok, result = testProbeAgainstWater(x1, y1, z1, x2, y2, z2)

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 [ok, result] = testProbeAgainstWater(pos1, pos2);
Lua · with vectors
local ok, result = testProbeAgainstWater(pos1, pos2)

Parameters

ParameterTypeJavaScriptLua
x1floatnumbernumber
y1floatnumbernumber
z1floatnumbernumber
x2floatnumbernumber
y2floatnumbernumber
z2floatnumbernumber

Returns

2 values, in this order: an array in JavaScript, multiple return values in Lua.

#ValueTypeJavaScriptLuaDescription
1okBOOLbooleanbooleanThe native’s own return value.
2resultVector3{ x: number, y: number, z: number }Vector3output

Reference

Namespace
Water WATER
In the game
BOOL TEST_PROBE_AGAINST_WATER(float x1, float y1, float z1, float x2, float y2, float z2, Vector3* result)
Hash
0xFFA5D878809819DB

Open in the interactive natives reference