Difference between revisions of "Arma 3: Event Handlers"
killzone_kid (talk | contribs) (comment to example) |
fred gandt (talk | contribs) (Deployed {{GVI}} and {{EffArg}} for icons) |
||
Line 34: | Line 34: | ||
* anim: [[String]] - Name of the anim that is started | * anim: [[String]] - Name of the anim that is started | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 47: | Line 47: | ||
* anim: [[String]] - Name of the anim that has been finished | * anim: [[String]] - Name of the anim that has been finished | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 60: | Line 60: | ||
* anim: [[String]] - Name of the anim that has been started | * anim: [[String]] - Name of the anim that has been started | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 78: | Line 78: | ||
* oldController: [[Object]] - Unit who controled vehicle before this event. | * oldController: [[Object]] - Unit who controled vehicle before this event. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.00}} | |
Line 98: | Line 98: | ||
* damage: [[Number]] - Resulting level of damage | * damage: [[Number]] - Resulting level of damage | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 111: | Line 111: | ||
* engineState: [[Boolean]] - True when the engine is turned on, false when turned off | * engineState: [[Boolean]] - True when the engine is turned on, false when turned off | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 127: | Line 127: | ||
* force: [[Number]] - Force of collision. | * force: [[Number]] - Force of collision. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.00}} | |
|- | |- | ||
Line 143: | Line 143: | ||
* force: [[Number]] - Force of collision. | * force: [[Number]] - Force of collision. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.00}} | |
|- | |- | ||
Line 159: | Line 159: | ||
* force: [[Number]] - Force of collision. | * force: [[Number]] - Force of collision. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.00}} | |
|- | |- | ||
Line 172: | Line 172: | ||
* damage: [[Number]] - Damage inflicted to the object | * damage: [[Number]] - Damage inflicted to the object | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.76}} | |
|- | |- | ||
Line 191: | Line 191: | ||
* projectile: [[Object]] - Object of the projectile that was shot (Arma 2: OA and onwards) | * projectile: [[Object]] - Object of the projectile that was shot (Arma 2: OA and onwards) | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 213: | Line 213: | ||
* ammo: [[String]] - Ammo used | * ammo: [[String]] - Ammo used | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 226: | Line 226: | ||
* fuelState: [[Boolean]] - 0 when no fuel, 1 when the fuel tank is full | * fuelState: [[Boolean]] - 0 when no fuel, 1 when the fuel tank is full | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|global}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 239: | Line 239: | ||
* gearState: [[Boolean]] - True when the gear is lowered, false when retracted | * gearState: [[Boolean]] - True when the gear is lowered, false when retracted | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|global}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 255: | Line 255: | ||
* unit: [[Object]] - Unit that entered the vehicle | * unit: [[Object]] - Unit that entered the vehicle | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 269: | Line 269: | ||
* unit: [[Object]] - Unit that left the vehicle | * unit: [[Object]] - Unit that left the vehicle | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 297: | Line 297: | ||
* projectile: [[String]] - Classname of the projectile that caused inflicted the damage. ("" for unknown, such as falling damage.) | * projectile: [[String]] - Classname of the projectile that caused inflicted the damage. ("" for unknown, such as falling damage.) | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 311: | Line 311: | ||
* healercanheal: [[Boolean]] - true when healer is corpsman | * healercanheal: [[Boolean]] - true when healer is corpsman | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 327: | Line 327: | ||
* damage: [[Number]] - Level of damage caused by the hit | * damage: [[Number]] - Level of damage caused by the hit | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 351: | Line 351: | ||
* direct: [[Boolean]] - [[true]] if object was directly hit, [[false]] if it was hit by indirect/splash damage. | * direct: [[Boolean]] - [[true]] if object was directly hit, [[false]] if it was hit by indirect/splash damage. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.60}} | |
|- | |- | ||
Line 363: | Line 363: | ||
* unit: [[Object]] - Object the event handler is assigned to | * unit: [[Object]] - Object the event handler is assigned to | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 377: | Line 377: | ||
* whoFired: [[Object]] - Object that fired the weapon | * whoFired: [[Object]] - Object that fired the weapon | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 396: | Line 396: | ||
* container: [[Object]] - connected container or weaponholder | * container: [[Object]] - connected container or weaponholder | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.22}} | |
|- | |- | ||
Line 419: | Line 419: | ||
* container: [[Object]] - connected container or weaponholder | * container: [[Object]] - connected container or weaponholder | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.22}} | |
|- | |- | ||
Line 435: | Line 435: | ||
* killer: [[Object]] - Object that killed the unit<br />Contains the unit itself in case of collisions. <br /> | * killer: [[Object]] - Object that killed the unit<br />Contains the unit itself in case of collisions. <br /> | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|ofpr|1.85}} | |
|- | |- | ||
Line 448: | Line 448: | ||
* airportID: [[Number]] - ID of the airport (-1 for anything else) | * airportID: [[Number]] - ID of the airport (-1 for anything else) | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.60}} | |
|- | |- | ||
Line 461: | Line 461: | ||
* airportID: [[Number]] - ID of the airport (-1 for anything else) | * airportID: [[Number]] - ID of the airport (-1 for anything else) | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.60}} | |
|- | |- | ||
Line 474: | Line 474: | ||
* local: [[Boolean]] - If the object is local on given computer. | * local: [[Boolean]] - If the object is local on given computer. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.00}} | |
|- | |- | ||
Line 487: | Line 487: | ||
* corpse: [[Object]] - Object the event handler was assigned to, aka the corpse/unit player was previously controlling | * corpse: [[Object]] - Object the event handler was assigned to, aka the corpse/unit player was previously controlling | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2|1.00}} | |
|- | |- | ||
Line 501: | Line 501: | ||
* item: [[String]] - The class name of the moved item | * item: [[String]] - The class name of the moved item | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.56}} | |
|- | |- | ||
Line 515: | Line 515: | ||
* item: [[String]] - The class name of the taken item | * item: [[String]] - The class name of the taken item | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.56}} | |
|- | |- | ||
Line 539: | Line 539: | ||
* weapon: [[Object]] - Object of the assembled weapon | * weapon: [[Object]] - Object of the assembled weapon | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.55}} | |
|- | |- | ||
Line 553: | Line 553: | ||
* secondarybag: [[Object]] - Second backpack object which was weapon disassembled into | * secondarybag: [[Object]] - Second backpack object which was weapon disassembled into | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.55}} | |
|} | |} | ||
Line 606: | Line 606: | ||
* errorID: [[Number]] | * errorID: [[Number]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 620: | Line 620: | ||
* entity: [[Group]] | * entity: [[Group]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 634: | Line 634: | ||
* entity: [[Group]] | * entity: [[Group]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 648: | Line 648: | ||
* entity: [[Group]] | * entity: [[Group]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 662: | Line 662: | ||
* entity: [[String]] | * entity: [[String]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 676: | Line 676: | ||
* entity: [[String]] | * entity: [[String]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 690: | Line 690: | ||
* entity: [[String]] | * entity: [[String]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 704: | Line 704: | ||
* entity: [[String]] | * entity: [[String]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 718: | Line 718: | ||
* entity: [[String]] | * entity: [[String]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 732: | Line 732: | ||
* entity: [[Object]] | * entity: [[Object]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 746: | Line 746: | ||
* entity: [[Object]] | * entity: [[Object]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 760: | Line 760: | ||
* entity: [[Object]] | * entity: [[Object]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 774: | Line 774: | ||
* entity: [[Object]] | * entity: [[Object]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 792: | Line 792: | ||
* input: [[Array]] of [[String]]s - all CfgVehicles classes | * input: [[Array]] of [[String]]s - all CfgVehicles classes | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 806: | Line 806: | ||
* entity: [[Object]] | * entity: [[Object]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 820: | Line 820: | ||
* player: [[Object]] | * player: [[Object]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 834: | Line 834: | ||
* entity: [[Array]] | * entity: [[Array]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 848: | Line 848: | ||
* entity: [[Array]] | * entity: [[Array]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 862: | Line 862: | ||
* entity: [[Array]] | * entity: [[Array]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 876: | Line 876: | ||
* entity: [[Array]] | * entity: [[Array]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|- | |- | ||
Line 890: | Line 890: | ||
* entity: [[Array]] | * entity: [[Array]] | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|local}}{{EffArg|cmd|effs|local}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|1.16}} | |
|} | |} | ||
Line 933: | Line 933: | ||
* damage: [[Number]] - Level of damage caused by the hit | * damage: [[Number]] - Level of damage caused by the hit | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|global}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.55}} | |
|- | |- | ||
Line 946: | Line 946: | ||
* killer: [[Object]] - Object that killed the unit<br />Contains the unit itself in case of collisions | * killer: [[Object]] - Object that killed the unit<br />Contains the unit itself in case of collisions | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|global}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.55}} | |
|- | |- | ||
Line 964: | Line 964: | ||
* corpse: [[Object]] - Object the event handler was assigned to, aka the corpse/unit player was previously controlling. | * corpse: [[Object]] - Object the event handler was assigned to, aka the corpse/unit player was previously controlling. | ||
| <!-- Effects --> | | <!-- Effects --> | ||
− | + | {{EffArg|cmd|args|global}}{{EffArg|cmd|effs|global}} | |
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma2oa|1.55}} | |
|} | |} | ||
Line 999: | Line 999: | ||
* endType: [[String]] - mission end type. Used in [[Debriefing]] among other things. | * endType: [[String]] - mission end type. Used in [[Debriefing]] among other things. | ||
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.50}} | |
|- | |- | ||
Line 1,012: | Line 1,012: | ||
** "continue" - saved when leaving a mission to the main menu | ** "continue" - saved when leaving a mission to the main menu | ||
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.50}} | |
|} | |} | ||
Line 1,049: | Line 1,049: | ||
* handlerID: [[Number]] - EH id returned by [[addMusicEventHandler]]. | * handlerID: [[Number]] - EH id returned by [[addMusicEventHandler]]. | ||
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.50}} | |
|- | |- | ||
Line 1,062: | Line 1,062: | ||
* handlerID: [[Number]] - EH id returned by [[addMusicEventHandler]]. | * handlerID: [[Number]] - EH id returned by [[addMusicEventHandler]]. | ||
| <!-- Since --> | | <!-- Since --> | ||
− | + | {{GVI|arma3|0.50}} | |
|} | |} |
Revision as of 02:38, 31 May 2014
An event handler (abbreviated to EH) allows you to automatically monitor and then execute custom code upon particular events being triggered.
See also Event Scripts for special event triggered scripts.
addEventHandler
Object event handler, always executed on the computer where it was added.
Commands:
Example:
mySoldier addEventHandler ["Killed",{hint format ["%1 was killed by %2",name (_this select 0),name (_this select 1)];}]
Default
Class | Description | Arguments | MP-Effects | Since |
---|---|---|---|---|
AnimChanged |
Triggered every time a new animation is started. It can be assigned to a remote unit but will only fire on the PC where the actual addEventHandler command was executed. |
|||
AnimDone |
Triggered every time an animation is finished. It can be assigned to a remote unit but will only fire on the PC where the actual addEventHandler command was executed. |
|||
AnimStateChanged |
Triggered every time an animation state changes. Unlike AnimChanged and AnimDone, it is triggered for all animation states in a sequence. It can be assigned to a remote unit but will only fire on the PC where the actual addEventHandler command was executed. |
|||
ControlsShifted |
Triggers when controls of vehicle are shifted (pilot->co-pilot, co-pilot->pilot). Works for both, "Take" and "Release" controls actions. Event only triggers on PC where vehicle is local and EH was added. Notes:
|
| ||
Dammaged |
Triggered when the unit is damaged. In ArmA works with all vehicles not only men like in OFP. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. Notes:
|
|||
Engine |
Triggered when the engine of the unit is turned on/off. |
|||
EpeContact |
Triggered when object collision (PhysX) is in progress. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. |
|
||
EpeContactEnd |
Triggered when object collision (PhysX) ends. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. |
|
||
EpeContactStart |
Triggered when object collision (PhysX) starts. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. |
|
||
Explosion |
Triggered when a vehicle or unit is damaged by a nearby explosion. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. |
|||
Fired |
Triggered when the unit fires a weapon. |
|
||
FiredNear |
Triggered when a weapon is fired somewhere near the unit or vehicle. It is also triggered if the unit itself is firing. (Exception(s): the Throw weapon wont broadcast the FiredNear event) |
|
||
Fuel |
Triggered when the unit's fuel status changes between completely empty / not empty (only useful if the event handler is assigned to a vehicle). |
|||
Gear |
Triggered when the unit lowers/retracts the landing gear (only useful if the event handler is assigned to is a member of the class "Plane"). |
|||
GetIn |
Triggers when a unit enters a vehicle. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. This EH is neither triggered upon a change of positions within the same vehicle nor by the moveInXXXX commands. However it is triggered by a "GetInXXXX" action. In vehicles with multi-turret setup, entering any turret will show "gunner" for position. |
|||
GetOut |
Triggers when a unit gets out from a vehicle. It can be assigned to a remote vehicle but will only fire on the PC where the actual addEventHandler command was executed. This EH is triggered by both the moveOut command and by "GetOut" action. |
|||
HandleDamage |
Triggers when the unit is damaged and fires for each damaged selection separately. Works with all vehicles. This EH can accept a remote unit as argument however it will only fire when the unit is local to the PC this event handler was added on. For example, you can add this event handler to one particular vehicle on every PC. When this vehicle gets hit, only EH on PC where the vehicle is currently local will fire. If code provided returns a numeric value, this value will overwrite the default damage of given selection after processing. Return value of 0 will make the unit invulnerable if damage is not scripted in other ways (i.e using setDamage and/or setHit for additional damage handling). If no value is returned, the default damage processing will be done. This allows for safe stacking of this event handler. Only the return value of the last added "HandleDamage" EH is considered. Notes:
Additional Celery's explanation. |
|
||
HandleHeal |
Triggered when unit starts to heal (player using heal action or AI heals after being ordered). Triggers only on PC where EH is added and unit is local. If code returns false, engine side healing follows. Return true if you handle healing in script, use AISFinishHeal to tell engine that script side healing is done. See also lifeState and setUnconscious commands. |
|||
Hit |
Triggered when the unit is hit/damaged. Is not always triggered when unit is killed by a hit. |
|||
HitPart |
Runs when the object, it was added to, gets injured/damaged. It returns the position and component that was hit on the object within a nested array, this is because the model may have more than selection name for the hit component. While you can add "HitPart" handler to a remote unit, the respectful addEventHandler command must be executed on the shooter's PC and will only fire on shooter's PC as well. Additionally, if the unit gets damaged by any means other than shooter's shooting, "HitPart" will not fire. Because of this, this event handler is most suitable for when the shooter needs feedback on his shooting, such as target practicing or hitmarker creation. |
|
||
Init |
Triggered on mission start or when a vehicle is created on the fly using createVehicle. |
|
||
IncomingMissile |
Triggered when a guided missile locked on the target or unguided missile or rocket aimed by AI at the target was fired. |
|||
InventoryClosed |
Triggered when unit closes inventory.
|
|||
InventoryOpened |
Triggered when unit opens inventory. End EH main scope with true to override the opening of the inventory in case you wish to handle it yourself:
|
|||
Killed |
Triggered when the unit is killed. Be careful when the killer has been a vehicle. For most cases the reference of the vehicle is the same as the effectiveCommander, but not always. |
|||
LandedTouchDown |
Triggered when a plane (AI or player) touches the ground. |
|||
LandedStopped |
Triggered when an AI pilot would get out usually. Not executed for player. |
|||
Local |
Triggered when locality of object in MP is changed. |
|||
Respawn |
Triggered when a unit respawns. |
|||
Put |
Triggers when a unit puts an item in a container. |
|||
Take |
Triggers when a unit takes an item from a container. |
|||
SoundPlayed |
Triggered when player is making noises when injured or fatigued. |
|||
WeaponAssembled |
Triggers when weapon gets assembled. |
|||
WeaponDisassembled |
Triggers when weapon gets disassembled. |
Curator
Curator Event Handlers are also added with addEventHandler command and are supposed to be added to curator object (not player object) and where curator object is local and will be executed only where curator is local (i.e., on computer of player who's in control of it).
Class | Description | Arguments | MP-Effects | Since |
---|---|---|---|---|
CuratorFeedbackMessage |
Triggered when curator attempts invalid action in curator interface. Each error has its own unique ID, recognized values are:
|
|||
CuratorGroupDoubleClicked |
Triggered when a group is double-clicked on in curator interface.
|
|||
CuratorGroupPlaced |
Triggered when new group is placed in curator interface.
|
|||
CuratorGroupSelectionChanged |
Triggered when a group is selected in curator interface.
|
|||
CuratorMarkerDeleted |
Triggered when a marker is deleted in curator interface.
|
|||
CuratorMarkerDoubleClicked |
Triggered when a marker is double-clicked on in curator interface.
|
|||
CuratorMarkerEdited |
Triggered when a marker is moved in curator interface.
|
|||
CuratorMarkerPlaced |
Triggered when new marker is placed in curator interface.
|
|||
CuratorMarkerSelectionChanged |
Triggered when a marker is selected in curator interface.
|
|||
CuratorObjectDeleted |
Triggered when an object is deleted in curator interface.
|
|||
CuratorObjectDoubleClicked |
Triggered when an object is double-clicked on in curator interface.
|
|||
CuratorObjectEdited |
Triggered when an object is moved or rotated in curator interface.
|
|||
CuratorObjectPlaced |
Triggered when new object is placed in curator interface. This event handler will trigger individually for each unit in a placed group - excluding the crew in vehicles.
|
|||
CuratorObjectRegistered |
Triggered when player enters curator interface. Assign curator cost to every object in the game. This is the primary method that a mission designer can use to limit the objects a curator can place. Full article - Curator This handler is supposed to be added to curator module, not player. |
|||
CuratorObjectSelectionChanged |
Triggered when an object is selected in curator interface.
|
|||
CuratorPinged |
Triggered when a player pings his curator(s) by pressing Zeus key. To add player to specific curator, use addCuratorEditableObjects command.
|
|||
CuratorWaypointDeleted |
Triggered when a waypoint is deleted in curator interface.
|
|||
CuratorWaypointDoubleClicked |
Triggered when a waypoint is double-clicked on in curator interface.
|
|||
CuratorWaypointEdited |
Triggered when a waypoint is moved in curator interface.
|
|||
CuratorWaypointPlaced |
Triggered when new waypoint is placed in curator interface.
|
|||
CuratorWaypointSelectionChanged |
Triggered when a waypoint is selected in curator interface.
|
addMPEventHandler
Global object event handler, executed on every connected machine.
Commands:
Example:
mySoldier addMPEventHandler ["MPKilled",{hint format ["%1 was killed by %2",name (_this select 0),name (_this select 1)];}]
Class | Description | Arguments | MP-Effects | Since |
---|---|---|---|---|
MPHit |
Triggered when the unit is hit/damaged. EH can be added on any machine and EH code will trigger globally on every connected client and server. Add it only on server because if you have 10 machines on network and add this EH to every machine, when triggered the EH code will be executed 10 x 10 = 100 times. Is not always triggered when unit is killed by a hit. Most of the time only the 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. Can also trigger several times for an explosion (direct and indirect damage). Does not fire when a unit is set to allowDamage false. However it will fire with "HandleDamage" EH added alongside stopping unit from taking damage addEventHandler ["HandleDamage",{0}]; Will not trigger when unit is dead. This EH must be used in conjunction with the addMPEventHandler command. Note: Call a function from the MPHit EH code space, rather to define the full code in there directly. The reason is the code space will be transferred over network on each event activation - so keep the data as small as possible! |
|||
MPKilled |
Triggered when the unit is killed. EH can be added on any machine and EH code will trigger globally on every connected client and server. Add it only on server because if you have 10 machines on network and add this EH to every machine, when triggered the EH code will be executed 10 x 10 = 100 times. |
|||
MPRespawn |
Triggered when a unit respawns. Notes:
|
addMissionEventHandler
Mission event handler, always executed on the computer where it was added.
Commands:
Example:
addMissionEventHandler ["Loaded",{playMusic "EventTrack03_F_EPB";}]
Class | Description | Arguments | Since |
---|---|---|---|
Ended |
Triggered when mission ends, either using trigger of type "End", endMission command, BIS_fnc_endMission function or ENDMISSION cheat. |
|
|
Loaded |
Triggered when mission is loaded. |
addMusicEventHandler
Music event handler, always executed on the computer where it was added.
Commands:
Example:
addMusicEventHandler ["MusicStop",{playMusic (_this select 0);}]
Class | Description | Arguments | Since |
---|---|---|---|
MusicStart |
Triggers when CfgMusic sound starts playing, after being executed with playMusic command. This event handler needs to be added with addMusicEventHandler command and removed with removeMusicEventHandler. |
|
|
MusicStop |
Triggers when CfgMusic sound finished playing, after being executed with playMusic command. Note that EH will not be triggered if you force stop the music with playMusic "". This event handler needs to be added with addMusicEventHandler command and removed with removeMusicEventHandler. |
|
ctrlAddEventHandler
Full article - User Interface Event Handlers
displayAddEventHandler
Full article - User Interface Event Handlers