OnVehicleExplode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (player argument)
 
(18 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
 
{{Server event}}
__NOTOC__
This event is triggered when a vehicle explodes.
This event is triggered when a vehicle explodes.
{{Note|This event can not be canceled.}}


==Syntax==  
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onVehicleExplode ()
bool withExplosion, player player
</syntaxhighlight>  
</syntaxhighlight>
*'''withExplosion:''' Determines whether the vehicle was blown with or without an explosion.
{{New feature/item|3.0161|1.6.0|22680|
*'''player:''' The player who sent the explosion packet.
}}
 
==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that exploded.


==Example==  
==Example==
This example does...
'''Example 1'''
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
local vagosVehicle = nil
blabhalbalhb --abababa
 
--This line does this...
-- This will get called when the vagos vehicle explodes
mooo
function onVagosVehicleExplode ()
outputChatBox ( "VAGOS VEHICLE DESTROYED!" )
end
 
-- This is called when THIS resource starts
function onThisResourceStart ()
 
-- Create the vagos vehicle. A van.
vagosVehicle = createVehicle ( 522, 0, 0, 5 )
 
-- Add its explode handler. When this car explodes, onVagosVehicleExplode is called
addEventHandler ( "onVehicleExplode", vagosVehicle, onVagosVehicleExplode )
end
 
--Add the resource start event
addEventHandler ( "onResourceStart", resourceRoot, onThisResourceStart )
</syntaxhighlight>
 
'''Example 2:''' This will show the name of any vehicle that blew up:
<syntaxhighlight lang="lua">
function notifyAboutExplosion()
    -- source is the element that triggered the event and can be used in other events as well
    outputChatBox(getVehicleName(source) .. " just blew up")
end
 
-- by using root, it will work for any vehicle (even if it wasn't created via this resource)
addEventHandler("onVehicleExplode", root, notifyAboutExplosion)
</syntaxhighlight>
</syntaxhighlight>
{{See also/Server event|Vehicle events}}

Latest revision as of 19:20, 18 August 2024

This event is triggered when a vehicle explodes.

[[{{{image}}}|link=|]] Note: This event can not be canceled.

Parameters

bool withExplosion, player player
  • withExplosion: Determines whether the vehicle was blown with or without an explosion.
ADDED/UPDATED IN VERSION 1.6.0 r22680:
  • player: The player who sent the explosion packet.

Source

The source of this event is the vehicle that exploded.

Example

Example 1 

local vagosVehicle = nil

-- This will get called when the vagos vehicle explodes
function onVagosVehicleExplode ()
	outputChatBox ( "VAGOS VEHICLE DESTROYED!" )
end

-- This is called when THIS resource starts
function onThisResourceStart ()

	-- Create the vagos vehicle. A van.
	vagosVehicle = createVehicle ( 522, 0, 0, 5 )

	-- Add its explode handler. When this car explodes, onVagosVehicleExplode is called
	addEventHandler ( "onVehicleExplode", vagosVehicle, onVagosVehicleExplode )
end

--Add the resource start event
addEventHandler ( "onResourceStart", resourceRoot, onThisResourceStart )

Example 2: This will show the name of any vehicle that blew up: 

function notifyAboutExplosion()
    -- source is the element that triggered the event and can be used in other events as well
    outputChatBox(getVehicleName(source) .. " just blew up")
end

-- by using root, it will work for any vehicle (even if it wasn't created via this resource)
addEventHandler("onVehicleExplode", root, notifyAboutExplosion)

See Also

Vehicle events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnVehicleExplode?oldid=80052"