Squirrel/Server/Functions/Effects/CreateFire
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example) |
|||
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|CreateFire}} | |
| − | This function creates | + | This function creates a scripted fire at the given coordinates. |
== Syntax == | == Syntax == | ||
| Line 14: | Line 14: | ||
== Example == | == Example == | ||
| + | |||
| + | This will create a fire with a radius of 5.0 10 x co-ordinate units away from the player. | ||
| + | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( player, cmd, text ) | function onPlayerCommand( player, cmd, text ) | ||
{ | { | ||
| − | + | if ( cmd == "fire" ) | |
| − | + | { | |
| − | + | local pos = player.Pos; | |
| − | + | CreateFire( pos.x + 10.0, pos.y, pos.z, 5.0 ); | |
| − | + | } | |
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| − | |||
| − | |||
=== Notes === | === Notes === | ||
| − | The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] | + | The function [[Squirrel/Server/Functions/Players/Pos|Player.Pos]] and call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages. |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Effects}} | {{Squirrel/Server/Functions/Effects}} | ||
Latest revision as of 04:14, 25 September 2010
This function creates a scripted fire at the given coordinates.
[edit] Syntax
[edit] Arguments
- vPos - The position of the script fire as a vector
- x, y, z - The coordinates of the fire as separate float values
- fRadius - The radius of the fire
[edit] Example
This will create a fire with a radius of 5.0 10 x co-ordinate units away from the player.
[edit] Notes
The function Player.Pos and call onPlayerCommand were used in this example. More info about them in the corresponding pages.
[edit] Related Functions
- CreateExplosion
- CreateFire
- ExtinguishFire
- ExtinguishAllFires
