Events (M2-Scripting)
Contents
Events are the parameters in scripting used to determine the interval at which the script is checked for in order to fire. They are used to fire a script at a proper time during the game process, such as at the end of a battle, the start of a turn, or the death of a general. The event is what enables most scripts to work, by finding the proper time to trigger the script. In determining which event to use, you should consider which Conditions you want to use, and insure the event exports the triggers that those conditions require, or the script won't work as intended.
These trigger exports are: character_record, nc_character_record, player_unit, enemy_unit, infer_defending_unit, infer_attacking_unit, resource_description, character_action_advice, target_character_record, ransom_type, captured_faction_info, faction, target_faction, unit, mission_success_level, mission_details, event_counter, sm_position, region_id, target_region_id, crusade, target_religion, settlement, target_settlement, prior_build, best_finance_option, advised_build, fort, army, event, religion, event_type.
Events usually export more than one trigger, the most common triggers required from an event are listed here: Required Triggers (M2-Scripting)
Events Table
This table is a Work in Progress, if you would like to help out, please PM Augustus Lucifer. Help is encouraged, but in order to make sure a event isn't added twice or skipped, help needs to be coordinated. Thank you.
Current Progress: 4/214
Key: CR = character_record ; F = faction ; S = settlement ; EU = enemy_unit ; PU = player_unit ; TF = target_faction ; RD = resource_description ; RI = region_id ; PB = prior_build
| Identifier | CR | F | S | EU | PU | TF | RD | RI | PB | Other Exports |
|---|---|---|---|---|---|---|---|---|---|---|
| PreBattle | Yes | Yes | No | No | No | No | No | Yes | No | nc_character_record, character_type |
| PreBattleWithdrawal | Yes | Yes | No | No | No | No | No | Yes | No | nc_character_record, character_type |
| BattleAiCommenced | No | Yes | No | No | No | No | No | No | No | None |
| BattleDelayPhaseCommenced | No | Yes | No | No | No | No | No | No | No | None |
| Identifier | CR | F | S | EU | PU | TF | RD | RI | PB | Other Exports |
Template: |Identifier||CR||F||S||EU||PU||TF||RD||RI||PB||Other Exports
See Also
- Scripting Knowledge Compendium (M2-Scripting) - For the index of scripting information
- Conditions (M2-Scripting) - For information on Conditions and links to Condition pages
- Commands (M2-Scripting) - For information on Commands and links to Command pages
- Modding:Coding
