Welcome to the TWC Wiki! You are not logged in. Please log in to the Wiki to vote in polls, change skin preferences, or edit pages. See HERE for details of how to LOG IN.

Difference between revisions of "Events (M2-Scripting)"

From TWC Wiki
Jump to navigationJump to search
m
Line 16: Line 16:
  
 
{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
 
{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Events Table'''
+
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Events'''
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |CR!!style="background:#bfc0f7;" |F!!style="background:#bfc0f7;" |S!!style="background:#bfc0f7;" |EU!!style="background:#bfc0f7;" |PU!!style="background:#bfc0f7;" |TF!!style="background:#bfc0f7;" |RD!!style="background:#bfc0f7;" |RI!!style="background:#bfc0f7;" |PB!!style="background:#bfc0f7;" |Other Exports
+
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |character_record!!style="background:#bfc0f7;" |faction!!style="background:#bfc0f7;" |settlement!!style="background:#bfc0f7;" |enemy_unit!!style="background:#bfc0f7;" |player_unit!!style="background:#bfc0f7;" |target_faction!!style="background:#bfc0f7;" |resource_description!!style="background:#bfc0f7;" |region_id!!style="background:#bfc0f7;" |Other
 
|-
 
|-
|[[PreBattle (M2-Scripting)|PreBattle]]||Yes||Yes||No||No||No||No||No||Yes||No||[[nc_character_record (M2-Scripting)|nc_character_record]], [[character_type (M2-Scripting)|character_type]]
+
|[[PreBattle (M2-Scripting)|PreBattle]]||<span title="character_record" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||<span title="faction" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||<span title="settlement" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="enemy_unit" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="player_unit" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="target_faction" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="resource_description" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="region_id" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||[[nc_character_record (M2-Scripting)|nc_character_record]], [[character_type (M2-Scripting)|character_type]]
 
|-
 
|-
|[[PreBattleWithdrawal (M2-Scripting)|PreBattleWithdrawal]]||Yes||Yes||No||No||No||No||No||Yes||No||[[nc_character_record (M2-Scripting)|nc_character_record]], [[character_type (M2-Scripting)|character_type]]
+
|[[PreBattleWithdrawal (M2-Scripting)|PreBattleWithdrawal]]||<span title="character_record" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||<span title="faction" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||<span title="settlement" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="enemy_unit" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="player_unit" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="target_faction" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="resource_description" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="region_id" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||[[nc_character_record (M2-Scripting)|nc_character_record]], [[character_type (M2-Scripting)|character_type]]
|-
 
|[[BattleAiCommenced (M2-Scripting)|BattleAiCommenced]]||No||Yes||No||No||No||No||No||No||No||None
 
|-
 
|[[BattleDelayPhaseCommenced (M2-Scripting)|BattleDelayPhaseCommenced]]||No||Yes||No||No||No||No||No||No||No||None
 
 
|-class="sortbottom"
 
|-class="sortbottom"
|Identifier||CR||F||S||EU||PU||TF||RD||RI||PB||Other Exports
+
|Identifier||character_record||faction||settlement||enemy_unit||player_unit||target_faction||resource_description||region_id||Other
 
|}
 
|}
  
  
'''Template:''' |[[Events (M2-Scripting)|Identifier]]||CR||F||S||EU||PU||TF||RD||RI||PB||Other Exports
+
 
 +
'''Template:''' |[[Identifier (M2-Scripting)|Identifier]]||<span title="character_record" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||<span title="faction" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||<span title="settlement" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="enemy_unit" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="player_unit" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="target_faction" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="resource_description" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>No</span>||<span title="region_id" {{#ifeq:{{{dotted|yes}}}|no||style="border-bottom:1px dotted"}}>Yes</span>||[[Other (M2-Scripting)|Other]]]]
  
 
== See Also ==
 
== See Also ==

Revision as of 08:13, 14 December 2008

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

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
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

External Links