Module:Unit/doc

Module for requesting characteristics of all existing units in Olden Era. Actual data is stored in Data:units.json.

Supported Commands

get

The module supports the main get command, through which you can retrieve individual unit attributes (listed below). The basic syntax of the command is:

{{#invoke:Unit|get|Unit Name|Property Name}}

Name	Description	Example	Result
name	Unit name (localized)	{{#invoke:Unit|get|Angel|name}}	Angel
description	Narrative description (localized with data substitutions)	{{#invoke:Unit|get|Angel|description}}	The inquisition’s greatest belief is that angels still accompany their mission. The beings that aid the Templars in combat are but a mere imitation — a human soul willingly fused with winged armor, destined to continue the fight.
faction	Unit faction	{{#invoke:Unit|get|Angel|faction}}	Temple
tier	Unit tier	{{#invoke:Unit|get|Angel|tier}}	VII
nativeBiome	Native biome	{{#invoke:Unit|get|Angel|nativeBiome}}	Grass
cost	Hiring cost	{{#invoke:Unit|get|Angel|cost}}	2400 1
cost.gold cost.resource	Access to specific property in unitCost object	{{#invoke:Unit|get|Angel|cost.gold}} {{#invoke:Unit|get|Angel|cost.gemstones}}	2400 1
weeklyIncrement	Base weekly increment from main building	{{#invoke:Unit|get|Angel|weeklyIncrement}}	1
expBonus	Experience gained when defeating the unit	{{#invoke:Unit|get|Angel|expBonus}}	366
squadValue	Squad value of the unit (used for army composition calculations)	{{#invoke:Unit|get|Angel|squadValue}}	3660
hp	Maximum health	{{#invoke:Unit|get|Angel|hp}}	225
offence	Offence parameter	{{#invoke:Unit|get|Angel|offence}}	30
defence	Defence parameter	{{#invoke:Unit|get|Angel|defence}}	30
damageMin	Minimum damage dealt	{{#invoke:Unit|get|Angel|damageMin}}	50
damageMax	Maximum damage dealt	{{#invoke:Unit|get|Angel|damageMax}}	75
moral	Default morale	{{#invoke:Unit|get|Angel|moral}}	0
moralMin	Minimum morale value	{{#invoke:Unit|get|Angel|moralMin}}	-3
moralMax	Maximum morale value	{{#invoke:Unit|get|Angel|moralMax}}	3
luck	Default luck	{{#invoke:Unit|get|Angel|luck}}	0
luckMin	Minimum luck value	{{#invoke:Unit|get|Angel|luckMin}}	-3
luckMax	Maximum luck value	{{#invoke:Unit|get|Angel|luckMax}}	3
initiative	Initiative	{{#invoke:Unit|get|Angel|initiative}}	8
speed	Speed	{{#invoke:Unit|get|Angel|speed}}	4
moveType	Movement type (fly or teleport)	{{#invoke:Unit|get|Angel|moveType}}	fly
baseClass.name	Base class name (localized)	{{#invoke:Unit|get|Angel|baseClass.name|ru}}	Embodiment
baseClass.description	Base class description (localized)	{{#invoke:Unit|get|Angel|baseClass.description}}	A spirit, soul, or other intangible power that has coalesced into material form. Morale range: –3 to -3. Luck range: –3 to -3. Fallen Embodiments do NOT count towards the power of Necromancy reanimation after battle.
baseClass.icon	Base class icon filename	{{#invoke:Unit|get|Angel|baseClass.icon}} or [[File:{{#invoke:Unit|get|Angel|baseClass.icon}}|50px]]	Base class embodiment.png -
abilities.1.name	Ability name (localized)	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.name|en}}	Awaken: Fire II
abilities.1.description	Ability main description (localized with data substitutions)	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.description|en}}	Increase this creature’s Speed and Initiative by 1 and HP by 25 and grants it maximum Damage. Allows the use of other abilities. Once per battle; lasts until the end of battle.
abilities.1.infoDescription	Additional ability information (localized)	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.infoDescription|en}}	Does not end the turn.
abilities.1.excaptionInTooltip	Ability restrictions or exceptions (localized)	{{#invoke:Unit|get|Cultist|abilities.1.excaptionInTooltip|en}}	Не действует на магических существ, нежить и конструкты
abilities.1.abilityType	Type of ability (localized)	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.abilityType|ru}}	Особая способность
abilities.1.ability_tier	Ability tier	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.ability_tier|ru}}	6
abilities.1.energyLevel	Energy required for ability activation	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.energyLevel|ru}}	3
abilities.1.icon	Ability icon filename	{{#invoke:Unit|get|Flaming Phoenix|abilities.1.icon|ru}}	Phoenix_ability_2.png
passives.3.name	Passive ability name (localized)	{{#invoke:Unit|get|Giant Toad|passives.3.name}}	Tenderizing Spit
passives.3.description	Passive ability description (localized with data substitutions)	{{#invoke:Unit|get|Giant Toad|passives.3.description}}	Attacks poison the target. Poisoned creatures take [ 7 × amount of units ] Magic Damage at the start of their turn. This effect is stackable. Duration: 2 round(s).
passives.3.excaptionInTooltip	Passive ability restrictions or exceptions (localized)	{{#invoke:Unit|get|Giant Toad|passives.3.excaptionInTooltip|ru}}	Не действует на нежить, воплощения и конструкты
passives.3.icon	Passive ability icon filename	{{#invoke:Unit|get|Giant Toad|passives.3.icon}}	Giant_frog_passive_1.png
alternativeAttacks	List of alternative attacks (selected manually during the unit's turn)	{{#invoke:Unit|get|Angel|alternativeAttacks}}	table

Localization Support

The module supports localization in multiple languages. You can specify the language as an optional third parameter:

{{#invoke:Unit|get|Unit Name|Property Name|Language Code}}

For example:

• {{#invoke:Unit|get|Angel|name|pl}}

  Anioł - Polish

• {{#invoke:Unit|get|Angel|name|ru}}

  Ангел - Russian