GraphicsClient

terraingridSetParams

TERRAINGRID_SET_PARAMS0x1C4FC5752BCD8E48

The GTA V native TERRAINGRID_SET_PARAMS of the GRAPHICS namespace, as LS:MP client scripts call it: the global function terraingridSetParams, in JavaScript and in Lua.

SignatureJavaScript
terraingridSetParams(
  x: number,
  y: number,
  z: number,
  forwardX: number,
  forwardY: number,
  forwardZ: number,
  sizeX: number,
  sizeY: number,
  sizeZ: number,
  gridScale: number,
  glowIntensity: number,
  normalHeight: number,
  heightDiff: number
): void
SignatureLua
terraingridSetParams(
  x: number,
  y: number,
  z: number,
  forwardX: number,
  forwardY: number,
  forwardZ: number,
  sizeX: number,
  sizeY: number,
  sizeZ: number,
  gridScale: number,
  glowIntensity: number,
  normalHeight: number,
  heightDiff: number
)

Usage

JavaScript
terraingridSetParams(
  x, y, z, forwardX, forwardY, forwardZ, sizeX, sizeY, sizeZ, gridScale, glowIntensity,
  normalHeight, heightDiff
);
Lua
terraingridSetParams(
    x, y, z, forwardX, forwardY, forwardZ, sizeX, sizeY, sizeZ, gridScale, glowIntensity,
    normalHeight, heightDiff
)

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
terraingridSetParams(pos, forward, size, gridScale, glowIntensity, normalHeight, heightDiff);
Lua · with vectors
terraingridSetParams(pos, forward, size, gridScale, glowIntensity, normalHeight, heightDiff)

Parameters

ParameterTypeJavaScriptLua
xfloatnumbernumber
yfloatnumbernumber
zfloatnumbernumber
forwardXfloatnumbernumber
forwardYfloatnumbernumber
forwardZfloatnumbernumber
sizeXfloatnumbernumber
sizeYfloatnumbernumber
sizeZfloatnumbernumber
gridScalefloatnumbernumber
glowIntensityfloatnumbernumber
normalHeightfloatnumbernumber
heightDifffloatnumbernumber

Returns

Nothing. In JavaScript the call evaluates to undefined.

Notes

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

This native is used along with these two natives: terraingridActivate and terraingridSetColours.
This native configures the location, size, rotation, normal height, and the difference ratio between min, normal and max.

This native renders a box at the given position, with a special shader that renders a grid on world geometry behind it. This box does not have backface culling.
The forward args here are a direction vector, something similar to what's returned by getEntityForwardVector.
normalHeight and heightDiff are used for positioning the color gradient of the grid, colors specified via terraingridSetColours.

Example with box superimposed on the image to demonstrate: https://i.imgur.com/wdqskxd.jpg

Reference

Namespace
Graphics GRAPHICS
In the game
void TERRAINGRID_SET_PARAMS(float x, float y, float z, float forwardX, float forwardY, float forwardZ, float sizeX, float sizeY, float sizeZ, float gridScale, float glowIntensity, float normalHeight, float heightDiff)
Hash
0x1C4FC5752BCD8E48

Open in the interactive natives reference