Modding docs: Show uniques on all targets

This commit is contained in:
yairm210
2024-07-11 10:05:37 +03:00
parent 2b65d59e77
commit 51dbb3e6ed
2 changed files with 767 additions and 6 deletions

View File

@ -535,11 +535,26 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Global, Unit
??? example "Gain a free [buildingName] [cityFilter]"
Example: "Gain a free [Library] [in all cities]"
Applicable to: Triggerable, Global
??? example "[relativeAmount]% maintenance cost for buildings [cityFilter]"
Example: "[+20]% maintenance cost for buildings [in all cities]"
Applicable to: Global, FollowerBelief
??? example "Remove [buildingFilter] [cityFilter]"
Example: "Remove [Culture] [in all cities]"
Applicable to: Triggerable, Global
??? example "Sell [buildingFilter] buildings [cityFilter]"
Example: "Sell [Culture] buildings [in all cities]"
Applicable to: Triggerable, Global
??? example "[relativeAmount]% Culture cost of natural border growth [cityFilter]"
Example: "[+20]% Culture cost of natural border growth [in all cities]"
@ -1016,6 +1031,33 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Cannot be hurried"
Applicable to: Tech, Building
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Policy uniques
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## FounderBelief uniques
!!! note ""
@ -1036,16 +1078,262 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: FounderBelief, FollowerBelief
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## FollowerBelief uniques
!!! note ""
Uniques for Pantheon and Follower type beliefs, that will apply to each city where the religion is the majority religion
??? example "[stats] [cityFilter]"
Example: "[+1 Gold, +2 Production] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[stats] from every specialist [cityFilter]"
Example: "[+1 Gold, +2 Production] from every specialist [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[stats] per [amount] population [cityFilter]"
Example: "[+1 Gold, +2 Production] per [3] population [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[stats] in cities on [terrainFilter] tiles"
Example: "[+1 Gold, +2 Production] in cities on [Fresh Water] tiles"
Applicable to: Global, FollowerBelief
??? example "[stats] from all [buildingFilter] buildings"
Example: "[+1 Gold, +2 Production] from all [Culture] buildings"
Applicable to: Global, FollowerBelief
??? example "[stats] from [tileFilter] tiles [cityFilter]"
Example: "[+1 Gold, +2 Production] from [Farm] tiles [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[stats] from [tileFilter] tiles without [tileFilter] [cityFilter]"
Example: "[+1 Gold, +2 Production] from [Farm] tiles without [Farm] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[stats] from every [tileFilter/specialist/buildingFilter]"
Example: "[+1 Gold, +2 Production] from every [Farm]"
Applicable to: Global, FollowerBelief
??? example "[stats] from each Trade Route"
Example: "[+1 Gold, +2 Production] from each Trade Route"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% [stat]"
Example: "[+20]% [Culture]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% [stat] [cityFilter]"
Example: "[+20]% [Culture] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% [stat] from every [tileFilter/buildingFilter]"
Example: "[+20]% [Culture] from every [Farm]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Yield from every [tileFilter/buildingFilter]"
Example: "[+20]% Yield from every [Farm]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% [stat] from every follower, up to [relativeAmount]%"
Example: "[+20]% [Culture] from every follower, up to [+20]%"
Applicable to: FounderBelief, FollowerBelief
??? example "[relativeAmount]% Production when constructing [buildingFilter] buildings [cityFilter]"
Example: "[+20]% Production when constructing [Culture] buildings [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Production when constructing [baseUnitFilter] units [cityFilter]"
Example: "[+20]% Production when constructing [Melee] units [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Production when constructing [buildingFilter] wonders [cityFilter]"
Example: "[+20]% Production when constructing [Culture] wonders [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Production towards any buildings that already exist in the Capital"
Example: "[+20]% Production towards any buildings that already exist in the Capital"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% growth [cityFilter]"
Example: "[+20]% growth [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[amount]% Food is carried over after population increases [cityFilter]"
Example: "[3]% Food is carried over after population increases [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Food consumption by specialists [cityFilter]"
Example: "[+20]% Food consumption by specialists [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Unhappiness from [populationFilter] [cityFilter]"
Example: "[+20]% Unhappiness from [Followers of this Religion] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "May buy [baseUnitFilter] units for [amount] [stat] [cityFilter] at an increasing price ([amount])"
Example: "May buy [Melee] units for [3] [Culture] [in all cities] at an increasing price ([3])"
Applicable to: Global, FollowerBelief
??? example "May buy [buildingFilter] buildings for [amount] [stat] [cityFilter] at an increasing price ([amount])"
Example: "May buy [Culture] buildings for [3] [Culture] [in all cities] at an increasing price ([3])"
Applicable to: Global, FollowerBelief
??? example "May buy [baseUnitFilter] units for [amount] [stat] [cityFilter]"
Example: "May buy [Melee] units for [3] [Culture] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "May buy [buildingFilter] buildings for [amount] [stat] [cityFilter]"
Example: "May buy [Culture] buildings for [3] [Culture] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "May buy [baseUnitFilter] units with [stat] [cityFilter]"
Example: "May buy [Melee] units with [Culture] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "May buy [buildingFilter] buildings with [stat] [cityFilter]"
Example: "May buy [Culture] buildings with [Culture] [in all cities]"
Applicable to: Global, FollowerBelief
??? example "May buy [baseUnitFilter] units with [stat] for [amount] times their normal Production cost"
Example: "May buy [Melee] units with [Culture] for [3] times their normal Production cost"
Applicable to: Global, FollowerBelief
??? example "May buy [buildingFilter] buildings with [stat] for [amount] times their normal Production cost"
Example: "May buy [Culture] buildings with [Culture] for [3] times their normal Production cost"
Applicable to: Global, FollowerBelief
??? example "[stat] cost of purchasing items in cities [relativeAmount]%"
Example: "[Culture] cost of purchasing items in cities [+20]%"
Applicable to: Global, FollowerBelief
??? example "[stat] cost of purchasing [buildingFilter] buildings [relativeAmount]%"
Example: "[Culture] cost of purchasing [Culture] buildings [+20]%"
Applicable to: Global, FollowerBelief
??? example "[stat] cost of purchasing [baseUnitFilter] units [relativeAmount]%"
Example: "[Culture] cost of purchasing [Melee] units [+20]%"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% maintenance cost for buildings [cityFilter]"
Example: "[+20]% maintenance cost for buildings [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Culture cost of natural border growth [cityFilter]"
Example: "[+20]% Culture cost of natural border growth [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Gold cost of acquiring tiles [cityFilter]"
Example: "[+20]% Gold cost of acquiring tiles [in all cities]"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Great Person generation [cityFilter]"
Example: "[+20]% Great Person generation [in all cities]"
Applicable to: Global, FollowerBelief
??? example "New [baseUnitFilter] units start with [amount] Experience [cityFilter]"
Example: "New [Melee] units start with [3] Experience [in all cities]"
Applicable to: Global, FollowerBelief
??? example "All newly-trained [baseUnitFilter] units [cityFilter] receive the [promotion] promotion"
Example: "All newly-trained [Melee] units [in all cities] receive the [Shock I] promotion"
Applicable to: Global, FollowerBelief
??? example "[mapUnitFilter] Units adjacent to this city heal [amount] HP per turn when healing"
Example: "[Wounded] Units adjacent to this city heal [3] HP per turn when healing"
Applicable to: Global, FollowerBelief
??? example "[relativeAmount]% Strength for cities"
Example: "[+20]% Strength for cities"
Applicable to: Global, FollowerBelief
??? example "Provides [amount] [resource]"
Example: "Provides [3] [Iron]"
Applicable to: Global, FollowerBelief, Improvement
??? example "[relativeAmount]% Natural religion spread [cityFilter]"
Example: "[+20]% Natural religion spread [in all cities]"
Applicable to: Global, FollowerBelief
??? example "Religion naturally spreads to cities [amount] tiles away"
Example: "Religion naturally spreads to cities [3] tiles away"
Applicable to: Global, FollowerBelief
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Earn [amount]% of [mapUnitFilter] unit's [costOrStrength] as [civWideStat] when killed within 4 tiles of a city following this religion"
Example: "Earn [3]% of [Wounded] unit's [Cost] as [Gold] when killed within 4 tiles of a city following this religion"
Applicable to: FollowerBelief
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Building uniques
??? example "Consumes [amount] [resource]"
Example: "Consumes [3] [Iron]"
@ -1085,6 +1373,14 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Building, Unit
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Excess Food converted to Production when under construction"
Applicable to: Building, Unit
@ -1190,6 +1486,9 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Spaceship part"
Applicable to: Building, Unit
??? example "Cannot be hurried"
Applicable to: Tech, Building
??? example "Hidden when religion is disabled"
Applicable to: Building, Unit, Ruins, Tutorial
@ -1201,6 +1500,15 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Building, Unit
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## UnitAction uniques
!!! note ""
@ -1237,6 +1545,94 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Uniques that can be added to units, unit types, or promotions
??? example "[relativeAmount]% construction time for [improvementFilter] improvements"
Example: "[+20]% construction time for [All Road] improvements"
Applicable to: Global, Unit
??? example "Great General provides double combat bonus"
Applicable to: Global, Unit
??? example "Consumes [amount] [resource]"
Example: "Consumes [3] [Iron]"
Applicable to: Building, Unit, Improvement
??? example "Costs [amount] [stockpiledResource]"
Do not confuse with "costs [amount] [stockpiledResource]" (lowercase 'c'), the Unit Action Modifier.
Example: "Costs [3] [Mana]"
Applicable to: Building, Unit, Improvement
??? example "Unbuildable"
Blocks from being built, possibly by conditional. However it can still appear in the menu and be bought with other means such as Gold or Faith
Applicable to: Building, Unit, Improvement
??? example "Cannot be purchased"
Applicable to: Building, Unit
??? example "Can be purchased with [stat] [cityFilter]"
Example: "Can be purchased with [Culture] [in all cities]"
Applicable to: Building, Unit
??? example "Can be purchased for [amount] [stat] [cityFilter]"
Example: "Can be purchased for [3] [Culture] [in all cities]"
Applicable to: Building, Unit
??? example "Limited to [amount] per Civilization"
Example: "Limited to [3] per Civilization"
Applicable to: Building, Unit
??? example "Hidden until [amount] social policy branches have been completed"
Example: "Hidden until [3] social policy branches have been completed"
Applicable to: Building, Unit
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Excess Food converted to Production when under construction"
Applicable to: Building, Unit
??? example "Requires at least [amount] population"
Example: "Requires at least [3] population"
Applicable to: Building, Unit
??? example "Triggers a global alert upon build start"
Applicable to: Building, Unit
??? example "Triggers a global alert upon completion"
Applicable to: Building, Unit
??? example "Cost increases by [amount] per owned city"
Example: "Cost increases by [3] per owned city"
Applicable to: Building, Unit
??? example "Cost increases by [amount] when built"
Example: "Cost increases by [3] when built"
Applicable to: Building, Unit
??? example "[amount]% production cost"
Intended to be used with conditionals to dynamically alter construction costs
Example: "[3]% production cost"
Applicable to: Building, Unit
??? example "Can only be built"
Meant to be used together with conditionals, like "Can only be built <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also NOT block Upgrade and Transform actions. See also OnlyAvailable.
Applicable to: Building, Unit
??? example "May create improvements on water resources"
Applicable to: Unit
@ -1284,6 +1680,21 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Automation is a primary action"
Applicable to: Unit
??? example "[relativeAmount]% Strength"
Example: "[+20]% Strength"
Applicable to: Global, Unit
??? example "[relativeAmount]% Strength decreasing with distance from the capital"
Example: "[+20]% Strength decreasing with distance from the capital"
Applicable to: Global, Unit
??? example "[relativeAmount]% to Flank Attack bonuses"
Example: "[+20]% to Flank Attack bonuses"
Applicable to: Global, Unit
??? example "[relativeAmount]% Strength for enemy [combatantFilter] units in adjacent [tileFilter] tiles"
Example: "[+20]% Strength for enemy [City] units in adjacent [Farm] tiles"
@ -1299,6 +1710,46 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Unit
??? example "[amount] additional attacks per turn"
Example: "[3] additional attacks per turn"
Applicable to: Global, Unit
??? example "[amount] Movement"
Example: "[3] Movement"
Applicable to: Global, Unit
??? example "[amount] Sight"
Example: "[3] Sight"
Applicable to: Global, Unit, Terrain
??? example "[amount] Range"
Example: "[3] Range"
Applicable to: Global, Unit
??? example "[relativeAmount] Air Interception Range"
Example: "[+20] Air Interception Range"
Applicable to: Global, Unit
??? example "[amount] HP when healing"
Example: "[3] HP when healing"
Applicable to: Global, Unit
??? example "[relativeAmount]% Spread Religion Strength"
Example: "[+20]% Spread Religion Strength"
Applicable to: Global, Unit
??? example "When spreading religion to a city, gain [amount] times the amount of followers of other religions as [stat]"
Example: "When spreading religion to a city, gain [3] times the amount of followers of other religions as [Culture]"
Applicable to: Global, Unit
??? example "Can only attack [combatantFilter] units"
Example: "Can only attack [City] units"
@ -1340,6 +1791,15 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Unit
??? example "No defensive terrain bonus"
Applicable to: Global, Unit
??? example "No defensive terrain penalty"
Applicable to: Global, Unit
??? example "No damage penalty for wounded units"
Applicable to: Global, Unit
??? example "Uncapturable"
Applicable to: Unit
@ -1352,6 +1812,9 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Unable to pillage tiles"
Applicable to: Unit
??? example "No movement cost to pillage"
Applicable to: Global, Unit
??? example "Can move after attacking"
Applicable to: Unit
@ -1363,6 +1826,20 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Can move immediately once bought"
Applicable to: Unit
??? example "May heal outside of friendly territory"
Applicable to: Global, Unit
??? example "All healing effects doubled"
Applicable to: Global, Unit
??? example "Heals [amount] damage if it kills a unit"
Example: "Heals [3] damage if it kills a unit"
Applicable to: Global, Unit
??? example "Can only heal by pillaging"
Applicable to: Global, Unit
??? example "Unit will heal every turn, even if it performs an action"
Applicable to: Unit
@ -1371,6 +1848,9 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Unit
??? example "Defense bonus when embarked"
Applicable to: Global, Unit
??? example "No Sight"
Applicable to: Unit
@ -1425,14 +1905,54 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Unit
??? example "[relativeAmount]% maintenance costs"
Example: "[+20]% maintenance costs"
Applicable to: Global, Unit
??? example "[relativeAmount]% Gold cost of upgrading"
Example: "[+20]% Gold cost of upgrading"
Applicable to: Global, Unit
??? example "Earn [amount]% of the damage done to [combatantFilter] units as [civWideStat]"
Example: "Earn [3]% of the damage done to [City] units as [Gold]"
Applicable to: Global, Unit
??? example "Upon capturing a city, receive [amount] times its [stat] production as [civWideStat] immediately"
Example: "Upon capturing a city, receive [3] times its [Culture] production as [Gold] immediately"
Applicable to: Global, Unit
??? example "Earn [amount]% of killed [mapUnitFilter] unit's [costOrStrength] as [civWideStat]"
Example: "Earn [3]% of killed [Wounded] unit's [Cost] as [Gold]"
Applicable to: Global, Unit
??? example "May capture killed [mapUnitFilter] units"
Example: "May capture killed [Wounded] units"
Applicable to: Unit
??? example "[amount] XP gained from combat"
Example: "[3] XP gained from combat"
Applicable to: Global, Unit
??? example "[relativeAmount]% XP gained from combat"
Example: "[+20]% XP gained from combat"
Applicable to: Global, Unit
??? example "Can be earned through combat"
Applicable to: Unit
??? example "[greatPerson] is earned [relativeAmount]% faster"
Example: "[Great General] is earned [+20]% faster"
Applicable to: Global, Unit
??? example "Invisible to others"
Applicable to: Unit
@ -1508,12 +2028,27 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Due to performance considerations, this unique is cached, thus conditionals that may change within a turn may not work.
Applicable to: Unit
??? example "[amount] Movement point cost to disembark"
Example: "[3] Movement point cost to disembark"
Due to performance considerations, this unique is cached, thus conditionals that may change within a turn may not work.
Applicable to: Global, Unit
??? example "[amount] Movement point cost to embark"
Example: "[3] Movement point cost to embark"
Due to performance considerations, this unique is cached, thus conditionals that may change within a turn may not work.
Applicable to: Global, Unit
??? example "Never appears as a Barbarian unit"
Applicable to: Unit
??? example "Religious Unit"
Applicable to: Unit
??? example "Spaceship part"
Applicable to: Building, Unit
??? example "Takes your religion over the one in their birth city"
Applicable to: Unit
@ -1528,14 +2063,68 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Unit
??? example "Hidden when religion is disabled"
Applicable to: Building, Unit, Ruins, Tutorial
??? example "Hidden when [victoryType] Victory is disabled"
Example: "Hidden when [Domination] Victory is disabled"
Applicable to: Building, Unit
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## UnitType uniques
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Promotion uniques
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Doing so will consume this opportunity to choose a Promotion"
Applicable to: Promotion
??? example "This Promotion is free"
Applicable to: Promotion
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Terrain uniques
??? example "[stats]"
Example: "[+1 Gold, +2 Production]"
Applicable to: Global, Terrain, Improvement
??? example "[amount] Sight"
Example: "[3] Sight"
Applicable to: Global, Unit, Terrain
??? example "Must be adjacent to [amount] [simpleTerrain] tiles"
Example: "Must be adjacent to [3] [Elevated] tiles"
@ -1701,7 +2290,77 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Rough terrain"
Applicable to: Terrain
??? example "Excluded from map editor"
Applicable to: Nation, Terrain, Improvement, Resource
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Suppress warning [validationWarning]"
Allows suppressing specific validation warnings. Errors, deprecation warnings, or warnings about untyped and non-filtering uniques should be heeded, not suppressed, and are therefore not accepted. Note that this can be used in ModOptions, in the uniques a warning is about, or as modifier on the unique triggering a warning - but you still need to be specific. Even in the modifier case you will need to specify a sufficiently selective portion of the warning text as parameter.
Example: "Suppress warning [Tinman is supposed to automatically upgrade at tech Clockwork, and therefore Servos for its upgrade Mecha may not yet be researched! -or- *is supposed to automatically upgrade*]"
Applicable to: Triggerable, Terrain, Speed, ModOptions, MetaModifier
## Improvement uniques
??? example "[stats]"
Example: "[+1 Gold, +2 Production]"
Applicable to: Global, Terrain, Improvement
??? example "Consumes [amount] [resource]"
Example: "Consumes [3] [Iron]"
Applicable to: Building, Unit, Improvement
??? example "Provides [amount] [resource]"
Example: "Provides [3] [Iron]"
Applicable to: Global, FollowerBelief, Improvement
??? example "Costs [amount] [stockpiledResource]"
Do not confuse with "costs [amount] [stockpiledResource]" (lowercase 'c'), the Unit Action Modifier.
Example: "Costs [3] [Mana]"
Applicable to: Building, Unit, Improvement
??? example "Unbuildable"
Blocks from being built, possibly by conditional. However it can still appear in the menu and be bought with other means such as Gold or Faith
Applicable to: Building, Unit, Improvement
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Must be next to [tileFilter]"
Example: "Must be next to [Farm]"
Applicable to: Building, Improvement
??? example "Obsolete with [tech]"
Example: "Obsolete with [Agriculture]"
Applicable to: Building, Improvement, Resource
??? example "Vegetation"
Applicable to: Terrain, Improvement
??? example "Tile provides yield without assigned population"
Applicable to: Terrain, Improvement
??? example "Excluded from map editor"
Applicable to: Nation, Terrain, Improvement, Resource
??? example "Can also be built on tiles adjacent to fresh water"
Applicable to: Improvement
@ -1801,7 +2460,32 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Improvement
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Resource uniques
??? example "Obsolete with [tech]"
Example: "Obsolete with [Agriculture]"
Applicable to: Building, Improvement, Resource
??? example "Doesn't generate naturally"
Applicable to: Terrain, Resource
??? example "Occurs at temperature between [fraction] and [fraction] and humidity between [fraction] and [fraction]"
Example: "Occurs at temperature between [0.5] and [0.5] and humidity between [0.5] and [0.5]"
Applicable to: Terrain, Resource
??? example "Excluded from map editor"
Applicable to: Nation, Terrain, Improvement, Resource
??? example "Deposits in [tileFilter] tiles always provide [amount] resources"
Example: "Deposits in [Farm] tiles always provide [3] resources"
@ -1851,7 +2535,24 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Guaranteed with Strategic Balance resource option"
Applicable to: Resource
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Ruins uniques
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Free [unit] found in the ruins"
Example: "Free [Musketman] found in the ruins"
@ -1862,6 +2563,38 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: Ruins
??? example "Hidden when religion is disabled"
Applicable to: Building, Unit, Ruins, Tutorial
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
## Speed uniques
??? example "Will not be displayed in Civilopedia"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Comment [comment]"
Allows displaying arbitrary text in a Unique listing. Only the text within the '[]' brackets will be displayed, the rest serves to allow Ruleset validation to recognize the intent.
Example: "Comment [comment]"
Applicable to: Nation, Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, UnitType, Promotion, Terrain, Improvement, Resource, Ruins, Speed
??? example "Suppress warning [validationWarning]"
Allows suppressing specific validation warnings. Errors, deprecation warnings, or warnings about untyped and non-filtering uniques should be heeded, not suppressed, and are therefore not accepted. Note that this can be used in ModOptions, in the uniques a warning is about, or as modifier on the unique triggering a warning - but you still need to be specific. Even in the modifier case you will need to specify a sufficiently selective portion of the warning text as parameter.
Example: "Suppress warning [Tinman is supposed to automatically upgrade at tech Clockwork, and therefore Servos for its upgrade Mecha may not yet be researched! -or- *is supposed to automatically upgrade*]"
Applicable to: Triggerable, Terrain, Speed, ModOptions, MetaModifier
## Tutorial uniques
??? example "Hidden when religion is disabled"
Applicable to: Building, Unit, Ruins, Tutorial
## CityState uniques
??? example "Provides military units every ≈[amount] turns"
Example: "Provides military units every ≈[3] turns"
@ -1895,6 +2628,12 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
??? example "Allow raze holy city"
Applicable to: ModOptions
??? example "Suppress warning [validationWarning]"
Allows suppressing specific validation warnings. Errors, deprecation warnings, or warnings about untyped and non-filtering uniques should be heeded, not suppressed, and are therefore not accepted. Note that this can be used in ModOptions, in the uniques a warning is about, or as modifier on the unique triggering a warning - but you still need to be specific. Even in the modifier case you will need to specify a sufficiently selective portion of the warning text as parameter.
Example: "Suppress warning [Tinman is supposed to automatically upgrade at tech Clockwork, and therefore Servos for its upgrade Mecha may not yet be researched! -or- *is supposed to automatically upgrade*]"
Applicable to: Triggerable, Terrain, Speed, ModOptions, MetaModifier
??? example "Mod is incompatible with [modFilter]"
Specifies that your Mod is incompatible with another. Always treated symmetrically, and cannot be overridden by the Mod you are declaring as incompatible.
Example: "Mod is incompatible with [DeCiv Redux]"
@ -1923,6 +2662,14 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Applicable to: ModOptions
## Event uniques
??? example "Only available"
Meant to be used together with conditionals, like "Only available <after adopting [policy]> <while the empire is happy>". Only allows Building when ALL conditionals are met. Will also block Upgrade and Transform actions. See also CanOnlyBeBuiltWhen
Applicable to: Tech, Policy, FounderBelief, FollowerBelief, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Unavailable"
Meant to be used together with conditionals, like "Unavailable <after generating a Great Prophet>".
Applicable to: Tech, Policy, Building, Unit, Promotion, Improvement, Ruins, Event
??? example "Mark tutorial [comment] complete"
Example: "Mark tutorial [comment] complete"
@ -2401,6 +3148,14 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Special conditionals that can be added to UnitTriggerable uniques, to make them activate upon specific actions.
??? example "&lt;upon conquering a city&gt;"
Applicable to: TriggerCondition, UnitTriggerCondition
??? example "&lt;upon building a [improvementFilter] improvement&gt;"
Example: "&lt;upon building a [All Road] improvement&gt;"
Applicable to: TriggerCondition, UnitTriggerCondition
??? example "&lt;upon defeating a [mapUnitFilter] unit&gt;"
Example: "&lt;upon defeating a [Wounded] unit&gt;"
@ -2506,6 +3261,12 @@ Simple unique parameters are explained by mouseover. Complex parameters are expl
Can only be applied to certain uniques, see details of each unique for specifics
Applicable to: MetaModifier
??? example "&lt;Suppress warning [validationWarning]&gt;"
Allows suppressing specific validation warnings. Errors, deprecation warnings, or warnings about untyped and non-filtering uniques should be heeded, not suppressed, and are therefore not accepted. Note that this can be used in ModOptions, in the uniques a warning is about, or as modifier on the unique triggering a warning - but you still need to be specific. Even in the modifier case you will need to specify a sufficiently selective portion of the warning text as parameter.
Example: "&lt;Suppress warning [Tinman is supposed to automatically upgrade at tech Clockwork, and therefore Servos for its upgrade Mecha may not yet be researched! -or- *is supposed to automatically upgrade*]&gt;"
Applicable to: Triggerable, Terrain, Speed, ModOptions, MetaModifier
*[amount]: This indicates a whole number, possibly with a + or - sign, such as `2`, `+13`, or `-3`.
*[baseTerrain]: The name of any terrain that is a base terrain according to the json file.