Squirrel/Server/Functions/Vehicles/Explode
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example) |
|||
Line 1: | Line 1: | ||
− | + | {{Squirrel/Title|Vehicle.Explode}} | |
− | This function explodes the given vehicle instantly. Note that you need to | + | 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" ) | |
− | + | { | |
− | + | local veh = player.Vehicle; | |
− | + | if ( veh ) veh.Explode( player ); | |
− | + | } | |
+ | |||
+ | return 1; | ||
} | } | ||
</code> | </code> | ||
− | |||
=== Notes === | === Notes === | ||
− | The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] | + | 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
This function explodes the given vehicle instantly. Note that you need to include a player who 'caused' the explosion.
[edit] Syntax
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.
function onPlayerCommand( player, cmd, text ) { if ( cmd == "explode" ) { local veh = player.Vehicle; if ( veh ) veh.Explode( player ); } return 1; }
[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
- CreateVehicle
- FindVehicle
- GetClosestVehicle
- GetVehicleCount
- GetVehicleHandlingData
- GetVehicleIDFromName
- GetVehicleName
- SetVehicleHandlingData
- Vehicle.Alpha
- Vehicle.Angle
- Vehicle.Colour1
- Vehicle.Colour2
- Vehicle.Driver
- Vehicle.EngineDamage
- Vehicle.Explode
- Vehicle.Fix
- Vehicle.GetAddon
- Vehicle.GetPassenger
- Vehicle.GetHandlingData
- Vehicle.GetWheelStatus
- Vehicle.Health
- Vehicle.ID
- Vehicle.IdleRespawnTime
- Vehicle.IdleTime
- Vehicle.LightState
- Vehicle.Locked
- Vehicle.Marker
- Vehicle.MarkerScale
- Vehicle.MarkerSprite
- Vehicle.Model
- Vehicle.OneTime
- Vehicle.PassengerCount
- Vehicle.Pos
- Vehicle.Remove
- Vehicle.Respawn
- Vehicle.RespawnTime
- Vehicle.RGBColour1
- Vehicle.RGBColour2
- Vehicle.SetHandlingData
- Vehicle.SetWheelStatus
- Vehicle.SpawnAngle
- Vehicle.SpawnPos
- Vehicle.SetAddon
- Vehicle.SetEngineState
- Vehicle.SetRadio
- Vehicle.Siren
- Vehicle.SirenLight
- Vehicle.TaxiLight
- Vehicle.Velocity
- Vehicle.VirtualWorld
- Vehicle.Wrecked