Modifiers and Abilities

Most of the objects defined by the rule set can be customized via modifiers and abilities. Abilities are boolean values (``true'' or ``false''). If the value is not explicitly stated, it defaults to true. If an ability is not present, it defaults to false. Modifiers define a bonus or penalty to be applied to a numeric value, such as the number of goods produced by a unit. The modifier may be an additive, multiplicative or a percentage modifier. Modifiers default to ``identity'', which means they have no effect.

The code also checks that all abilities and modifiers it uses are defined by the specification. Therefore, you must define all of them, even if you do not use them. You can do this by setting their value to the default value, e.g. ``false'' in the case of an ability, or ``0'' in the case of an additive modifier.

model.ability.addTaxToBells
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player adds the current tax rate as a bonus to bells production. The bonus is modified every time the tax increases or decreases.

model.ability.alwaysOfferedPeace
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player is always offered peace in negotiations with AI players.

model.ability.ambushBonus
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is granted an ambush bonus equal to the terrain's defence value.

model.ability.ambushPenalty
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit suffers an ambush penalty equal to the terrain's defence value.

model.ability.autoProduction
Affects: Building
Provided by: Building Type

The building needs no units to produce goods, and will never produce more goods than can be stored in the colony.

model.ability.automaticEquipment
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit automatically picks up equipment if attacked.

model.ability.automaticPromotion
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

A unit that can be promoted will always be promoted when successful in battle.

model.ability.betterForeignAffairsReport
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player is provided with more information about foreign powers.

model.ability.bombard
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is able to bombard other units.

model.ability.bombardShips
Affects: Building
Provided by: Building Type

The building has the ability to bombard enemy ships on adjacent tiles.

model.ability.bornInColony
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can be born in a colony, provided that enough food is available.

model.ability.bornInIndianSettlement
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can be born in an Indian settlement, provided that enough food is available.

model.ability.build
Affects: Building
Provided by: Building Type

The building can build units or equipment.

model.ability.buildCustomHouse
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can build custom houses.

model.ability.buildFactory
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can build factories.

model.ability.canBeCaptured
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can be captured. Land units that can not be captured are destroyed, naval units that can not be captured are either sunk or damaged.

model.ability.canBeEquipped
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can be equipped.

model.ability.canNotRecruitUnit
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can not recruit specified units.

model.ability.captureEquipment
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can capture equipment from another unit.

model.ability.captureGoods
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can capture goods from another unit.

model.ability.captureUnits
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can capture enemy units.

model.ability.carryGoods
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can transport goods.

model.ability.carryTreasure
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can transport treasures, not treasure trains.

model.ability.carryUnits
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can transport other units.

model.ability.convert
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is a native convert.

model.ability.dressMissionary
Affects: Building
Provided by: Building Type

The building can commission missionaries.

model.ability.electFoundingFather
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can elect Founding Fathers.

model.ability.expertMissionary
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is an expert missionary, but not necessarily commissioned.

model.ability.expertPioneer
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is an expert pioneer, but not necessarily equipped with tools.

model.ability.expertScout
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is an expert scout, but not necessarily equipped with horses.

model.ability.expertSoldier
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is an expert soldier, but not necessarily equipped with muskets.

model.ability.expertsUseConnections
Affects: Player
Provided by: Nation, Nation Type, Founding Father

Experts working in factories can produce a small amount of goods even if the raw materials are not available in the colony.

model.ability.export
Affects: Building
Provided by: Building Type

The building can export goods to Europe directly.

model.ability.foundColony
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can found new colonies.

model.ability.foundInLostCity
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit may be generated as the result of exploring a Lost City Rumour.

model.ability.hasPort
Affects: Colony
Provided by: Map

The colony has access to at least one water tile. This ability can not be set by the specification, but it can be used as a required ability.

model.ability.ignoreEuropeanWars
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player will not be affected by the Monarch's declarations of war.

model.ability.improveTerrain
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is able to improve terrain.

model.ability.independenceDeclared
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player has declared independence.

model.ability.mercenaryUnit
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit may be offered as a mercenary unit.

model.ability.missionary
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is able to establish missions and incite unrest in native settlements.

model.ability.moveToEurope
Affects: Tile
Provided by: Tile Type

Units on the tile are able to move to Europe.

model.ability.multipleAttacks
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can attack more than once.

model.ability.native
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is a native unit.

model.ability.navalUnit
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is a naval unit.

model.ability.pillageUnprotectedColony
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is able to steal goods from and destroy buildings in an unprotected colony.

model.ability.piracy
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is a privateer.

model.ability.produceInWater
Affects: Building
Provided by: Building Type

The building enables units to produce on water tiles.

model.ability.refUnit
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can be part of the Royal Expeditionary Force.

model.ability.repairUnits
Affects: Building
Provided by: Building Type

The building can repair units.

model.ability.royalExpeditionaryForce
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player is a Royal Expeditionary Force.

model.ability.rumoursAlwaysPositive
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player will always get positive results from exploring Lost City Rumours.

model.ability.scoutForeignColony
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can scout out foreign colonies.

model.ability.scoutIndianSettlement
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit can scout out native settlements.

model.ability.selectRecruit
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can select a unit to recruit in Europe. This also applies to units generated as a result of finding a Fountain of Youth.

model.ability.teach
Affects: Building
Provided by: Building Type

The building enables experts to teach other units. However, the building may place limits on the experience level of teachers.

model.ability.tradeWithForeignColonies
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player may trade goods in foreign colonies.

model.ability.undead
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit is an undead unit (used only in revenge mode).

model.modifier.bombardBonus
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player's units are granted a bombard bonus when attacking.

model.modifier.buildingPriceBonus
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can build or buy buildings at a reduced price.

model.modifier.defence
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit has a defence bonus or penalty.

model.modifier.landPaymentModifier
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player can buy Indian land at a reduced price.

model.modifier.lineOfSightBonus
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit has an increased line of sight.

model.modifier.minimumColonySize
Affects: Colony
Provided by: Building Type, Nation, Nation Type, Founding Father

The population of the colony can not be voluntarily reduced below this number. The modifier does not in any way affect a population reduction due to starvation or other events.

model.modifier.movementBonus
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit has an increased movement range.

model.modifier.nativeAlarmModifier
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player generates less native alarm.

model.modifier.nativeConvertBonus
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player has a greater chance of converting natives.

model.modifier.nativeTreasureModifier
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player generates greater treasures when destroying native settlements.

model.modifier.offence
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit has an offence bonus or penalty.

model.modifier.religiousUnrestBonus
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player generates greater religious unrest in Europe.

model.modifier.sailHighSeas
Affects: Unit
Provided by: Nation, Nation Type, Founding Father, Unit Type, Equipment Type

The unit's travel time between Europe and the New World is reduced.

model.modifier.tradeBonus
Affects: Player
Provided by: Nation, Nation Type, Founding Father

Prices in the player's market remain stable for longer.

model.modifier.treasureTransportFee
Affects: Player
Provided by: Nation, Nation Type, Founding Father

The player pays a smaller fee for transporting treasures to Europe.

model.modifier.warehouseStorage
Affects: Building
Provided by: Building Type

The building increases the capacity of the warehouse.