WaterClient1 output

testVerticalProbeAgainstAllWater

TEST_VERTICAL_PROBE_AGAINST_ALL_WATER0x2B3451FA1E3142E2

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

SignatureJavaScript
testVerticalProbeAgainstAllWater(
  x: number,
  y: number,
  z: number,
  flags: number
): [result: number, waterHeight: number]
SignatureLua
testVerticalProbeAgainstAllWater(
  x: number,
  y: number,
  z: number,
  flags: integer
): integer, number

Usage

JavaScript
const [result, waterHeight] = testVerticalProbeAgainstAllWater(x, y, z, flags);
Lua
local result, waterHeight = testVerticalProbeAgainstAllWater(x, y, z, 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] = testVerticalProbeAgainstAllWater(pos, flags);
Lua · with vectors
local result, waterHeight = testVerticalProbeAgainstAllWater(pos, flags)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
flagsintnumberinteger

Returns

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

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

Notes

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

Reference

Namespace
Water WATER
In the game
int TEST_VERTICAL_PROBE_AGAINST_ALL_WATER(float x, float y, float z, int flags, float* waterHeight)
Hash
0x2B3451FA1E3142E2

Open in the interactive natives reference