Module:Unit/doc

From Heroes of Might and Magic: Olden Era Official Wiki

This is the documentation page for Module:Unit

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
Base name Name of un-upgraded unit (localized) 
{{#invoke:Unit|get|Apotheosis|baseName}}
 Angel
First Upgrade Name of upgraded unit (localized) 
{{#invoke:Unit|get|Angel|upgradeName}}
 Archangel
Second Upgrade Name of alt. upgraded unit (localized) 
{{#invoke:Unit|get|Angel|altUpgradeName}}
 Apotheosis
Image name Name without spaces and apostrophes, suitable for wiki file names 
{{#invoke:Unit|get|Sun's Aegis|imageName}}
 SunsAegis
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
id Unit ID 
{{#invoke:Unit|get|Angel|id}}
 angel
nativeBiome Native biome 
{{#invoke:Unit|get|Angel|nativeBiome}}
 Grass
cost Hiring cost 
{{#invoke:Unit|get|Angel|cost}}
 2400Gold 1Gemstones
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
upgradeCost Upgrade cost 
{{#invoke:Unit|get|Archangel|upgradeCost}}
 1600Gold 1Gemstones
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 -

Active Abilities

To access specific active ability properties, use the format: abilities.index.property

Name Description Example Result
abilities.1.name Ability name (localized) 
{{#invoke:Unit|get|Flaming Phoenix|abilities.1.name|ru}}
 Пробуждение. Огонь II
abilities.1.description Ability main description (localized with data substitutions) 
{{#invoke:Unit|get|Flaming Phoenix|abilities.1.description|ru}}
 Получает +1 к скорости и инициативе, +25 к здоровью и всегда наносит максимальный урон. Позволяет использовать остальные способности. Применяется один раз за бой и действует до конца боя.
abilities.1.infoDescription Additional ability information (localized) 
{{#invoke:Unit|get|Flaming Phoenix|abilities.1.infoDescription|ru}}
 Не завершает ход.
abilities.1.excaptionInTooltip Ability restrictions or exceptions (localized) 
{{#invoke:Unit|get|Cultist|abilities.1.excaptionInTooltip|ru}}
 Не действует на магических существ, нежить и конструкты
abilities.1.abilityType Type of ability (localized) 
{{#invoke:Unit|get|Flaming Phoenix|abilities.1.abilityType|ru}}
 Особая способность
abilities.1.ability_tier Ability rank or 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

Passive Abilities

To access specific passive ability properties, use the format: passives.index.property

Name Description Example Result
passives.1.name Passive ability name (localized) 
{{#invoke:Unit|get|Giant Toad|passives.1.name}}
 Melee Attack
passives.1.description Passive ability description (localized with data substitutions) 
{{#invoke:Unit|get|Giant Toad|passives.1.description}}
 Can only attack adjacent enemies. Provokes counterattacks.
passives.1.excaptionInTooltip Passive ability restrictions or exceptions (localized) 
{{#invoke:Unit|get|Giant Toad|passives.1.excaptionInTooltip}}
passives.1.icon Passive ability icon filename 
{{#invoke:Unit|get|Giant Toad|passives.1.icon}}
 Base passive melee attack.png

Alternative Attacks

To access specific alternative attack properties, use the format: alternativeAttacks.index.property

Name Description Example Result
alternativeAttacks.1.name Alternative attack name (localized) 
{{#invoke:Unit|get|Infiltrator|alternativeAttacks.1.name}}
 Fighting Style: Hit and Run
alternativeAttacks.1.description Alternative attack description (localized with data substitutions) 
{{#invoke:Unit|get|Infiltrator|alternativeAttacks.1.description}}
 This creature will return to its original position after attacking, but deal –50% Damage.
alternativeAttacks.1.abilityType Type of alternative attack (localized) 
{{#invoke:Unit|get|Infiltrator|alternativeAttacks.1.abilityType}}
 Alternative Attack
alternativeAttacks.1.infoDescription Additional alternative attack information (localized) 
{{#invoke:Unit|get|Infiltrator|alternativeAttacks.1.infoDescription}}
 Does not spend Focus Charges.
alternativeAttacks.1.icon Alternative attack icon filename 
{{#invoke:Unit|get|Infiltrator|alternativeAttacks.1.icon}}
 Assassin_ability_1.png
alternativeAttacks.1.ability_tier Alternative attack rank or tier 
{{#invoke:Unit|get|Infiltrator|alternativeAttacks.1.ability_tier}}
 1

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
Retrieved from "https://wiki.hoodedhorse.com/Heroes_of_Might_and_Magic_Olden_Era/index.php?title=Module:Unit/doc&oldid=11959"