Differences

This shows you the differences between two versions of the page.

--- arma:missions:eventhandlers [2007/07/13 11:17] – created eventhandlers initial page snakeman
+++ arma:missions:eventhandlers [2024/08/01 08:19] (current) – links added. snakeman
@@ Line 1: / Line 1: @@
-====== EventHandlers ======
+====== ArmA 1 EventHandlers ======
+[[https://www.pmctactical.org/forum/viewforum.php?f=42|ArmA 1 Forum]], [[:arma|ArmA 1 Home]], [[arma:config|ArmA 1 Config]], [[arma:tools|ArmA 1 Tools]], [[arma:file_formats|ArmA 1 File Formats]], [[arma:missions|ArmA 1 Missions]], [[arma:modeling|ArmA 1 3D Modeling]], [[arma:terrain|ArmA 1 Terrain]], [[arma:texturing|ArmA 1 Texturing]], [[arma:scripting|ArmA 1 Scripting]]
+**ArmA 1** aka Armed Assault (ArmA)
 These are the ArmA eventhandlers (EH).
@@ Line 17: / Line 21: @@
 Passed array: **[unit, anim]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * anim: [[:String]] - Name of the anim that started
@@ Line 28: / Line 32: @@
 Passed array: **[unit, anim]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * anim: [[:String]] - Name of the anim that has been finished
 ====== Dammaged ======
 Triggered when the unit is damaged. In ArmA works with all vehicles not only men like in OFP.
 Global.
@@ Line 41: / Line 45: @@
 Passed array: **[unit, selectionName, damage]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * selectionName: [[:String]] - Name of the selection where the unit was damaged
   * damage: [[:Number]] - Resulting level of damage
 ====== Engine ======
 Triggered when the engine of the unit is turned on/off.
@@ Line 59: / Line 63: @@
 Passed array: **[unit, engineState]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * engineState: [[:Boolean]] - True when the engine is turned on, false when turned off
@@ Line 66: / Line 70: @@
 Triggered when the unit fires a weapon.
 Global.
 Passed array: **[unit, weapon, muzzle, mode, ammo]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * weapon: [[:String]] - Fired weapon
   * muzzle: [[:String]] - Muzzle which was used
   * mode: [[:String]] - Current mode of the fired weapon
   * ammo: [[:String]] - Ammo used
 ====== Fuel ======
 Triggered when the unit's fuel status changes between completely empty / not empty (only useful when the object the event handler is assigned to is a vehicle).
 Global.
 Passed array: **[unit, fuelState]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * fuelState: [[:Boolean]] - 0 when no fuel, 1 when the fuel tank is full
 ====== Gear ======
 Triggered when the unit lowers/retracts the landing gear (only useful when the object the event handler is assigned to is a member of the class "Plane").
 Global.
 Passed array: **[unit, gearState]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * gearState: [[:Boolean]] - True when the gear is lowered, false when retracted
 ====== GetIn ======
 Triggered when a unit enters the object (only useful when the object the event handler is assigned to is a vehicle). It does not trigger upon a change of positions within the same vehicle. It also is not triggered by the moveInX commands.
 Global.
 Passed array: **[unit, position, enterer]**
@@ Line 110: / Line 114: @@
   * enterer: [[:Object]] - Object that got into the vehicle
 ====== GetOut ======
 Triggered when a unit gets out from the object, works the same way as GetIn.
 Global.
 ====== Hit ======
 Triggered when the unit is hit/damaged.
 Is ''not'' always triggered when unit is killed by a hit. Most of the time only the [[arma:missions:eventhandlers#Killed|killed]] event handler is triggered when a unit dies from a hit. The hit EH will not necessarily fire if only minor damage occurred (e.g. firing a bullet at a tank), even though the damage increased.
 Local.
 Passed array: **[unit, causedBy, damage]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * causedBy: [[:Object]] - Object that caused the damage.Contains the unit itself in case of collisions.
   * damage: [[:Number]] - Level of damage caused by the hit
 ====== Init ======
 Triggered on mission start or when a vehicle is created on the fly using createVehicle. It is also triggered  for a unit when that unit exits (disembarks) a vehicle.
 Global.
 Passed array: **[unit]**
   * unit: [[:Object]] - Object the event handler is assigned to
 ====== IncomingMissile ======
 Triggered when a guided missile or an unguided missile which most likely will hit is fired on the unit.
 Global.
 Passed array: **[unit, ammo, whoFired]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * ammo: [[:String]] - Ammo type that was fired on the unit
   * whoFired: [[:Object]] - Object that fired the weapon
 ====== Killed ======
 Triggered when the unit is killed.
 Local.
 Passed array: **[unit, killer]**
   * unit: [[:Object]] - Object the event handler is assigned to
   * killer: [[:Object]] - Object that killed the unit Contains the unit itself in case of collisions.
 ====== LandedTouchDown ======
 Triggered when a plane (AI or player) touches the ground.
@@ Line 171: / Line 175: @@
 Passed array: **[plane, airportID]**
   * plane: [[:Object]] - Object the event handler is assigned to
   * airportID: [[:Number]] - ID of the airport (-1 for anything else).
 ====== LandedStopped ======
 Triggered when an AI pilot would get out usually. Not executed for player.
@@ Line 182: / Line 186: @@
 Passed array: **[plane, airportID]**
   * plane: [[:Object]] - Object the event handler is assigned to
   * airportID: [[:Number]] - ID of the airport (-1 for anything else).