BlowVehicle

2011-08-07T15:44:41Z

MrHankey: updated syntax

__NOTOC__
{{Server client function}}
This function will blow up a vehicle. This will cause an explosion and will kill the driver and any passengers inside it.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool blowVehicle ( vehicle vehicleToBlow, [ bool explode=true ] )
</syntaxhighlight>

===Required Arguments===
*'''vehicleToBlow:''' The vehicle that you wish to blow up.
===Optional Arguments===
{{OptionalArg}}
*'''explode:''' If this argument is ''true'' then the vehicle will explode, otherwise it will just be blown up silently.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool blowVehicle ( vehicle vehicleToBlow )
</syntaxhighlight>

===Required Arguments===
*'''vehicleToBlow:''' The vehicle that you wish to blow up.
</section>
===Returns===
Returns ''true'' if the vehicle was blown up, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Example 1: Server and client" class="both" show="true">
This example will blow up every vehicle in the game.
<syntaxhighlight lang="lua">
vehicles = getElementsByType ( "vehicle" )
for vehicleKey, vehicleValue in ipairs(vehicles) do
blowVehicle ( vehicleValue )
end
</syntaxhighlight>

It is worth noting that the same could be achieved with the following:
<syntaxhighlight lang="lua">
root = getRootElement ()
blowVehicle ( root )
</syntaxhighlight>
</section>

<section name="Example 2: Server" class="server" show="true">
This example will blow a player's vehicle when he enters the car, like a carbomb.
<syntaxhighlight lang="lua">
riggedVehicle = createVehicle(445, 0, 0, 5)
function blowVehicleEnter ( thePlayer, seat, jacked )
--ENGINE START BOMB.
if seat == 0 then --check if the seat the player got into was id 0 - i.e. driver seat
blowVehicle ( source ) --if it was, toast him
end
end
addEventHandler ( "onVehicleEnter", riggedVehicle, blowVehicleEnter ) --trigger the function when a certain vehicle is entered
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

Multi Theft Auto: Wiki - User contributions [en]

BlowVehicle