Skip to content
San Andreas Online Docs

getFireStrength

Shared
SA:O APIManaged fire

Returns the strength multiplier of a managed fire.

Syntax

float|false getFireStrength(fire theFire)

Arguments

theFirefire

Managed fire element.

Returns

The current strength, or false when the element is not a managed fire.

Ownership and lifecycle

A managed fire is an element owned by the resource that created it, so stopping that resource extinguishes its fires. Server-created fires are synchronized to every client, and lifetime is tracked as relative remaining time so a client joining mid-burn receives what is left.

Where this comes from

SOURCECLuaFireDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaFireDefs.cpp and Server/mods/deathmatch/logic/luadefs/CLuaFireDefs.cpp INTRODUCED / EXTENDEDd82ce28aaRead the commit and why the change was made TEST RESOURCE fire-test test-resources/fire-test
RELATED SA:O APIS

Continue exploring

Read the system guide →
createFire Creates a managed fire element when given an options table, or the original native GTA fire otherwise. extinguishFire Destroys one managed fire element, in addition to the standard radius and no-argument forms. setFireStrength Changes how large a managed fire burns, without recreating it.

← Back to the SA:O Lua API · How Managed fire works →