TWC Wiki - User contributions [en]

GeneralNumKillsInBattle (M2-Scripting)

2008-09-21T18:49:57Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' GeneralNumKillsInBattle > 4
*'''CA Description:''' Test to see how many kills the character scored in the prior battle was
*'''Battle/Strat:''' Either
*'''Class:''' GENERAL_ENEMIES_KILLED_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

GeneralFoughtFaction (M2-Scripting)

2008-09-21T18:49:48Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' faction type
*'''CA Example:''' GeneralFoughtFaction venice
*'''CA Description:''' Test to see whether the opponent was of a particular faction in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' FOUGHT_FACTION

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

NumFriendsInBattle (M2-Scripting)

2008-09-21T18:49:36Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' NumFriendsInBattle < 50
*'''CA Description:''' Test the number of soldiers and officers in allied armies
*'''Battle/Strat:''' Either
*'''Class:''' NUM_FRIENDS_IN_BATTLE_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

PercentageUnitCategory (M2-Scripting)

2008-09-21T18:49:23Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' unit category (infantry, cavalry, siege, non_combatant, ship, handler), logic token, test value
*'''CA Example:''' PercentageUnitCategory handler > 35.8
*'''CA Description:''' Test to see what percentage of the army were of a particular category
*'''Battle/Strat:''' Either
*'''Class:''' GENERALS_ARMY_PERCENTAGE_OF_UNIT_CATEGORY_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

NumKilledGenerals (M2-Scripting)

2008-09-21T18:49:06Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' NumKilledGenerals > 3
*'''CA Description:''' Test to see how many generals were killed
*'''Battle/Strat:''' Either
*'''Class:''' GENERALS_ARMY_KILLED_GENERALS_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

PercentageRoutedOffField (M2-Scripting)

2008-09-21T18:48:55Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' PercentageRoutedOffField > 35.8
*'''CA Description:''' Test to see the percentage of the character's soldiers who routed
*'''Battle/Strat:''' Either
*'''Class:''' PERCENTAGE_ROUTED_OFF_FIELD_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

PercentageBodyguardKilled (M2-Scripting)

2008-09-21T18:48:31Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' PercentageBodyguardKilled > 35.8
*'''CA Description:''' Test to see what percentage of their bodyguard was killed in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' PERCENTAGE_OF_GENERALS_UNIT_KILLED_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

PercentageEnemyKilled (M2-Scripting)

2008-09-21T18:48:21Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' PercentageEnemyKilled > 35.8
*'''CA Description:''' Test to see what percentage of the enemy was killed in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' PERCENTAGE_OF_ENEMY_KILLED_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

I PercentageOfArmyKilled (M2-Scripting)

2008-09-21T18:48:07Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' alliance_index army_index logic_token percentage
*'''CA Example:''' I_PercentageOfArmyKilled 1 0 < 50
*'''CA Description:''' Tests the percentage of casualties taken by the specified army during this battle
*'''Battle/Strat:''' Battle
*'''Class:''' BATTLE_PERCENTAGE_OF_ARMY_KILLED

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

GeneralFoughtInCombat (M2-Scripting)

2008-09-21T18:47:54Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' GeneralFoughtInCombat
*'''CA Description:''' Test to see if the character entered combat in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' GENERAL_FOUGHT_IN_COMBAT

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

GeneralHPLostRatioinBattle (M2-Scripting)

2008-09-21T18:47:41Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' GeneralHPLostRatioinBattle > 35.8
*'''CA Description:''' Test to see what the HP lost ratio of the prior battle was
*'''Battle/Strat:''' Either
*'''Class:''' GENERALS_LOST_HP_RATIO_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Ally Routs (M2-Scripting)

2008-09-21T18:47:22Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' Ally_Routs
*'''CA Description:''' Did any ally's general's units rout in the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' ALLY_ROUTS

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Routs (M2-Scripting)

2008-09-21T18:47:09Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' Routs
*'''CA Description:''' Did the general's unit rout in the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' ROUTS

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

I WonBattle (M2-Scripting)

2008-09-21T18:46:56Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' Faction
*'''CA Example:''' I_WonBattle spain
*'''CA Description:''' Did the faction win the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' I_WON_BATTLE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

WonBattle (M2-Scripting)

2008-09-21T18:46:36Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' WonBattle
*'''CA Description:''' Did the general win the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' WON_BATTLE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

I InBattle (M2-Scripting)

2008-09-21T18:46:20Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' None
*'''CA Example:''' InBattle
*'''CA Description:''' Are we in battle?
*'''Battle/Strat:''' Either
*'''Class:''' IN_BATTLE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

GeneralFoughtCulture (M2-Scripting)

2008-09-21T18:46:07Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' culture type
*'''CA Example:''' GeneralFoughtCulture southern_european
*'''CA Description:''' Test to see whether the opponent was of a particular culture in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' FOUGHT_CULTURE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

LosingMoney (M2-Scripting)

2008-09-21T18:45:52Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' None
*'''CA Example:''' LosingMoney
*'''CA Description:''' Is the faction losing money on the end of year balance sheet?
*'''Battle/Strat:''' Strat
*'''Class:''' LOSING_MONEY

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

BattlePlayerMountClass (M2-Scripting)

2008-09-21T18:45:36Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[player_unit (M2-Scripting)|player_unit]]
*'''Parameters:''' mount_class (horse, camel, elephant, chariot)
*'''CA Example:''' BattlePlayerMountClass = horse
*'''CA Description:''' What is the mount class of the player unit?
*'''Battle/Strat:''' Battle
*'''Class:''' BATTLE_PLAYER_MOUNT_CLASS

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

PercentageOfArmyKilled (M2-Scripting)

2008-09-21T18:45:21Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' PercentageOfArmyKilled > 35.8
*'''CA Description:''' Test to see what percentage of their men they lost in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' PERCENTAGE_OF_ARMY_KILLED_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== Sample Triggers ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Conditions (M2-Scripting)

2008-09-21T01:15:12Z

76.95.63.145: /* Conditions Table */

