FireClient

startScriptFire

START_SCRIPT_FIRE0x6B83617E04503888

The GTA V native START_SCRIPT_FIRE of the FIRE namespace, as LS:MP client scripts call it: the global function startScriptFire, in JavaScript and in Lua.

SignatureJavaScript
startScriptFire(
  X: number,
  Y: number,
  Z: number,
  maxChildren: number,
  isGasFire: boolean
): FireId
SignatureLua
startScriptFire(
  X: number,
  Y: number,
  Z: number,
  maxChildren: integer,
  isGasFire: boolean
): FireId

Usage

JavaScript
const fire = startScriptFire(X, Y, Z, maxChildren, isGasFire);
Lua
local fire = startScriptFire(X, Y, Z, maxChildren, isGasFire)

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 fire = startScriptFire(pos, maxChildren, isGasFire);
Lua · with vectors
local fire = startScriptFire(pos, maxChildren, isGasFire)

Parameters

ParameterTypeJavaScriptLua
Xfloatnumbernumber
Yfloatnumbernumber
Zfloatnumbernumber
maxChildrenintnumberinteger
isGasFireBOOLbooleanboolean

Returns

FireId JavaScript number, Lua integer

Handle of a script fire.

Notes

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

Starts a fire:

xyz: Location of fire
maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing.
isGasFire: Whether or not the fire is powered by gasoline.

Reference

Namespace
Fire FIRE
In the game
FireId START_SCRIPT_FIRE(float X, float Y, float Z, int maxChildren, BOOL isGasFire)
Hash
0x6B83617E04503888

Open in the interactive natives reference