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.

Conditions (M2-Scripting)

From TWC Wiki
Revision as of 00:44, 26 May 2020 by Makanyane (talk | contribs) (m2 logo)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
M2TW Modding Index


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, religion, event_type.

Conditions which list more than one trigger requirement need both or all of them, not just one of those listed.

Conditions Table

Sortable Table, click header to sort column.

Medieval II DocuDemons - Conditions Table
Identifier Trigger Requirements Parameters Battle Strat
PercentageOfArmyKilled character_record Logic Token, Test Value 10Yes 10Yes
BattlePlayerMountClass player_unit Mount Class 10Yes 10Yes
LosingMoney None None 15No 10Yes
GeneralFoughtCulture character_record Culture Type 10Yes 10Yes
I_InBattle None None 10Yes 10Yes
WonBattle character_record None 10Yes 10Yes
I_WonBattle None Faction 10Yes 10Yes
Routs character_record None 10Yes 10Yes
Ally_Routs character_record None 10Yes 10Yes
GeneralHPLostRatioinBattle character_record Logic Token, Test Value 10Yes 10Yes
GeneralFoughtInCombat character_record None 10Yes 10Yes
I_PercentageOfArmyKilled None Alliance Index, Army Index, Logic Token, Percentage 10Yes 15No
PercentageEnemyKilled character_record Logic Token, Test Value 10Yes 10Yes
PercentageBodyguardKilled character_record Logic Token, Test Value 10Yes 10Yes
PercentageRoutedOffField character_record Logic Token, Test Value 10Yes 10Yes
NumKilledGenerals character_record Logic Token, Test Value 10Yes 10Yes
PercentageUnitCategory character_record Unit Category, Logic Token, Test Value 10Yes 10Yes
NumFriendsInBattle character_record Logic Token, Test Value 10Yes 10Yes
GeneralFoughtFaction character_record Faction Type 10Yes 10Yes
GeneralNumKillsInBattle character_record Logic Token, Test Value 10Yes 10Yes
NumEnemiesInBattle character_record Logic Token, Test Value 10Yes 10Yes
I_ConflictType None Conflict Type 10Yes 10Yes
IsNightBattle None None 10Yes 10Yes
BattleSuccess character_record Success Type 10Yes 10Yes
BattleOdds character_record Logic Token, Test Value 10Yes 10Yes
WasAttacker character_record None 10Yes 10Yes
I_BattleAiAttacking None None 10Yes 15No
I_BattleAiAssaultingCrossing None None 10Yes 15No
I_BattleAiAttackingSettlement None None 10Yes 15No
I_BattleAiDefendingSettlement None None 10Yes 15No
I_BattleAiDefendingHill None None 10Yes 15No
I_BattleAiDefendingCrossing None None 10Yes 15No
I_BattleAiScouting None None 10Yes 15No
I_BattleIsRiverBattle None Integer 10Yes 15No
I_BattleIsSiegeBattle None Integer 10Yes 15No
I_BattleIsSallyOutBattle None Integer 10Yes 15No
I_BattleIsFortBattle None Integer 10Yes 15No
I_BattleAttackerNumSiegeEngines None Siege Engine Class 10Yes 15No
I_BattleAttackerNumArtilleryCanPenetrateWalls None Logic Token, Number 10Yes 15No
I_BattleDefenderNumNonMissileUnitsOnWalls None Logic Token, Number 10Yes 15No
I_BattleDefenderNumMissileUnitsOnWalls None Logic Token, Number 10Yes 15No
I_BattleSettlementWallsBreached None None 10Yes 15No
I_BattleSettlementGateDestroyed None None 10Yes 15No
I_BattleSettlementTowerDefence None Tower Defence Type 10Yes 15No
I_BattleSettlementFortificationLevel None Wall Level 10Yes 15No
BattleBuildingType None Building Type 10Yes 15No
I_BattleSettlementGateStrength None Gate Strength 10Yes 15No
I_BattleNumberOfRiverCrossings None Integer 10Yes 15No
BattlePlayerUnitClass player_unit Unit Class 10Yes 15No
BattleEnemyUnitClass enemy_unit Unit Class 10Yes 15No
BattlePlayerUnitCategory player_unit Unit Category 10Yes 15No
BattleEnemyUnitCategory enemy_unit Unit Category 10Yes 15No
BattlePlayerUnitSiegeEngineClass player_unit Siege Engine Category 10Yes 15No
BattleEnemyUnitSiegeEngineClass enemy_unit Siege Engine Category 10Yes 15No
BattlePlayerUnitOnWalls player_unit None 10Yes 15No
BattleEnemyUnitOnWalls enemy_unit None 10Yes 15No
BattlePlayerCurrentFormation player_unit Formation 10Yes 15No
BattleEnemyCurrentFormation enemy_unit Formation 10Yes 15No
BattlePlayerUnitCloseFormation player_unit None 10Yes 15No
BattleEnemyUnitCloseFormation enemy_unit None 10Yes 15No
BattlePlayerUnitSpecialAbilitySupported player_unit Special Ability 10Yes 15No
BattleEnemyUnitSpecialAbilitySupported enemy_unit Special Ability 10Yes 15No
BattlePlayerUnitSpecialAbilityActive player_unit None 10Yes 15No
BattleEnemyUnitSpecialAbilityActive enemy_unit None 10Yes 15No
BattleEnemyMountClass enemy_unit Mount Class 10Yes 15No
BattlePlayerUnitMeleeStrength player_unit Logic Token, Test Value 10Yes 15No
BattleEnemyUnitMeleeStrength enemy_unit Logic Token, Test Value 10Yes 15No
BattlePlayerUnitMissileStrength player_unit Logic Token, Test Value 10Yes 15No
BattleEnemyUnitMissileStrength enemy_unit Logic Token, Test Value 10Yes 15No
BattlePlayerUnitSpecialFormation player_unit Formation 10Yes 15No
BattleEnemyUnitSpecialFormation enemy_unit Formation 10Yes 15No
BattlePlayerUnitEngaged player_unit None 10Yes 15No
BattleEnemyUnitEngaged enemy_unit None 10Yes 15No
BattlePlayerActionStatus player_unit Action Status 10Yes 15No
BattleEnemyActionStatus enemy_unit Action Status 10Yes 15No
BattlePlayerUnitMovingFast player_unit None 10Yes 15No
BattleEnemyUnitMovingFast enemy_unit None 10Yes 15No
BattleRangeOfAttack player_unit, enemy_unit Logic Token, Test Value 10Yes 15No
BattleDirectionOfAttack infer_attacking_unit, infer_defending_unit Logic Token, Attack Direction 10Yes 15No
BattleIsMeleeAttack infer_attacking_unit None 10Yes 15No
I_BattlePlayerArmyPercentageOfUnitClass None Unit Class, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageOfUnitClass None Unit Class, Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyPercentageOfUnitCategory None Unit Category, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageOfUnitCategory None Unit Category, Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyPercentageOfMountClass None Mount Class, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageOfMountClass None Mount Class, Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyPercentageOfClassAndCategory None Unit Class, Unit Category, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageOfClassAndCategory None Unit Class, Unit Category, Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyPercentageOfSpecialAbility None Special Ability, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageOfSpecialAbility None Special Ability, Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyPercentageCanHide None Hide Type, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageCanHide None Hide Type, Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyPercentageCanSwim None Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageCanSwim None Logic Token, Percentage 10Yes 15No
I_BattlePlayerArmyIsAttacker None None 10Yes 15No
I_BattlePlayerAllianceOddsInFavour None Logic Token, Integer 10Yes 15No
I_BattlePlayerAllianceOddsAgainst None Logic Token, Integer 10Yes 15No
TotalSiegeWeapons character_record Logic Token, Number 15No 10Yes
I_BattleStarted None None 10Yes 15No
I_IsUnitMoveFastSet None Unit Label 10Yes 15No
I_IsUnitMoving None Unit Label 10Yes 15No
I_IsUnitIdle None Unit Label 10Yes 15No
I_UnitStatus None Unit Label, Action Status 10Yes 15No
I_IsUnitRouting None Unit Label 10Yes 15No
I_IsUnitUnderFire None Unit Label 10Yes 15No
I_IsUnitEngaged None Unit Label 10Yes 15No
I_IsUnitEngagedWithUnit None Unit Label, Other Unit Label 10Yes 15No
I_UnitFormation None Unit Label, Logic Token, Formation Type 10Yes 15No
I_PercentageUnitKilled None Unit Label, Logic Token, Percentage 10Yes 15No
I_UnitPercentageAmmoLeft None Unit Label, Logic Token, Percentage 10Yes 15No
I_UnitDistanceFromPosition None Unit Label, Position X, Position Y, Logic Token, Distance 10Yes 15No
I_UnitOrderedToPosition None Unit Label, Position X, Position Y, Logic Token, Distance 10Yes 15No
I_UnitDistanceFromLine None Unit Label, Location 1, Location 2, Logic Token, Distance 10Yes 15No
I_UnitDistanceFromUnit None Unit Label 1, Unit Label 2, Logic Token, Distance 10Yes 15No
I_UnitInRangeOfUnit None Attacker Unit Label, Target Unit Label 10Yes 15No
I_UnitDestroyed None Unit Label 10Yes 15No
I_UnitEnemyUnitInRadius None Unit Label, Radius 10Yes 15No
I_IsUnitGroupMoving None Group Label 10Yes 15No
I_IsUnitGroupEngaged None Group Label 10Yes 15No
I_IsUnitGroupIdle None Group Label 10Yes 15No
I_IsUnitGroupDestroyed None Group Label 10Yes 15No
I_PercentageUnitGroupKilled None Group Label, Logic Token, Percentage 10Yes 15No
I_UnitGroupFormation None Group Label, Logic Token, Formation Name 10Yes 15No
I_UnitGroupDistanceFromPosition None Group Label, Position, Logic Token, Distance 10Yes 15No
I_UnitGroupDistanceFromGroup None Group Label, Target Group Label, Logic Token, Distance 10Yes 15No
I_UnitGroupInRangeOfUnit None Group Label, Target Unit Label 10Yes 15No
I_UnitInRangeOfUnitGroup None Group Label, Target Group Label 10Yes 15No
I_UnitGroupInRangeOfUnitGroup None Group Label, Target Group Label 10Yes 15No
I_PlayerInRangeOfUnitGroup None Group Label 10Yes 15No
I_PlayerInRangeOfUnit None Unit Label 10Yes 15No
I_UnitTypeSelected None Unit Type 10Yes 15No
UnitType resource_description Unit Type 10Yes 10Yes
I_UnitSelected None Unit Label 10Yes 15No
I_MultipleUnitsSelected None None 10Yes 15No
I_SpecificUnitsSelected None Unit Label 1, Unit Label 2, Unit Label 3, ... 10Yes 15No
I_IsCameraZoomingToUnit None Unit Label 10Yes 15No
I_BattleEnemyArmyPercentageOfMatchingUnits None Unit Match Type, Logic Token, Test Value 10Yes 15No
I_BattleEnemyArmyNumberOfMatchingUnits None Unit Match Type, Logic Token, Test Value 10Yes 15No
I_BattlePlayerArmyPercentageOfMatchingUnits None Unit Match Type, Logic Token, Test Value 10Yes 15No
I_BattlePlayerArmyNumberOfMatchingUnits None Unit Match Type, Logic Token, Test Value 10Yes 15No
I_BattlePlayerArmyNumberOfUnitClass None Unit Class, Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfUnitClass None Unit Class, Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberOfUnitCategory None Unit Category, Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfUnitCategory None Unit Category, Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberOfMountClass None Mount Class, Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfMountClass None Mount Class, Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberOfClassAndCategory None Unit Class, Unit Category, Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfClassAndCategory None Unit Class, Unit Category, Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberOfSpecialAbility None Special Ability, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfSpecialAbility None Special Ability, Integer 10Yes 15No
I_BattlePlayerArmyNumberCanHide None Hide Type, Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberCanHide None Hide Type, Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberCanSwim None Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberCanSwim None Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberOfUnits None Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfUnits None Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyNumberOfAttribute None Attribute, Logic Token, Integer 10Yes 15No
I_BattleEnemyArmyNumberOfAttribute None Attribute, Logic Token, Integer 10Yes 15No
I_BattlePlayerArmyPercentageOfAttribute None Attribute, Logic Token, Percentage 10Yes 15No
I_BattleEnemyArmyPercentageOfAttribute None Attribute, Logic Token, Percentage 10Yes 15No
I_IsBattleSettlementCastle None None 10Yes 15No
I_BattleSpeed None Logic Token, Value(float) 10Yes 15No
Trait character_record Trait Description, Logic Token, Level 10Yes 10Yes
FatherTrait character_record Trait Description, Logic Token, Level 10Yes 10Yes
FatherAttribute character_record Attribute Description, Logic Token, Level 15No 10Yes
FactionLeaderTrait character_record Trait Description, Logic Token, Level 10Yes 10Yes
FactionLeaderAttribute character_record Attribute Description, Logic Token, Level 10Yes 10Yes
ReligionShift character_record Logic Token, Level 15No 10Yes
PopulationConverted character_record Logic Token, Level 15No 10Yes
DistanceCapital character_record Logic Token, Level 15No 10Yes
Attribute character_record Attribute Description, Logic Token, Level 10Yes 10Yes
RemainingMPPercentage character_record Logic Token, Level 15No 10Yes
I_RemainingMPPercentage None Logic Token, Level 15No 10Yes
I_RemainingArmyMPPercentage None Logic Token, Level 15No 10Yes
I_CharacterCanMove None Logic Token, Level 15No 10Yes
NoActionThisTurn character_record None 15No 10Yes
CharacterNumTurnsIdle character_record Logic Token, Level 15No 10Yes
AgentType character_record Character Type 15No 10Yes
TrainedAgentType character_record Character Type 15No 10Yes
DisasterType event_type Event Type 15No 10Yes
CultureType character_record Culture Type 10Yes 10Yes
CharFactionType character_record Character Faction Type 10Yes 10Yes
OriginalFactionType character_record Original Faction Type 10Yes 10Yes
OriginalCultureType character_record Original Culture Type 10Yes 10Yes
IsGeneral character_record None 10Yes 10Yes
IsAdmiral character_record None 10Yes 10Yes
EndedInSettlement character_record None 10Yes 10Yes
IsFactionLeader character_record None 10Yes 10Yes
IsFactionHeir character_record None 10Yes 10Yes
IsMarried character_record None 10Yes 10Yes
AtSea character_record None 10Yes 10Yes
I_AtSea None Character 15No 10Yes
InEnemyLands character_record None 10Yes 10Yes
InBarbarianLands character_record None 10Yes 10Yes
InUncivilisedLands character_record None 10Yes 10Yes
IsBesieging character_record None 10Yes 10Yes
IsUnderSiege character_record None 10Yes 10Yes
I_WithdrawsBeforeBattle None None 10Yes 10Yes
EndedInEnemyZOC character_record None 10Yes 10Yes
AdviseAction character_action_advice Logic Token, Action 15No 10Yes
I_CharacterTypeNearCharacterType None Faction, Character Type, Distance in Squares, Faction, Character Type 15No 10Yes
I_CharacterTypeNearTile None Faction, Character Type, Distance in Squares, Position X, Position Y 15No 10Yes
TradingResource character_record None 15No 10Yes
OnResource character_record None 15No 10Yes
TradingMonopoly character_record None 15No 10Yes
TradingExotic character_record None 15No 10Yes
HighestAttAdjacentChar character_record Attribute Type, Character Type, Logic Token, Level 15No 10Yes
HighestAttSharedChar character_record Attribute Type, Character Type, Logic Token, Level 15No 10Yes
SpouseAttribute character_record Attribute Description, Logic Token, Level 15No 10Yes
SpouseTrait character_record Trait Description, Logic Token, Level 10Yes 10Yes
PopulationOwnReligion character_record Logic Token, Percentage 15No 10Yes
PopulationHeretic character_record Logic Token, Percentage 15No 10Yes
ProbabilitySuccess character_record Logic Token, Level 15No 10Yes
IsOnCrusade character_record None 15No 10Yes
IsOnJihad character_record None 15No 10Yes
IsTargetOnCrusade target_character_record None 15No 10Yes
IsTargetOnJihad target_character_record None 15No 10Yes
I_CrusadingGeneralSelected None None 15No 10Yes
I_JihadGeneralSelected None None 15No 10Yes
CharacterReligion character_record Religion 10Yes 10Yes
TimeInRegion character_record Logic Token, Turns 15No 10Yes
TimeSinceReligion character_record Logic Token, Religion Percentage, Logic Token, Turns 15No 10Yes
TimeSinceHeresy character_record Logic Token, Heresy Percentage, Logic Token, Turns 15No 10Yes
TimeWithArmy character_record Logic Token, Turns 15No 10Yes
FatherAnc character_record Ancillary Name 15No 10Yes
GeneralWithAncKilled character_record Ancillary Name 10Yes 10Yes
HasAncType character_record Ancillary Name 15No 10Yes
I_CharacterExists None Character Name 15No 10Yes
RansomType ransom_type Ransom Type 15No 10Yes
NumCapturedSoldiers captured_faction_info Logic Token, Level 15No 10Yes
NumCapturedCharacters captured_faction_info Logic Token, Level 15No 10Yes
RansomAmount captured_faction_info Logic Token, Level 15No 10Yes
I_FactionLeaderTrait None Faction Type, Trait Description, Logic Token, Level 10Yes 10Yes
I_FactionLeaderAttribute None Faction Type, Attribute Description, Logic Token, Level 10Yes 10Yes
FactionType faction Faction Type 10Yes 10Yes
TargetFactionType target_faction Faction Type 10Yes 10Yes
FactionReligion faction Faction Religion 10Yes 10Yes
TargetFactionReligion target_faction Faction Religion 10Yes 10Yes
FactionCultureType faction Culture Type 10Yes 10Yes
TargetFactionCultureType target_faction Culture Type 10Yes 10Yes
TrainedUnitCategory unit Unit Category 15No 10Yes
TrainedUnitClass unit Unit Class 15No 10Yes
UnitCategory unit Logic Token, Unit Category 15No 10Yes
MedianTaxLevel faction Logic Token, Tax Level 10Yes 10Yes
ModeTaxLevel faction Logic Token, Tax Level 10Yes 10Yes
I_ModeTaxLevel None Faction, Logic Token, Tax Level 10Yes 10Yes
MissionSuccessLevel mission_success_level Logic Token, Success Level 15No 10Yes
MissionSucceeded None None 15No 10Yes
MissionFactionTargetType faction Faction Type 10Yes 10Yes
MissionCultureTargetType faction, character_record Culture Type 10Yes 10Yes
DiplomaticStanceFromCharacter character_record Faction Type, Logic Token, Stance 10Yes 10Yes
DiplomaticStanceFromFaction faction Faction Type, Logic Token, Stance 10Yes 10Yes
DiplomaticStanceFactions faction, target_faction Logic Token, Stance 10Yes 10Yes
DiplomaticStanceWithNewPope faction, target_faction Logic Token, Stance 15No 10Yes
FactionEqualsTarget faction, target_faction None 10Yes 10Yes
FactionHasAllies faction None 10Yes 10Yes
FactionBuildingExists faction Logic Token, Level 15No 10Yes
FactionScore faction Score Type, Logic Token, Faction Type 15No 10Yes
FactionHasRank faction None 15No 10Yes
FactionScorePercent faction Score Type, Logic Token, Level 15No 10Yes
FactionScoreRank faction Score Type, Logic Token, Level 15No 10Yes
FactionIncome faction Logic Token, Level 15No 10Yes
I_LosingMoney None None 15No 10Yes
SupportCostsPercentage faction Logic Token, Percentage 15No 10Yes
Treasury faction Logic Token, Quantity 15No 10Yes
OnAWarFooting faction None 15No 10Yes
I_FactionBesieging None Faction Type 15No 10Yes
I_FactionBesieged None Faction Type 15No 10Yes
I_NumberOfSettlements None Faction Type, Logic Token, # of Settlements 15No 10Yes
I_NumberOfHeirs None Faction Type, Logic Token, # of Heirs 15No 10Yes
I_FactionNearTile None Faction, Distance in Squares, Position X, Position Y 15No 10Yes
SettlementsTaken faction Logic Token, Quantity 10Yes 10Yes
BattlesFought faction Logic Token, Quantity 10Yes 10Yes
BattlesWon faction Logic Token, Quantity 10Yes 10Yes
BattlesLost faction Logic Token, Quantity 10Yes 10Yes
DefensiveSiegesFought faction Logic Token, Quantity 10Yes 10Yes
DefensiveSiegesWon faction Logic Token, Quantity 10Yes 10Yes
OffensiveSiegesFought faction Logic Token, Quantity 10Yes 10Yes
OffensiveSiegesWon faction Logic Token, Quantity 10Yes 10Yes
IsFactionAIFrozen faction None 15No 10Yes
I_IsFactionAIFrozen None faction 15No 10Yes
MissionID mission_details Mission ID 15No 10Yes
PaybackID mission_details Payback ID 15No 10Yes
IsCrusadeTargetFaction target_faction None 15No 10Yes
IsJihadTargetFaction target_faction None 15No 10Yes
MissionTimeRemaining faction Logic Token, Turns Remaining 15No 10Yes
I_PlayerHasMission None Mission ID 15No 10Yes
I_PlayerHasMissionType None Source ID 15No 10Yes
I_PlayerHasPreferati None None 15No 10Yes
I_PlayerCanBuyVotes None None 15No 10Yes
FactionwideAncillaryExists character_record Ancillary Name, Logic Token 15No 10Yes
TransgressionName resource_description Transgression Name 15No 10Yes
ForgivenessName resource_description Forgiveness Name 15No 10Yes
FactionStanding faction, target_faction Logic Token, Quantity 10Yes 10Yes
GlobalStanding faction Logic Token, Quantity 10Yes 10Yes
FactionExcommunicated faction None 15No 10Yes
TargetFactionExcommunicated target_faction None 15No 10Yes
FactionUndiscovered faction None 15No 10Yes
I_IsFactionUndiscovered None Faction 15No 10Yes
FactionAILabel faction Faction Type, AI Label 15No 10Yes
I_FactionAILabel None Faction Type, AI Label 15No 10Yes
NumFactionMarriages faction, target_faction Logic Token, # of Marriages 10Yes 10Yes
I_UnitExists None Faction, Unit Type 15No 10Yes
RandomPercent None Logic Token, Percentage 10Yes 10Yes
TrueCondition None None 10Yes 10Yes
EventCounterType event_counter Event Name 15No 10Yes
EventCounter event_counter Logic Token, Integer 15No 10Yes
I_EventCounter None Event Name, Logic Token, Integer 15No 10Yes
IsPositionInRect sm_position Left Top [Width Height] 15No 10Yes
IsRegionOneOf region_id Region Label 15No 10Yes
IsTargetRegionOneOf target_region_id Region Label 15No 10Yes
IsCrusade crusade None 15No 10Yes
IsJihad crusade None 15No 10Yes
CrusadeOutcome crusade Crusade Outcome 15No 10Yes
I_CrusadeInProgress None None 15No 10Yes
I_JihadInProgress None None 15No 10Yes
I_CrusadeTimeLeft None Logic Token, Integer 15No 10Yes
I_JihadTimeLeft None Logic Token, Integer 15No 10Yes
I_TurnsSinceLastCrusade None Logic Token, Integer 15No 10Yes
I_TurnsSinceLastJihad None Logic Token, Integer 15No 10Yes
Religion List Religion 10Yes 10Yes
TargetReligion target_religion Religion 10Yes 10Yes
I_WorldwideAncillaryExists character_record Anicllary Name, Logic Token 15No 10Yes
CampaignDifficulty faction Logic Token, Difficulty 15No 10Yes
BattleDifficulty faction Logic Token, Difficulty 15No 10Yes
I_CampaignNumTimePlay None Logic Token, Integer 10Yes 10Yes
I_FirstTimePlay None Faction Type 10Yes 10Yes
I_AdvisorVerbosityLevel None Logic Token, Integer 10Yes 10Yes
I_HotseatEnabled None None 10Yes 10Yes
SettlementName settlement Settlement Name 10Yes 10Yes
TargetSettlementName target_settlement Settlement Name 10Yes 10Yes
GovernorBuildingExists character_record Logic Token, Building Description 15No 10Yes
SettlementBuildingExists settlement Logic Token, Building Description 15No 10Yes
BuildingFinishedByGovernor character_record, prior_build Logic Token, Building Description 15No 10Yes
SettlementBuildingFinished prior_build Logic Token, Building Description 15No 10Yes
NumBuildingsCompleted prior_build Building Description, Logic Token, Test Level 15No 10Yes
NumBuildingsCompletedFaction faction, prior_build Building Description, Logic Token, Test Level 15No 10Yes
GovernorPlugInExists character_record Logic Token, Plug-In 15No 10Yes
GovernorPlugInFinished character_record, prior_build Logic Token, Plug-In 15No 10Yes
GovernorTaxLevel character_record Logic Token, Tax Level 10Yes 10Yes
SettlementTaxLevel settlement Logic Token, Tax Level 10Yes 10Yes
GovernorInResidence settlement None 15No 10Yes
GovernorLoyaltyLevel character_record Logic Token, Value 10Yes 10Yes
GovernorAttribute settlement Attribute, Logic Token, Level 10Yes 10Yes
SettlementLoyaltyLevel settlement Logic Token, Level 10Yes 10Yes
RiotRisk settlement Logic Token, Percentage 10Yes 10Yes
BuildingQueueIdleDespiteCash settlement None 10Yes 10Yes
TrainingQueueIdleDespiteCash settlement None 10Yes 10Yes
I_SettlementExists None Settlement Name 15No 10Yes
I_SettlementOwner None Settlement Name, Logic Token, Faction Type 15No 10Yes
AdviseFinancialBuild best_finance_option Build Type 15No 10Yes
AdviseBuild advised_build Build Type 15No 10Yes
AdviseRecruit None Unit Type 15No 10Yes
BuildingName resource_description Building Level Name 15No 10Yes
SettlementPopulationMaxedOut settlement None 15No 10Yes
SettlementPopulationTooLow settlement None 15No 10Yes
SettlementAutoManaged settlement Automanagement Type 15No 10Yes
PercentageOfPopulationInGarrison settlement None 15No 10Yes
GarrisonToPopulationRatio settlement None 15No 10Yes
HealthPercentage settlement None 15No 10Yes
SettlementHasPlague settlement None 15No 10Yes
IsFortGarrisoned fort None 15No 10Yes
IsSettlementGarrisoned settlement None 15No 10Yes
IsSettlementRioting settlement None 15No 10Yes
I_NumberUnitsInSettlement None Settlement, Unit Type, Logic Token, Quantity 15No 10Yes
NeighbourReligion settlement Settlement Religion, Logic Token, Level 15No 10Yes
IsCrusadeTarget settlement None 15No 10Yes
IsJihadTarget settlement None 15No 10Yes
IsRegionCrusadeTarget region_id None 15No 10Yes
IsRegionJihadTarget region_id None 15No 10Yes
SettlementType settlement Castle/City 15No 10Yes
TargetSettlementType settlement Castle/City 15No 10Yes
I_SettlementUnderSiege None Settlement Name 15No 10Yes
I_UnitsToRetrain None Settlement Name, Logic Token, Number 15No 10Yes
CharacterIsLocal character_record None 10Yes 10Yes
TargetCharacterIsLocal target_character_record None 10Yes 10Yes
SettlementIsLocal settlement None 10Yes 10Yes
TargetSettlementIsLocal settlement None 10Yes 10Yes
RegionIsLocal region_id None 10Yes 10Yes
TargetRegionIsLocal region_id None 10Yes 10Yes
ArmyIsLocal army None 10Yes 10Yes
TargetArmyIsLocal army None 10Yes 10Yes
FactionIsLocal faction None 10Yes 10Yes
I_LocalFaction None Faction 10Yes 10Yes
TargetFactionIsLocal target_faction None 10Yes 10Yes
I_TurnNumber None Logic Token, Turn Number 10Yes 10Yes
I_MapName None Map File Name 10Yes 10Yes
I_ThreadCount None Advice Thread, Logic Token, Value 15No 10Yes
I_IsTriggerTrue None Trigger Name 15No 10Yes
IncomingMessageType event Message Identifier 15No 10Yes
I_AdvisorVerbosity None Logic Token, Advisor Verbosity 10Yes 10Yes
I_CharacterSelected None Character Name 15No 10Yes
I_AgentSelected None Character Type 15No 10Yes
I_SettlementSelected None Settlement Name 15No 10Yes
ShortcutTriggered resource_description Element ID, Function ID 10Yes 10Yes
I_AdvancedStatsScrollIsOpen None None 15No 10Yes
I_ScrollOpen None Scroll ID 15No 10Yes
I_MessageNeedsResolving None None 15No 10Yes
ButtonPressed resource_description Button ID 10Yes 10Yes
UIElementVisible resource_description UI Element ID 15No 10Yes
ScrollOpened resource_description Scroll ID 10Yes 10Yes
ScrollClosed resource_description Scroll ID 10Yes 10Yes
ScrollAdviceRequested resource_description Scroll ID 10Yes 10Yes
I_CompareCounter None Script Counter, Value 10Yes 10Yes
I_TimerElapsed None Logic Token, Timer ID, Duration 10Yes 10Yes
I_SoundPlaying None Sound Event Tag 10Yes 10Yes
I_AdvisorSpeechPlaying None None 10Yes 10Yes
I_AdvisorVisible None None 10Yes 10Yes
Identifier Trigger Requirements Parameters Battle Strat


The following conditions only work for modifications running off the "kingdoms.exe" from the Medieval II: Total War - Kingdoms Expansion.


Kingdoms DocuDemons - Conditions Table
Identifier Trigger Requirements Parameters Battle Strat
PercentageUnitAttribute character_record Unit Attribute 10Yes 10Yes
CharacterAge character_record Logic Token, Age 15No 10Yes
IsFactionAIControlled None None 15No 10Yes
I_IsFactionAIControlled None Faction 15No 10Yes
IsSettlementExported settlement None 15No 10Yes
IsFortExported fort None 15No 10Yes
Identifier Trigger Requirements Parameters Battle Strat


Template: |Identifier||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


Unit Attribute - To Be Amended


See Also

External Links

YOU can help us improve this Wiki! ~ Look for Ways to Help and Things to Do. ~ If you need further advice, please post here.