Gameplay::getGroundZFor3dCoord
Client-Side Function
 JavaScript
|
|---|
JavaScript Syntax
Returns the first surface beneath the specified elevation (at the given location).
This can be a roof, an elevated road, or the ground.
(If no surface can be found beneath, then the returned boolean will be false, and the float will contain 0.)
For water positions the sea floor will be returned (negative value).
For the function to work reliably, the position tested should have been streamed already (i.e. close to the player); otherwise it might return 0.
Required Params
- x: float - X-coordinate of location to test
- y: float - Y-coordinate of location to test
- z: float - Z-coordinate, beneath which to test
- waterAsGround: Boolean
- waterLevelCheck: boolean
Syntax
mp.game.gameplay.getGroundZFor3dCoord(x, y, z, waterAsGround, waterLevelCheck);
Example
const {position} = mp.players.local;
const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, 0.0, false);
mp.markers.new(1, new mp.Vector3(position.x, position.y, getGroundZ), 1.5, { color: [0, 255, 0, 100], visible: true });