Events (M2-Scripting)

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: 10/214

Medieval II DocuDemons - Events

Identifier	character_record	faction	settlement	enemy_unit	player_unit	target_faction	resource_description	region_id	Other
PreBattle	Yes	Yes	No	No	No	No	No	Yes	nc_character_record, character_type
PreBattleWithdrawal	Yes	Yes	No	No	No	No	No	Yes	nc_character_record, character_type
BattleAiCommenced	No	Yes	No	No	No	No	No	No	None
BattleDelayPhaseCommenced	No	Yes	No	No	No	No	No	No	None
BattleDeploymentPhaseCommenced	No	Yes	No	No	No	No	No	No	None
BattleConflictPhaseCommenced	No	Yes	No	No	No	No	No	No	None
BattlePlayerUnitAttacksEnemyUnit	No	No	No	Yes	Yes	No	No	No	infer_attacking_unit, infer_defending_unit
BattleEnemyUnitAttacksPlayerUnit	No	No	No	Yes	Yes	No	No	No	infer_attacking_unit, infer_defending_unit
BattlePlayerAttacksSettlementBuilding	No	No	No	No	Yes	No	No	No	infer_attacking_unit, building_battle
BattleEnemyAttacksSettlementBuilding	No	No	No	Yes	No	No	No	No	infer_attacking_unit, building_battle
BattleUnitGoesBerserk	No	No	No	No	No	No	No	No	unit
BattlePlayerUnitGoesBerserk	No	No	No	No	Yes	No	No	No	None
BattleEnemyUnitGoesBerserk	No	No	No	Yes	No	No	No	No	None
BattleUnitRouts	No	No	No	No	No	No	No	No	unit
BattlePlayerUnitRouts	No	No	No	No	Yes	No	No	No	None
BattleEnemyUnitRouts	No	No	No	Yes	No	No	No	No	None
BattlePlayerSiegeEngineDestroyed	No	No	No	No	Yes	No	No	No	None
BattleEnemySiegeEngineDestroyed	No	No	No	Yes	No	No	No	No	None
PostBattle	Yes	Yes	No	No	No	No	No	Yes	nc_character_record, character_type
PostBattle	No	No	No	No	No	No	No	No	army
Identifier	character_record	faction	settlement	enemy_unit	player_unit	target_faction	resource_description	region_id	Other

Template: |Identifier||Yes||Yes||No||No||No||No||No||Yes||Other]]

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

External Links

• Ultimate DocuDemons 4.0
• TW Mod Squad - Scripting
• List of Events, Commands, and Conditions from CA
• J@mes TWC-U Scripting Class
• alpaca's Script-o-Rama
• GrnEyedDvl's Scripts n' Stuff
• alpaca's Beginner Scripting Tutorial