This function is used to extinguish all spreading fire, or spreading fire at specified coordinates.

Syntax

bool extinguishFire ( [ float x = nil, float y = nil, float z = nil, float radius = 1.0 ] )

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• x (default: nil): The X coordinate at which any fire will be extinguished.
• y (default: nil): The Y coordinate at which any fire will be extinguished.
• z (default: nil): The Z coordinate at which any fire will be extinguished.
• radius (default: 1.0): A float value indicating the radius in which to extinguish fire.

Returns

• bool: result

Always returns true.

Code Examples

client

This example creates 10 fires and then instantly extinguishes them.

local start = {0, 0, 4}

for i = 1, 10 do
    createFire(start[1] + i, start[2], start[3])
end

extinguishFire(start[1], start[2], start[3], 10)

See Also

Fire Functions

• createFire
• extinguishFire

Reference

• Scripting Functions