setFireSpreadEnabled
Shared
Allows or prevents a managed fire from spreading.
Syntax
bool setFireSpreadEnabled(fire theFire, bool enabled)Arguments
theFirefireManaged fire element.
enabledboolWhether the fire may spread.
Returns
true when applied; false for an invalid element.
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.
Important behavior
- Spreading is off by default. Pair it with setFireMaxGenerations to bound how far it can go.
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 NEON APIS
Read the system guide →