startScriptFire
START_SCRIPT_FIRE0x6B83617E04503888The 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.
startScriptFire(
X: number,
Y: number,
Z: number,
maxChildren: number,
isGasFire: boolean
): FireIdstartScriptFire(
X: number,
Y: number,
Z: number,
maxChildren: integer,
isGasFire: boolean
): FireIdUsage
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
| Parameter | Type | JavaScript | Lua |
|---|---|---|---|
X | float | number | number |
Y | float | number | number |
Z | float | number | number |
maxChildren | int | number | integer |
isGasFire | BOOL | boolean | boolean |
Returns
FireId JavaScript number, Lua integerHandle 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