ExtinguishFire

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function extinguishes fire at the given coordinates.

Syntax

bool ExtinguishFire( Vector vPos, float fRadius )

bool ExtinguishFire( float x, float y, float z, float fRadius )

Arguments

• vPos - The position where the fire should be extinguished
• x, y, z - The coordinates of the position to be extinguished as separate float values
• fRadius - The radius of the area which should be extinguished

Example

This will extinguish all fires within a 5.0 radius from the player when they type '/extinguish2'.

 
function onPlayerCommand( player, cmd, text )
{
     if ( cmd == "extinguish2" ) 
     {
          local pos = player.Pos;
          ExtinguishFire( pos, 5.0 );
     }
     
     return 1;
}
 

Notes

The function Player.Pos and call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions

• CreateExplosion
• CreateFire
• ExtinguishFire
• ExtinguishAllFires