Squirrel/Server/Functions/Vehicles/Explode

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
 
Line 1: Line 1:
__NOTOC__
+
{{Squirrel/Title|Vehicle.Explode}}
This function explodes the given vehicle instantly. Note that you need to input a player who 'caused' the explosion.
+
This function explodes the given vehicle instantly. Note that you need to include a player who 'caused' the explosion.
  
 
== Syntax ==
 
== Syntax ==
Line 10: Line 10:
  
 
== Example ==
 
== Example ==
 +
 +
This command will explode the vehicle that the player is currently in, they will be the cause of the explosion.
  
 
<code lang="squirrel">
 
<code lang="squirrel">
 
function onPlayerCommand( player, cmd, text )
 
function onPlayerCommand( player, cmd, text )
 
{
 
{
if ( cmd == "explode" )
+
    if ( cmd == "explode" )
{
+
    {
local veh = player.Vehicle;
+
          local veh = player.Vehicle;
if ( veh ) veh.Explode( player );
+
          if ( veh ) veh.Explode( player );
}
+
    }
 +
   
 +
    return 1;
 
}
 
}
 
</code>
 
</code>
  
This command will explode the vehicle that the player is currently in, they will be the cause of the explosion.
 
 
=== Notes ===
 
=== Notes ===
  
The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in in this example. More info about this in the corresponding page.
+
The function [[Squirrel/Server/Functions/Players/Vehicle|Player.Vehicle]] 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/Vehicles}}
 
{{Squirrel/Server/Functions/Vehicles}}

Latest revision as of 05:16, 25 September 2010

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

This function explodes the given vehicle instantly. Note that you need to include a player who 'caused' the explosion.

[edit] Syntax

  1. bool Vehicle.Explode( Player responsible )

[edit] Arguments

  • responsible - This is a pointer to the player who was responsible for the destruction of the vehicle

[edit] Example

This command will explode the vehicle that the player is currently in, they will be the cause of the explosion.

  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. if ( cmd == "explode" )
  5. {
  6. local veh = player.Vehicle;
  7. if ( veh ) veh.Explode( player );
  8. }
  9. return 1;
  10. }
  11.  

[edit] Notes

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

[edit] Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox