GraphicsClientNot in this build

registerPtfxFogVolume

_REGISTER_PTFX_FOG_VOLUME

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

SignatureJavaScript
registerPtfxFogVolume(
  posX: number,
  posY: number,
  posZ: number,
  range: number,
  density: number
): void
SignatureLua
registerPtfxFogVolume(
  posX: number,
  posY: number,
  posZ: number,
  range: number,
  density: number
)
⚠
Not in this game build

The global exists, but the native is not part of the game build LS:MP runs: calling it does nothing and returns undefined in JavaScript, nil in Lua. It never throws. See Coverage.

Usage

JavaScript
registerPtfxFogVolume(posX, posY, posZ, range, density);
Lua
registerPtfxFogVolume(posX, posY, posZ, range, density)

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
registerPtfxFogVolume(pos, range, density);
Lua · with vectors
registerPtfxFogVolume(pos, range, density)

Parameters

ParameterTypeJavaScriptLua
posXfloatnumbernumber
posYfloatnumbernumber
posZfloatnumbernumber
rangefloatnumbernumber
densityfloatnumbernumber

Returns

Nothing. In JavaScript the call evaluates to undefined.

Reference

Namespace
Graphics GRAPHICS
In the game
void _REGISTER_PTFX_FOG_VOLUME(float posX, float posY, float posZ, float range, float density)

Open in the interactive natives reference