arma:missions:eventhandlers
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 ====== | + | ====== |
| + | |||
| + | [[https:// | ||
| + | |||
| + | **ArmA 1** aka Armed Assault (ArmA) | ||
| These are the ArmA eventhandlers (EH). | These are the ArmA eventhandlers (EH). | ||
| Line 17: | Line 21: | ||
| Passed array: **[unit, anim]** | Passed array: **[unit, anim]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| * anim: [[:String]] - Name of the anim that started | * anim: [[:String]] - Name of the anim that started | ||
| Line 28: | Line 32: | ||
| Passed array: **[unit, anim]** | Passed array: **[unit, anim]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| * anim: [[:String]] - Name of the anim that has been finished | * anim: [[:String]] - Name of the anim that has been finished | ||
| - | ====== Dammaged ====== | + | ====== Dammaged ====== |
| - | Triggered when the unit is damaged. In ArmA works with all vehicles not only men like in OFP. | + | Triggered when the unit is damaged. In ArmA works with all vehicles not only men like in OFP. |
| Global. | Global. | ||
| Line 41: | Line 45: | ||
| Passed array: **[unit, selectionName, | Passed array: **[unit, selectionName, | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| * selectionName: | * selectionName: | ||
| * damage: [[:Number]] - Resulting level of damage | * damage: [[:Number]] - Resulting level of damage | ||
| - | ====== Engine ====== | + | ====== Engine ====== |
| Triggered when the engine of the unit is turned on/off. | Triggered when the engine of the unit is turned on/off. | ||
| Line 59: | Line 63: | ||
| Passed array: **[unit, engineState]** | Passed array: **[unit, engineState]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| * engineState: | * engineState: | ||
| Line 66: | Line 70: | ||
| Triggered when the unit fires a weapon. | Triggered when the unit fires a weapon. | ||
| - | Global. | + | Global. |
| Passed array: **[unit, weapon, muzzle, mode, ammo]** | Passed array: **[unit, weapon, muzzle, mode, ammo]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| - | * weapon: [[:String]] - Fired weapon | + | * weapon: [[:String]] - Fired weapon |
| - | * muzzle: [[:String]] - Muzzle which was used | + | * muzzle: [[:String]] - Muzzle which was used |
| - | * mode: [[:String]] - Current mode of the fired weapon | + | * mode: [[:String]] - Current mode of the fired weapon |
| * ammo: [[:String]] - Ammo used | * ammo: [[:String]] - Ammo used | ||
| - | | + | |
| - | ====== Fuel ====== | + | ====== 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). | 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. | + | Global. |
| Passed array: **[unit, fuelState]** | Passed array: **[unit, fuelState]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| * fuelState: [[: | * fuelState: [[: | ||
| - | | + | |
| - | ====== Gear ====== | + | ====== Gear ====== |
| Triggered when the unit lowers/ | Triggered when the unit lowers/ | ||
| - | Global. | + | Global. |
| Passed array: **[unit, gearState]** | Passed array: **[unit, gearState]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| * gearState: [[: | * gearState: [[: | ||
| - | | + | |
| - | ====== GetIn ====== | + | ====== 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. | 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. | + | Global. |
| Passed array: **[unit, position, enterer]** | Passed array: **[unit, position, enterer]** | ||
| Line 110: | Line 114: | ||
| * enterer: [[:Object]] - Object that got into the vehicle | * enterer: [[:Object]] - Object that got into the vehicle | ||
| - | ====== GetOut ====== | + | ====== GetOut ====== |
| Triggered when a unit gets out from the object, works the same way as GetIn. | Triggered when a unit gets out from the object, works the same way as GetIn. | ||
| - | Global. | + | Global. |
| - | ====== Hit ====== | + | ====== Hit ====== |
| - | Triggered when the unit is hit/ | + | Triggered when the unit is hit/ |
| Is '' | Is '' | ||
| - | Local. | + | Local. |
| Passed array: **[unit, causedBy, damage]** | Passed array: **[unit, causedBy, damage]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| - | * causedBy: [[:Object]] - Object that caused the damage.Contains the unit itself in case of collisions. | + | * causedBy: [[:Object]] - Object that caused the damage.Contains the unit itself in case of collisions. |
| * damage: [[:Number]] - Level of damage caused by the hit | * damage: [[:Number]] - Level of damage caused by the hit | ||
| - | ====== Init ====== | + | ====== Init ====== |
| Triggered on mission start or when a vehicle is created on the fly using createVehicle. It is also triggered | Triggered on mission start or when a vehicle is created on the fly using createVehicle. It is also triggered | ||
| - | Global. | + | Global. |
| Passed array: **[unit]** | Passed array: **[unit]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| - | + | ||
| - | ====== IncomingMissile ====== | + | ====== IncomingMissile ====== |
| Triggered when a guided missile or an unguided missile which most likely will hit is fired on the unit. | Triggered when a guided missile or an unguided missile which most likely will hit is fired on the unit. | ||
| - | Global. | + | Global. |
| Passed array: **[unit, ammo, whoFired]** | Passed array: **[unit, ammo, whoFired]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| - | * ammo: [[:String]] - Ammo type that was fired on the unit | + | * ammo: [[:String]] - Ammo type that was fired on the unit |
| * whoFired: [[:Object]] - Object that fired the weapon | * whoFired: [[:Object]] - Object that fired the weapon | ||
| - | ====== Killed ====== | + | ====== Killed ====== |
| Triggered when the unit is killed. | Triggered when the unit is killed. | ||
| - | Local. | + | Local. |
| Passed array: **[unit, killer]** | Passed array: **[unit, killer]** | ||
| - | * unit: [[:Object]] - Object the event handler is assigned to | + | * unit: [[:Object]] - Object the event handler is assigned to |
| - | * killer: [[:Object]] - Object that killed the unit Contains the unit itself in case of collisions. | + | * killer: [[:Object]] - Object that killed the unit Contains the unit itself in case of collisions. |
| - | ====== LandedTouchDown ====== | + | ====== LandedTouchDown ====== |
| Triggered when a plane (AI or player) touches the ground. | Triggered when a plane (AI or player) touches the ground. | ||
| Line 171: | Line 175: | ||
| Passed array: **[plane, airportID]** | Passed array: **[plane, airportID]** | ||
| - | * plane: [[:Object]] - Object the event handler is assigned to | + | * plane: [[:Object]] - Object the event handler is assigned to |
| - | * airportID: [[:Number]] - ID of the airport (-1 for anything else). | + | * airportID: [[:Number]] - ID of the airport (-1 for anything else). |
| - | ====== LandedStopped ====== | + | ====== LandedStopped ====== |
| Triggered when an AI pilot would get out usually. Not executed for player. | Triggered when an AI pilot would get out usually. Not executed for player. | ||
| Line 182: | Line 186: | ||
| Passed array: **[plane, airportID]** | Passed array: **[plane, airportID]** | ||
| - | * plane: [[:Object]] - Object the event handler is assigned to | + | * plane: [[:Object]] - Object the event handler is assigned to |
| * airportID: [[:Number]] - ID of the airport (-1 for anything else). | * airportID: [[:Number]] - ID of the airport (-1 for anything else). | ||
| + | |||
arma/missions/eventhandlers.1184325436.txt.gz · Last modified: 2007/07/13 11:17 by snakeman