__TOC__

'''Conditions''' are the parameters in scripting used to test for the existence of certain situations, in order to execute the script. They are used to narrow the firing of a script down to a required set of triggers which must come back true in order for the script to be fired. A knowledge of the conditions available allows a scripter to tailor their scripts to very precise situations. Some conditions requires certain triggers in order to be executed, which the event they are using has to export, or the condition can not apply to it.

'''These trigger requirements 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.

== Conditions Table ==

''This table is a Work in Progress, if you would like to help out, please [http://www.twcenter.net/forums/private.php?do=newpm&u=14571 PM Augustus Lucifer]. Help is encouraged, but in order to make sure a condition isn't added twice or skipped, help needs to be coordinated. Thank you.''

{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Conditions Table'''
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |Trigger Requirements!!style="background:#bfc0f7;" |Parameters!!style="background:#bfc0f7;" |Battle!!style="background:#bfc0f7;" |Strat
|-
|[[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-
|[[BattlePlayerMountClass (M2-Scripting)|BattlePlayerMountClass]]||[[player_unit (M2-Scripting)|player_unit]]||Mount Class||10Yes||10Yes
|-
|[[LosingMoney (M2-Scripting)|LosingMoney]]||None||None||15No||10Yes
|-
|[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]||[[character_record (M2-Scripting)|character_record]]||Culture Type||10Yes||10Yes
|-
|[[I_InBattle (M2-Scripting)|I_InBattle]]||None||None||10Yes||10Yes
|-
|[[WonBattle (M2-Scripting)|WonBattle]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[I_WonBattle (M2-Scripting)|I_WonBattle]]||None||Faction||10Yes||10Yes
|-
|[[Routs (M2-Scripting)|Routs]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[Ally_Routs (M2-Scripting)|Ally_Routs]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[GeneralHPLostRatioinBattle (M2-Scripting)|GeneralHPLostRatioinBattle]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-class="sortbottom"
|Identifier||Trigger Requirements||Parameters||Battle||Strat
|}

'''Template:''' |[[Conditions (M2-Scripting)|Identifier]]||[[Conditions (M2-Scripting)|Trigger Requirements]]||Parameters||Battle||Strat

== Parameters ==

''This section is incomplete''

Descriptions for how each parameter is determined and input will be added, and some similar may be combined. The current order is the order taken from the CA DocuDemons, they will be more properly organized by category/usage later on.

'''None''' - To Be Amended

'''Logic Token''' - To Be Amended

'''Test Value''' - To Be Amended

'''Percentage''' - To Be Amended

'''Army Index''' - To Be Amended

'''Alliance Index''' - To Be Amended

'''Unit Category''' - To Be Amended

'''Faction Type''' - To Be Amended

'''Culture Type''' - To Be Amended

'''Conflict Type''' - To Be Amended

'''Success Type''' - To Be Amended

'''Siege Engine Class''' - To Be Amended

'''Tower Defence Type''' - To Be Amended

'''Wall Level''' - To Be Amended

'''Building Type''' - To Be Amended

'''Gate Strength''' - To Be Amended

'''Unit Class''' - To Be Amended

'''Siege Engine Category''' - To Be Amended

'''Formation''' - To Be Amended

'''Special Ability''' - To Be Amended

'''Mount Class''' - To Be Amended

'''Action Status''' - To Be Amended

'''Attack Direction''' - To Be Amended

'''Hide Type''' - To Be Amended

'''Unit Label''' - To Be Amended

'''Other Unit Label''' - To Be Amended

'''Position X''' - To Be Amended

'''Position Y''' - To Be Amended

'''Distance''' - To Be Amended

'''Location 1''' - To Be Amended

'''Location 2''' - To Be Amended

'''Attacker Unit Label''' - To Be Amended

'''Target Unit Label''' - To Be Amended

'''Radius''' - To Be Amended

'''Group Label''' - To Be Amended

'''Target Group Label''' - To Be Amended

'''Unit Match Type''' - To Be Amended

'''Attribute''' - To Be Amended

'''Value(float)''' - To Be Amended

'''Trait Description''' - To Be Amended

'''Level''' - To Be Amended

'''Character Type''' - To Be Amended

'''Event Type''' - To Be Amended

'''Character Faction Type''' - To Be Amended

'''Original Faction Type''' - To Be Amended

'''Original Culture Type''' - To Be Amended

'''Character''' - To Be Amended

'''Action''' - To Be Amended

'''Distance In Squares''' - To Be Amended

'''Religion''' - To Be Amended

'''Turns''' - To Be Amended

'''Religion Percentage''' - To Be Amended

'''Heresy Percentage''' - To Be Amended

'''Ancillary Name/Type''' - To Be Amended

'''Ransom Type''' - To Be Amended

'''Age''' - To Be Amended

'''Tax Level''' - To Be Amended

'''Success Level''' - To Be Amended

'''Stance''' - To Be Amended

'''Score Type''' - To Be Amended

'''Quantity''' - To Be Amended

'''Mission ID''' - To Be Amended

'''Turns Remaining''' - To Be Amended

'''Source ID''' - To Be Amended

'''Transgression Name''' - To Be Amended

'''Forgiveness Name''' - To Be Amended

'''AI Label''' - To Be Amended

'''Event Name''' - To Be Amended

'''PositionInRect''' - To Be Amended

'''Crusade Outcome''' - To Be Amended

'''Difficulty''' - To Be Amended

'''Settlement Name''' - To Be Amended

'''Building Description''' - To Be Amended

'''Plug-In''' - To Be Amended

'''Loyalty Value''' - To Be Amended

'''Build Type''' - To Be Amended

'''Auto-management Type''' - To Be Amended

'''Castle/City''' - To Be Amended

'''Advice Thread''' - To Be Amended

'''Trigger Name''' - To Be Amended

'''Message Identifier''' - To Be Amended

'''Element ID''' - To Be Amended

'''Function ID''' - To Be Amended

'''Scroll ID''' - To Be Amended

'''Button ID''' - To Be Amended

'''UI Element ID''' - To Be Amended

'''Script Counter''' - To Be Amended

'''Timer ID''' - To Be Amended

'''Duration''' - To Be Amended

'''Sound Event Tag''' - To Be Amended

== See Also ==
*[[Modding:Coding]]

== External Links ==
*[http://www.twcenter.net/forums/downloads.php?do=file&id=1579 Ultimate DocuDemons 4.0]
*[http://www.twmodsquad.com/index.php?PHPSESSID=37262cff4c104c4935a64eea165d9f72&cat=1 TW Mod Squad - Scripting]
*[http://forums.totalwar.org/vb/showthread.php?t=73016 List of Events, Commands, and Conditions from CA]
*[http://www.twcenter.net/forums/forumdisplay.php?f=743 J@mes TWC-U Scripting Class]
*[http://forums.totalwar.org/vb/showthread.php?t=82855 alpaca's Script-o-Rama]
*[http://www.twcenter.net/forums/showthread.php?t=176050 GrnEyedDvl's Scripts n' Stuff]
*[http://forums.totalwar.org/vb/showthread.php?t=77177 alpaca's Beginner Scripting Tutorial]

I InBattle (M2-Scripting)

2008-09-21T01:13:10Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' None *'''Parameters:''' None *'''CA Example:''' InBattle *'''CA Description:''' Are we in battle?...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' None
*'''CA Example:''' InBattle
*'''CA Description:''' Are we in battle?
*'''Battle/Strat:''' Either
*'''Class:''' IN_BATTLE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Routs (M2-Scripting)

2008-09-21T01:11:26Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' character_record *'''Parameters:''' None *'''CA Example:''' R...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' Routs
*'''CA Description:''' Did the general's unit rout in the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' ROUTS

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Conditions (M2-Scripting)

2008-09-21T01:10:17Z

76.95.63.145: /* Conditions Table */

__TOC__

'''Conditions''' are the parameters in scripting used to test for the existence of certain situations, in order to execute the script. They are used to narrow the firing of a script down to a required set of triggers which must come back true in order for the script to be fired. A knowledge of the conditions available allows a scripter to tailor their scripts to very precise situations. Some conditions requires certain triggers in order to be executed, which the event they are using has to export, or the condition can not apply to it.

'''These trigger requirements 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.

== Conditions Table ==

{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Conditions Table'''
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |Trigger Requirements!!style="background:#bfc0f7;" |Parameters!!style="background:#bfc0f7;" |Battle!!style="background:#bfc0f7;" |Strat
|-
|[[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-
|[[BattlePlayerMountClass (M2-Scripting)|BattlePlayerMountClass]]||[[player_unit (M2-Scripting)|player_unit]]||Mount Class||10Yes||10Yes
|-
|[[LosingMoney (M2-Scripting)|LosingMoney]]||None||None||15No||10Yes
|-
|[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]||[[character_record (M2-Scripting)|character_record]]||Culture Type||10Yes||10Yes
|-
|[[I_InBattle (M2-Scripting)|I_InBattle]]||None||None||10Yes||10Yes
|-
|[[WonBattle (M2-Scripting)|WonBattle]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[I_WonBattle (M2-Scripting)|I_WonBattle]]||None||Faction||10Yes||10Yes
|-
|[[Routs (M2-Scripting)|Routs]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[Ally_Routs (M2-Scripting)|Ally_Routs]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[GeneralHPLostRatioinBattle (M2-Scripting)|GeneralHPLostRatioinBattle]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-class="sortbottom"
|Identifier||Trigger Requirements||Parameters||Battle||Strat
|}

'''Template:''' |[[Conditions (M2-Scripting)|Identifier]]||[[Conditions (M2-Scripting)|Trigger Requirements]]||Parameters||Battle||Strat

== Parameters ==

''This section is incomplete''

Descriptions for how each parameter is determined and input will be added, and some similar may be combined. The current order is the order taken from the CA DocuDemons, they will be more properly organized by category/usage later on.

'''None''' - To Be Amended

'''Logic Token''' - To Be Amended

'''Test Value''' - To Be Amended

'''Percentage''' - To Be Amended

'''Army Index''' - To Be Amended

'''Alliance Index''' - To Be Amended

'''Unit Category''' - To Be Amended

'''Faction Type''' - To Be Amended

'''Culture Type''' - To Be Amended

'''Conflict Type''' - To Be Amended

'''Success Type''' - To Be Amended

'''Siege Engine Class''' - To Be Amended

'''Tower Defence Type''' - To Be Amended

'''Wall Level''' - To Be Amended

'''Building Type''' - To Be Amended

'''Gate Strength''' - To Be Amended

'''Unit Class''' - To Be Amended

'''Siege Engine Category''' - To Be Amended

'''Formation''' - To Be Amended

'''Special Ability''' - To Be Amended

'''Mount Class''' - To Be Amended

'''Action Status''' - To Be Amended

'''Attack Direction''' - To Be Amended

'''Hide Type''' - To Be Amended

'''Unit Label''' - To Be Amended

'''Other Unit Label''' - To Be Amended

'''Position X''' - To Be Amended

'''Position Y''' - To Be Amended

'''Distance''' - To Be Amended

'''Location 1''' - To Be Amended

'''Location 2''' - To Be Amended

'''Attacker Unit Label''' - To Be Amended

'''Target Unit Label''' - To Be Amended

'''Radius''' - To Be Amended

'''Group Label''' - To Be Amended

'''Target Group Label''' - To Be Amended

'''Unit Match Type''' - To Be Amended

'''Attribute''' - To Be Amended

'''Value(float)''' - To Be Amended

'''Trait Description''' - To Be Amended

'''Level''' - To Be Amended

'''Character Type''' - To Be Amended

'''Event Type''' - To Be Amended

'''Character Faction Type''' - To Be Amended

'''Original Faction Type''' - To Be Amended

'''Original Culture Type''' - To Be Amended

'''Character''' - To Be Amended

'''Action''' - To Be Amended

'''Distance In Squares''' - To Be Amended

'''Religion''' - To Be Amended

'''Turns''' - To Be Amended

'''Religion Percentage''' - To Be Amended

'''Heresy Percentage''' - To Be Amended

'''Ancillary Name/Type''' - To Be Amended

'''Ransom Type''' - To Be Amended

'''Age''' - To Be Amended

'''Tax Level''' - To Be Amended

'''Success Level''' - To Be Amended

'''Stance''' - To Be Amended

'''Score Type''' - To Be Amended

'''Quantity''' - To Be Amended

'''Mission ID''' - To Be Amended

'''Turns Remaining''' - To Be Amended

'''Source ID''' - To Be Amended

'''Transgression Name''' - To Be Amended

'''Forgiveness Name''' - To Be Amended

'''AI Label''' - To Be Amended

'''Event Name''' - To Be Amended

'''PositionInRect''' - To Be Amended

'''Crusade Outcome''' - To Be Amended

'''Difficulty''' - To Be Amended

'''Settlement Name''' - To Be Amended

'''Building Description''' - To Be Amended

'''Plug-In''' - To Be Amended

'''Loyalty Value''' - To Be Amended

'''Build Type''' - To Be Amended

'''Auto-management Type''' - To Be Amended

'''Castle/City''' - To Be Amended

'''Advice Thread''' - To Be Amended

'''Trigger Name''' - To Be Amended

'''Message Identifier''' - To Be Amended

'''Element ID''' - To Be Amended

'''Function ID''' - To Be Amended

'''Scroll ID''' - To Be Amended

'''Button ID''' - To Be Amended

'''UI Element ID''' - To Be Amended

'''Script Counter''' - To Be Amended

'''Timer ID''' - To Be Amended

'''Duration''' - To Be Amended

'''Sound Event Tag''' - To Be Amended

== See Also ==
*[[Modding:Coding]]

== External Links ==
*[http://www.twcenter.net/forums/downloads.php?do=file&id=1579 Ultimate DocuDemons 4.0]
*[http://www.twmodsquad.com/index.php?PHPSESSID=37262cff4c104c4935a64eea165d9f72&cat=1 TW Mod Squad - Scripting]
*[http://forums.totalwar.org/vb/showthread.php?t=73016 List of Events, Commands, and Conditions from CA]
*[http://www.twcenter.net/forums/forumdisplay.php?f=743 J@mes TWC-U Scripting Class]
*[http://forums.totalwar.org/vb/showthread.php?t=82855 alpaca's Script-o-Rama]
*[http://www.twcenter.net/forums/showthread.php?t=176050 GrnEyedDvl's Scripts n' Stuff]
*[http://forums.totalwar.org/vb/showthread.php?t=77177 alpaca's Beginner Scripting Tutorial]

I WonBattle (M2-Scripting)

2008-09-21T01:09:59Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' None *'''Parameters:''' Faction *'''CA Example:''' I_WonBattle spain *'''CA Description:''' Did t...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' Faction
*'''CA Example:''' I_WonBattle spain
*'''CA Description:''' Did the faction win the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' I_WON_BATTLE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

GeneralHPLostRatioinBattle (M2-Scripting)

2008-09-21T01:06:59Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' character_record *'''Parameters:''' logic token, test value *...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' GeneralHPLostRatioinBattle > 35.8
*'''CA Description:''' Test to see what the HP lost ratio of the prior battle was
*'''Battle/Strat:''' Either
*'''Class:''' GENERALS_LOST_HP_RATIO_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Ally Routs (M2-Scripting)

2008-09-21T01:05:58Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' character_record *'''Parameters:''' None *'''CA Example:''' A...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' Ally_Routs
*'''CA Description:''' Did any ally's general's units rout in the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' ALLY_ROUTS

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Character record (M2-Scripting)

2008-09-21T01:04:51Z

76.95.63.145: /* Conditions That Require */

__TOC__
character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

Listed Alphabetically

[[Ally_Routs (M2-Scripting)|Ally_Routs]]
 [[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]
 [[GeneralHPLostRatioinBattle (M2-Scripting)|GeneralHPLostRatioinBattle]]
 [[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]
 [[Routs (M2-Scripting)|Routs]]
 [[WonBattle (M2-Scripting)|WonBattle]]

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

WonBattle (M2-Scripting)

2008-09-21T01:03:16Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' character_record *'''Parameters:''' None *'''CA Example:''' W...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' None
*'''CA Example:''' WonBattle
*'''CA Description:''' Did the general win the battle just fought?
*'''Battle/Strat:''' Either
*'''Class:''' WON_BATTLE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Conditions (M2-Scripting)

2008-09-21T01:01:17Z

76.95.63.145:

__TOC__

'''Conditions''' are the parameters in scripting used to test for the existence of certain situations, in order to execute the script. They are used to narrow the firing of a script down to a required set of triggers which must come back true in order for the script to be fired. A knowledge of the conditions available allows a scripter to tailor their scripts to very precise situations. Some conditions requires certain triggers in order to be executed, which the event they are using has to export, or the condition can not apply to it.

'''These trigger requirements 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.

== Conditions Table ==

{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Conditions Table'''
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |Trigger Requirements!!style="background:#bfc0f7;" |Parameters!!style="background:#bfc0f7;" |Battle!!style="background:#bfc0f7;" |Strat
|-
|[[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-
|[[BattlePlayerMountClass (M2-Scripting)|BattlePlayerMountClass]]||[[player_unit (M2-Scripting)|player_unit]]||Mount Class||10Yes||10Yes
|-
|[[LosingMoney (M2-Scripting)|LosingMoney]]||None||None||15No||10Yes
|-
|[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]||[[character_record (M2-Scripting)|character_record]]||Culture Type||10Yes||10Yes
|-
|[[I_InBattle (M2-Scripting)|I_InBattle]]||None||None||10Yes||10Yes
|-
|[[WonBattle (M2-Scripting)|WonBattle]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[I_WonBattle (M2-Scripting)|I_WonBattle]]||None||None||10Yes||10Yes
|-
|[[Routs (M2-Scripting)|Routs]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[Ally_Routs (M2-Scripting)|Ally_Routs]]||[[character_record (M2-Scripting)|character_record]]||None||10Yes||10Yes
|-
|[[GeneralHPLostRatioinBattle (M2-Scripting)|GeneralHPLostRatioinBattle]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-class="sortbottom"
|Identifier||Trigger Requirements||Parameters||Battle||Strat
|}

'''Template:''' |[[Conditions (M2-Scripting)|Identifier]]||[[Conditions (M2-Scripting)|Trigger Requirements]]||Parameters||Battle||Strat

== Parameters ==

''This section is incomplete''

Descriptions for how each parameter is determined and input will be added, and some similar may be combined. The current order is the order taken from the CA DocuDemons, they will be more properly organized by category/usage later on.

'''None''' - To Be Amended

'''Logic Token''' - To Be Amended

'''Test Value''' - To Be Amended

'''Percentage''' - To Be Amended

'''Army Index''' - To Be Amended

'''Alliance Index''' - To Be Amended

'''Unit Category''' - To Be Amended

'''Faction Type''' - To Be Amended

'''Culture Type''' - To Be Amended

'''Conflict Type''' - To Be Amended

'''Success Type''' - To Be Amended

'''Siege Engine Class''' - To Be Amended

'''Tower Defence Type''' - To Be Amended

'''Wall Level''' - To Be Amended

'''Building Type''' - To Be Amended

'''Gate Strength''' - To Be Amended

'''Unit Class''' - To Be Amended

'''Siege Engine Category''' - To Be Amended

'''Formation''' - To Be Amended

'''Special Ability''' - To Be Amended

'''Mount Class''' - To Be Amended

'''Action Status''' - To Be Amended

'''Attack Direction''' - To Be Amended

'''Hide Type''' - To Be Amended

'''Unit Label''' - To Be Amended

'''Other Unit Label''' - To Be Amended

'''Position X''' - To Be Amended

'''Position Y''' - To Be Amended

'''Distance''' - To Be Amended

'''Location 1''' - To Be Amended

'''Location 2''' - To Be Amended

'''Attacker Unit Label''' - To Be Amended

'''Target Unit Label''' - To Be Amended

'''Radius''' - To Be Amended

'''Group Label''' - To Be Amended

'''Target Group Label''' - To Be Amended

'''Unit Match Type''' - To Be Amended

'''Attribute''' - To Be Amended

'''Value(float)''' - To Be Amended

'''Trait Description''' - To Be Amended

'''Level''' - To Be Amended

'''Character Type''' - To Be Amended

'''Event Type''' - To Be Amended

'''Character Faction Type''' - To Be Amended

'''Original Faction Type''' - To Be Amended

'''Original Culture Type''' - To Be Amended

'''Character''' - To Be Amended

'''Action''' - To Be Amended

'''Distance In Squares''' - To Be Amended

'''Religion''' - To Be Amended

'''Turns''' - To Be Amended

'''Religion Percentage''' - To Be Amended

'''Heresy Percentage''' - To Be Amended

'''Ancillary Name/Type''' - To Be Amended

'''Ransom Type''' - To Be Amended

'''Age''' - To Be Amended

'''Tax Level''' - To Be Amended

'''Success Level''' - To Be Amended

'''Stance''' - To Be Amended

'''Score Type''' - To Be Amended

'''Quantity''' - To Be Amended

'''Mission ID''' - To Be Amended

'''Turns Remaining''' - To Be Amended

'''Source ID''' - To Be Amended

'''Transgression Name''' - To Be Amended

'''Forgiveness Name''' - To Be Amended

'''AI Label''' - To Be Amended

'''Event Name''' - To Be Amended

'''PositionInRect''' - To Be Amended

'''Crusade Outcome''' - To Be Amended

'''Difficulty''' - To Be Amended

'''Settlement Name''' - To Be Amended

'''Building Description''' - To Be Amended

'''Plug-In''' - To Be Amended

'''Loyalty Value''' - To Be Amended

'''Build Type''' - To Be Amended

'''Auto-management Type''' - To Be Amended

'''Castle/City''' - To Be Amended

'''Advice Thread''' - To Be Amended

'''Trigger Name''' - To Be Amended

'''Message Identifier''' - To Be Amended

'''Element ID''' - To Be Amended

'''Function ID''' - To Be Amended

'''Scroll ID''' - To Be Amended

'''Button ID''' - To Be Amended

'''UI Element ID''' - To Be Amended

'''Script Counter''' - To Be Amended

'''Timer ID''' - To Be Amended

'''Duration''' - To Be Amended

'''Sound Event Tag''' - To Be Amended

== See Also ==
*[[Modding:Coding]]

== External Links ==
*[http://www.twcenter.net/forums/downloads.php?do=file&id=1579 Ultimate DocuDemons 4.0]
*[http://www.twmodsquad.com/index.php?PHPSESSID=37262cff4c104c4935a64eea165d9f72&cat=1 TW Mod Squad - Scripting]
*[http://forums.totalwar.org/vb/showthread.php?t=73016 List of Events, Commands, and Conditions from CA]
*[http://www.twcenter.net/forums/forumdisplay.php?f=743 J@mes TWC-U Scripting Class]
*[http://forums.totalwar.org/vb/showthread.php?t=82855 alpaca's Script-o-Rama]
*[http://www.twcenter.net/forums/showthread.php?t=176050 GrnEyedDvl's Scripts n' Stuff]
*[http://forums.totalwar.org/vb/showthread.php?t=77177 alpaca's Beginner Scripting Tutorial]

Player unit (M2-Scripting)

2008-09-21T00:43:04Z

76.95.63.145:

__TOC__
player_unit is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

Listed Alphabetically

[[BattlePlayerMountClass (M2-Scripting)|BattlePlayerMountClass]]

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

Player unit (M2-Scripting)

2008-09-21T00:42:42Z

76.95.63.145: New page: __TOC__ character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions. == Detailed Information == To Be Amended == Events That Export == To ...

Character record (M2-Scripting)

2008-09-21T00:41:33Z

76.95.63.145: /* Conditions That Require */

__TOC__
character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

Listed Alphabetically

[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]
 [[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

Character record (M2-Scripting)

2008-09-21T00:41:20Z

76.95.63.145: /* Conditions That Require */

__TOC__
character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

Listed Alphabetically

 [[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]
 [[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

Character record (M2-Scripting)

2008-09-21T00:41:11Z

76.95.63.145: /* Conditions That Require */

__TOC__
character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

Listed Alphabetically
 [[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]
 [[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

Character record (M2-Scripting)

2008-09-21T00:40:48Z

76.95.63.145:

__TOC__
character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

Listed Alphabetically

[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]
[[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

Character record (M2-Scripting)

2008-09-21T00:39:14Z

76.95.63.145:

__TOC__
character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

To Be Amended

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

Character record (M2-Scripting)

2008-09-21T00:38:53Z

76.95.63.145: New page: character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions. == Detailed Information == To Be Amended == Events That Export == To Be Amend...

character_record is a trigger exported by some Scripting Events and required by some Scripting Conditions.

== Detailed Information ==

To Be Amended

== Events That Export ==

To Be Amended

== Conditions That Require ==

To Be Amended

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition/trigger pages and information on parameters.

GeneralFoughtCulture (M2-Scripting)

2008-09-21T00:35:50Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' character_record *'''Parameters:''' culture type *'''CA Examp...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' culture type
*'''CA Example:''' GeneralFoughtCulture southern_european
*'''CA Description:''' Test to see whether the opponent was of a particular culture in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' FOUGHT_CULTURE

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

LosingMoney (M2-Scripting)

2008-09-21T00:33:48Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' None *'''Parameters:''' None *'''CA Example:''' LosingMoney *'''CA Description:''' Is the faction...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' None
*'''Parameters:''' None
*'''CA Example:''' LosingMoney
*'''CA Description:''' Is the faction losing money on the end of year balance sheet?
*'''Battle/Strat:''' Strat
*'''Class:''' LOSING_MONEY

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

PercentageOfArmyKilled (M2-Scripting)

2008-09-21T00:32:26Z

76.95.63.145:

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting)|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' PercentageOfArmyKilled > 35.8
*'''CA Description:''' Test to see what percentage of their men they lost in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' PERCENTAGE_OF_ARMY_KILLED_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

BattlePlayerMountClass (M2-Scripting)

2008-09-21T00:31:51Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' player_unit *'''Parameters:''' mount_class (horse, camel, elephant...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[player_unit (M2-Scripting)|player_unit]]
*'''Parameters:''' mount_class (horse, camel, elephant, chariot)
*'''CA Example:''' BattlePlayerMountClass = horse
*'''CA Description:''' What is the mount class of the player unit?
*'''Battle/Strat:''' Battle
*'''Class:''' BATTLE_PLAYER_MOUNT_CLASS

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Conditions (M2-Scripting)

2008-09-21T00:29:42Z

76.95.63.145: /* Conditions Table */

__TOC__

'''Conditions''' are the parameters in scripting used to test for the existence of certain situations, in order to execute the script. They are used to narrow the firing of a script down to a required set of triggers which must come back true in order for the script to be fired. A knowledge of the conditions available allows a scripter to tailor their scripts to very precise situations. Some conditions requires certain triggers in order to be executed, which the event they are using has to export, or the condition can not apply to it.

'''These trigger requirements 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.

== Conditions Table ==

{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Conditions Table'''
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |Trigger Requirements!!style="background:#bfc0f7;" |Parameters!!style="background:#bfc0f7;" |Battle!!style="background:#bfc0f7;" |Strat
|-
|[[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-
|[[BattlePlayerMountClass (M2-Scripting)|BattlePlayerMountClass]]||[[player_unit (M2-Scripting)|player_unit]]||Mount Class||10Yes||10Yes
|-
|[[LosingMoney (M2-Scripting)|LosingMoney]]||None||None||15No||10Yes
|-
|[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]||[[character_record (M2-Scripting)|character_record]]||Culture Type||10Yes||10Yes
|-class="sortbottom"
|Identifier||Trigger Requirements||Parameters||Battle||Strat
|}

'''Template:''' |[[Conditions (M2-Scripting)|Identifier]]||[[Conditions (M2-Scripting)|Trigger Requirements]]||Parameters||Battle||Strat

== Parameters ==

''This section is incomplete''

Descriptions for how each parameter is determined and input will be added, and some similar may be combined. The current order is the order taken from the CA DocuDemons, they will be more properly organized by category/usage later on.

'''None''' - To Be Amended

'''Logic Token''' - To Be Amended

'''Test Value''' - To Be Amended

'''Percentage''' - To Be Amended

'''Army Index''' - To Be Amended

'''Alliance Index''' - To Be Amended

'''Unit Category''' - To Be Amended

'''Faction Type''' - To Be Amended

'''Culture Type''' - To Be Amended

'''Conflict Type''' - To Be Amended

'''Success Type''' - To Be Amended

'''Siege Engine Class''' - To Be Amended

'''Tower Defence Type''' - To Be Amended

'''Wall Level''' - To Be Amended

'''Building Type''' - To Be Amended

'''Gate Strength''' - To Be Amended

'''Unit Class''' - To Be Amended

'''Siege Engine Category''' - To Be Amended

'''Formation''' - To Be Amended

'''Special Ability''' - To Be Amended

'''Mount Class''' - To Be Amended

'''Action Status''' - To Be Amended

'''Attack Direction''' - To Be Amended

'''Hide Type''' - To Be Amended

'''Unit Label''' - To Be Amended

'''Other Unit Label''' - To Be Amended

'''Position X''' - To Be Amended

'''Position Y''' - To Be Amended

'''Distance''' - To Be Amended

'''Location 1''' - To Be Amended

'''Location 2''' - To Be Amended

'''Attacker Unit Label''' - To Be Amended

'''Target Unit Label''' - To Be Amended

'''Radius''' - To Be Amended

'''Group Label''' - To Be Amended

'''Target Group Label''' - To Be Amended

'''Unit Match Type''' - To Be Amended

'''Attribute''' - To Be Amended

'''Value(float)''' - To Be Amended

'''Trait Description''' - To Be Amended

'''Level''' - To Be Amended

'''Character Type''' - To Be Amended

'''Event Type''' - To Be Amended

'''Character Faction Type''' - To Be Amended

'''Original Faction Type''' - To Be Amended

'''Original Culture Type''' - To Be Amended

'''Character''' - To Be Amended

'''Action''' - To Be Amended

'''Distance In Squares''' - To Be Amended

'''Religion''' - To Be Amended

'''Turns''' - To Be Amended

'''Religion Percentage''' - To Be Amended

'''Heresy Percentage''' - To Be Amended

'''Ancillary Name/Type''' - To Be Amended

'''Ransom Type''' - To Be Amended

'''Age''' - To Be Amended

'''Tax Level''' - To Be Amended

'''Success Level''' - To Be Amended

'''Stance''' - To Be Amended

'''Score Type''' - To Be Amended

'''Quantity''' - To Be Amended

'''Mission ID''' - To Be Amended

'''Turns Remaining''' - To Be Amended

'''Source ID''' - To Be Amended

'''Transgression Name''' - To Be Amended

'''Forgiveness Name''' - To Be Amended

'''AI Label''' - To Be Amended

'''Event Name''' - To Be Amended

'''PositionInRect''' - To Be Amended

'''Crusade Outcome''' - To Be Amended

'''Difficulty''' - To Be Amended

'''Settlement Name''' - To Be Amended

'''Building Description''' - To Be Amended

'''Plug-In''' - To Be Amended

'''Loyalty Value''' - To Be Amended

'''Build Type''' - To Be Amended

'''Auto-management Type''' - To Be Amended

'''Castle/City''' - To Be Amended

'''Advice Thread''' - To Be Amended

'''Trigger Name''' - To Be Amended

'''Message Identifier''' - To Be Amended

'''Element ID''' - To Be Amended

'''Function ID''' - To Be Amended

'''Scroll ID''' - To Be Amended

'''Button ID''' - To Be Amended

'''UI Element ID''' - To Be Amended

'''Script Counter''' - To Be Amended

'''Timer ID''' - To Be Amended

'''Duration''' - To Be Amended

'''Sound Event Tag''' - To Be Amended

== See Also ==
*[[Modding:Coding]]

== External Links ==
*[http://www.twcenter.net/forums/downloads.php?do=file&id=1579 Ultimate DocuDemons 4.0]
*[http://www.twmodsquad.com/index.php?PHPSESSID=37262cff4c104c4935a64eea165d9f72&cat=1 TW Mod Squad - Scripting]
*[http://forums.totalwar.org/vb/showthread.php?t=73016 List of Events, Commands, and Conditions from CA]
*[http://www.twcenter.net/forums/forumdisplay.php?f=743 J@mes TWC-U Scripting Class]
*[http://forums.totalwar.org/vb/showthread.php?t=82855 alpaca's Script-o-Rama]
*[http://www.twcenter.net/forums/showthread.php?t=176050 GrnEyedDvl's Scripts n' Stuff]
*[http://forums.totalwar.org/vb/showthread.php?t=77177 alpaca's Beginner Scripting Tutorial]

PercentageOfArmyKilled (M2-Scripting)

2008-09-21T00:29:01Z

76.95.63.145: New page: __TOC__ *'''Type:''' Condition *'''Trigger Requirements:''' character_record *'''Parameters:''' logic token, test value *'...

__TOC__

*'''Type:''' [[Conditions (M2-Scripting)|Condition]]
*'''Trigger Requirements:''' [[character_record (M2-Scripting|character_record]]
*'''Parameters:''' logic token, test value
*'''CA Example:''' PercentageOfArmyKilled > 35.8
*'''CA Description:''' Test to see what percentage of their men they lost in the prior battle
*'''Battle/Strat:''' Either
*'''Class:''' PERCENTAGE_OF_ARMY_KILLED_TEST

== Detailed Description ==

None currently

== Sample Scripts ==

None Currently

== See Also ==
*[[Conditions (M2-Scripting)]] - For links to other condition pages and information on parameters.

Conditions (M2-Scripting)

2008-09-21T00:19:35Z

76.95.63.145: Added starter table

__TOC__

'''Conditions''' are the parameters in scripting used to test for the existence of certain situations, in order to execute the script. They are used to narrow the firing of a script down to a required set of triggers which must come back true in order for the script to be fired. A knowledge of the conditions available allows a scripter to tailor their scripts to very precise situations. Some conditions requires certain triggers in order to be executed, which the event they are using has to export, or the condition can not apply to it.

'''These trigger requirements 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.

== Conditions Table ==

{|class="wikitable sortable" border="1" cellpadding="4" cellspacing="0"
|+ style="background:#bfc0f7;" |'''Medieval II DocuDemons - Conditions Table'''
! style="background:#bfc0f7;" |Identifier!!style="background:#bfc0f7;" |Trigger Requirements!!style="background:#bfc0f7;" |Parameters!!style="background:#bfc0f7;" |Battle!!style="background:#bfc0f7;" |Strat
|-
|[[PercentageOfArmyKilled (M2-Scripting)|PercentageOfArmyKilled]]||[[character_record (M2-Scripting)|character_record]]||Logic Token, Test Value||10Yes||10Yes
|-
|[[BattlePlayerMountClass (M2-Scripting|BattlePlayerMountClass]]||[[player_unit (M2-Scripting)|player_unit]]||Mount Class||10Yes||10Yes
|-
|[[LosingMoney (M2-Scripting)|LosingMoney]]||None||None||15No||10Yes
|-
|[[GeneralFoughtCulture (M2-Scripting)|GeneralFoughtCulture]]||[[character_record (M2-Scripting)|character_record]]||Culture Type||10Yes||10Yes
|-class="sortbottom"
|Identifier||Trigger Requirements||Parameters||Battle||Strat
|}

'''Template:''' |[[Conditions (M2-Scripting)|Identifier]]||[[Conditions (M2-Scripting)|Trigger Requirements]]||Parameters||Battle||Strat

== Parameters ==

''This section is incomplete''

Descriptions for how each parameter is determined and input will be added, and some similar may be combined. The current order is the order taken from the CA DocuDemons, they will be more properly organized by category/usage later on.

'''None''' - To Be Amended

'''Logic Token''' - To Be Amended

'''Test Value''' - To Be Amended

'''Percentage''' - To Be Amended

'''Army Index''' - To Be Amended

'''Alliance Index''' - To Be Amended

'''Unit Category''' - To Be Amended

'''Faction Type''' - To Be Amended

'''Culture Type''' - To Be Amended

'''Conflict Type''' - To Be Amended

'''Success Type''' - To Be Amended

'''Siege Engine Class''' - To Be Amended

'''Tower Defence Type''' - To Be Amended

'''Wall Level''' - To Be Amended

'''Building Type''' - To Be Amended

'''Gate Strength''' - To Be Amended

'''Unit Class''' - To Be Amended

'''Siege Engine Category''' - To Be Amended

'''Formation''' - To Be Amended

'''Special Ability''' - To Be Amended

'''Mount Class''' - To Be Amended

'''Action Status''' - To Be Amended

'''Attack Direction''' - To Be Amended

'''Hide Type''' - To Be Amended

'''Unit Label''' - To Be Amended

'''Other Unit Label''' - To Be Amended

'''Position X''' - To Be Amended

'''Position Y''' - To Be Amended

'''Distance''' - To Be Amended

'''Location 1''' - To Be Amended

'''Location 2''' - To Be Amended

'''Attacker Unit Label''' - To Be Amended

'''Target Unit Label''' - To Be Amended

'''Radius''' - To Be Amended

'''Group Label''' - To Be Amended

'''Target Group Label''' - To Be Amended

'''Unit Match Type''' - To Be Amended

'''Attribute''' - To Be Amended

'''Value(float)''' - To Be Amended

'''Trait Description''' - To Be Amended

'''Level''' - To Be Amended

'''Character Type''' - To Be Amended

'''Event Type''' - To Be Amended

'''Character Faction Type''' - To Be Amended

'''Original Faction Type''' - To Be Amended

'''Original Culture Type''' - To Be Amended

'''Character''' - To Be Amended

'''Action''' - To Be Amended

'''Distance In Squares''' - To Be Amended

'''Religion''' - To Be Amended

'''Turns''' - To Be Amended

'''Religion Percentage''' - To Be Amended

'''Heresy Percentage''' - To Be Amended

'''Ancillary Name/Type''' - To Be Amended

'''Ransom Type''' - To Be Amended

'''Age''' - To Be Amended

'''Tax Level''' - To Be Amended

'''Success Level''' - To Be Amended

'''Stance''' - To Be Amended

'''Score Type''' - To Be Amended

'''Quantity''' - To Be Amended

'''Mission ID''' - To Be Amended

'''Turns Remaining''' - To Be Amended

'''Source ID''' - To Be Amended

'''Transgression Name''' - To Be Amended

'''Forgiveness Name''' - To Be Amended

'''AI Label''' - To Be Amended

'''Event Name''' - To Be Amended

'''PositionInRect''' - To Be Amended

'''Crusade Outcome''' - To Be Amended

'''Difficulty''' - To Be Amended

'''Settlement Name''' - To Be Amended

'''Building Description''' - To Be Amended

'''Plug-In''' - To Be Amended

'''Loyalty Value''' - To Be Amended

'''Build Type''' - To Be Amended

'''Auto-management Type''' - To Be Amended

'''Castle/City''' - To Be Amended

'''Advice Thread''' - To Be Amended

'''Trigger Name''' - To Be Amended

'''Message Identifier''' - To Be Amended

'''Element ID''' - To Be Amended

'''Function ID''' - To Be Amended

'''Scroll ID''' - To Be Amended

'''Button ID''' - To Be Amended

'''UI Element ID''' - To Be Amended

'''Script Counter''' - To Be Amended

'''Timer ID''' - To Be Amended

'''Duration''' - To Be Amended

'''Sound Event Tag''' - To Be Amended

== See Also ==
*[[Modding:Coding]]

== External Links ==
*[http://www.twcenter.net/forums/downloads.php?do=file&id=1579 Ultimate DocuDemons 4.0]
*[http://www.twmodsquad.com/index.php?PHPSESSID=37262cff4c104c4935a64eea165d9f72&cat=1 TW Mod Squad - Scripting]
*[http://forums.totalwar.org/vb/showthread.php?t=73016 List of Events, Commands, and Conditions from CA]
*[http://www.twcenter.net/forums/forumdisplay.php?f=743 J@mes TWC-U Scripting Class]
*[http://forums.totalwar.org/vb/showthread.php?t=82855 alpaca's Script-o-Rama]
*[http://www.twcenter.net/forums/showthread.php?t=176050 GrnEyedDvl's Scripts n' Stuff]
*[http://forums.totalwar.org/vb/showthread.php?t=77177 alpaca's Beginner Scripting Tutorial]

Conditions (M2-Scripting)

2008-09-21T00:04:43Z

76.95.63.145: /* External Links */

Conditions (M2-Scripting)

2008-09-21T00:04:00Z

76.95.63.145: /* External Links */

Conditions (M2-Scripting)

2008-09-21T00:03:26Z

76.95.63.145: Added page for Conditions, will add table later