OnClientExplosion: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (See Also for other client events)
(Update explosion types.)
 
(12 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}  
{{Client event}}
{{New feature|2|DP2|
This event is triggered every time an explosion is created on the current '''clients scene''' (inside the streamer).
This is a new feature in DP2.
}}
 
This event is triggered every time an explosion is created on the current clients scene (inside the streamer)
 
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float x, float y, float z, int type
float x, float y, float z, int theType
</syntaxhighlight>
</syntaxhighlight>
*'''x:''' the X Coordinate of where the explosion was created
*'''x:''' X coordinate of where the explosion was created
*'''y:''' the Y Coordinate of where the explosion was created
*'''y:''' Y coordinate of where the explosion was created
*'''z:''' the z Coordinate of where the explosion was created
*'''z:''' Z coordinate of where the explosion was created
*'''type:''' the type of explosion created, Values are:
*'''theType:''' the type of explosion created, see: [[Explosion types]]
{{Explosions}}
==Source==
The [[event system#Event source|source]] of this event is the [[player]] who created the explosion.
If the explosion is from a [[vehicle]] the source is the [[player]] who syncs the vehicle.


==Source==
===Canceling===
The [[event system#Event source|source]] of this event is the explosions creator element (object/vehicle)
If this event is [[Event system #Canceling|canceled]], the explosion will not occur.


==Example==
==Example==
There is no example, if you wish to add one feel free.
This example outputs the type of element that created the explosion into the chatbox.
<syntaxhighlight lang="lua">
function onClientExplosion(x, y, z, theType)
outputChatBox("Explosion created by a "..getElementType(source))
end
addEventHandler("onClientExplosion", root, onClientExplosion)
</syntaxhighlight>


==See Also==
==See Also==

Latest revision as of 11:43, 11 January 2024

This event is triggered every time an explosion is created on the current clients scene (inside the streamer).

Parameters

float x, float y, float z, int theType
  • x: X coordinate of where the explosion was created
  • y: Y coordinate of where the explosion was created
  • z: Z coordinate of where the explosion was created
  • theType: the type of explosion created, see: Explosion types

Source

The source of this event is the player who created the explosion. If the explosion is from a vehicle the source is the player who syncs the vehicle.

Canceling

If this event is canceled, the explosion will not occur.

Example

This example outputs the type of element that created the explosion into the chatbox. 

function onClientExplosion(x, y, z, theType)
	outputChatBox("Explosion created by a "..getElementType(source))
end
addEventHandler("onClientExplosion", root, onClientExplosion)

See Also

Other client events


Client event functions



Retrieved from "https://wiki.multitheftauto.com/wiki/OnClientExplosion?oldid=78763"