Squirrel/Server/Functions/Effects/CreateExplosion
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example) |
|||
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|CreateExplosion}} | |
This function creates an explosion in the given coordinates. | This function creates an explosion in the given coordinates. | ||
| Line 14: | Line 14: | ||
== Example == | == Example == | ||
| + | |||
| + | |||
| + | This will create a type-1 explosion 5 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 == "explosion" ) | |
| − | + | { | |
| − | + | local pos = player.Pos; | |
| − | + | pos.x += 5.0; | |
| − | + | ||
| + | CreateExplosion( pos, 1 ); | ||
| + | } | ||
| + | |||
| + | 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}} | ||
Revision as of 04:11, 25 September 2010
This function creates an explosion in the given coordinates.
Syntax
Arguments
- vPos - The position of the explosion as a vector
- x, y, z - The coordinates of the wanted explosion as separate float values
- iExplosionType - The explosion type
Example
This will create a type-1 explosion 5 x co-ordinate units away from the player.
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
