Squirrel/Server/Functions/Effects/ExtinguishAllFires
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example) |
|||
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|ExtinguishAllFires}} | |
This function extinguishes all script created fires. | This function extinguishes all script created fires. | ||
| Line 11: | Line 11: | ||
== Example == | == Example == | ||
| + | |||
| + | This will extinguish all script created fires when someone types '/extinguish'. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( player, cmd, text ) | function onPlayerCommand( player, cmd, text ) | ||
{ | { | ||
| − | + | if ( cmd == "extinguish" ) ExtinguishAllFires(); | |
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| − | |||
| − | |||
=== Notes === | === Notes === | ||
| − | The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used | + | The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in this example. More info about this in the corresponding page. |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Effects}} | {{Squirrel/Server/Functions/Effects}} | ||
Latest revision as of 04:18, 25 September 2010
This function extinguishes all script created fires.
[edit] Syntax
[edit] Arguments
- none
[edit] Example
This will extinguish all script created fires when someone types '/extinguish'.
[edit] Notes
The call onPlayerCommand was used in this example. More info about this in the corresponding page.
[edit] Related Functions
- CreateExplosion
- CreateFire
- ExtinguishFire
- ExtinguishAllFires
