BlowVehicle: Difference between revisions

Revision as of 20:22, 15 July 2007

This function will blow up a vehicle. This will cause an explosion and will kill the driver and any passengers inside it.

Syntax

bool blowVehicle ( vehicle vehicleToBlow, [ bool explode=true ] )

Required Arguments

vehicleToBlow: The vehicle that you wish to blow up.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

explode: If this argument is true then the vehicle will explode, otherwise it will just be blown up silently.

Returns

Returns true if the vehicle was blown up, false if invalid arguments were passed to the function.

Example

Example 1:This example will blow up every vehicle in the game.

vehicles = getElementsByType ( "vehicle" )
for vehicleKey, vehicleValue in ipairs(vehicles) do
	blowVehicle ( vehicleValue )
end

It is worth noting that the same could be achieved with the following:

root = getRootElement ()
blowVehicle ( root )

Example 2: This example will blow a player's vehicle when he enters the car, like a carbomb.

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", getRootElement(), blowVehicleEnter ) --when a vehicle is entered

@@ Line 18: / Line 18: @@
 ==Example==
-This example will blow up every vehicle in the game.
+'''Example 1:'''This example will blow up every vehicle in the game.
 <syntaxhighlight lang="lua">
 vehicles = getElementsByType ( "vehicle" )
@@ Line 30: / Line 30: @@
 root = getRootElement ()
 blowVehicle ( root )
+</syntaxhighlight>
+'''Example 2:''' This example will blow a player's vehicle when he enters the car, like a carbomb.
+<syntaxhighlight lang="lua">
+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", getRootElement(), blowVehicleEnter ) --when a vehicle is entered
 </syntaxhighlight>
 ==See Also==
-{{Vehicle_Functions}}
+{{Vehicle_functions}}