WaterClient1 output

testProbeAgainstAllWater

TEST_PROBE_AGAINST_ALL_WATER0x8974647ED222EA5F

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

SignatureJavaScript
testProbeAgainstAllWater(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number,
  flags: number
): [result: number, waterHeight: number]
SignatureLua
testProbeAgainstAllWater(
  x1: number,
  y1: number,
  z1: number,
  x2: number,
  y2: number,
  z2: number,
  flags: integer
): integer, number

Usage

JavaScript
const [result, waterHeight] = testProbeAgainstAllWater(x1, y1, z1, x2, y2, z2, flags);
Lua
local result, waterHeight = testProbeAgainstAllWater(x1, y1, z1, x2, y2, z2, 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
const [result, waterHeight] = testProbeAgainstAllWater(pos1, pos2, flags);
Lua · with vectors
local result, waterHeight = testProbeAgainstAllWater(pos1, pos2, flags)

Parameters

ParameterTypeJavaScriptLua
x1floatnumbernumber
y1floatnumbernumber
z1floatnumbernumber
x2floatnumbernumber
y2floatnumbernumber
z2floatnumbernumber
flagsintnumberinteger

Returns

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

#ValueTypeJavaScriptLuaDescription
1resultintnumberintegerThe native’s own return value.
2waterHeightfloatnumbernumberoutput

Reference

Namespace
Water WATER
In the game
int TEST_PROBE_AGAINST_ALL_WATER(float x1, float y1, float z1, float x2, float y2, float z2, int flags, float* waterHeight)
Hash
0x8974647ED222EA5F

Open in the interactive natives reference