Module:Unit/doc: Difference between revisions

From Heroes of Might and Magic: Olden Era Official Wiki
Browse history interactively
Newer edit →
Created page with "Module for requesting characteristics of all existing units in Olden Era. Actual data is stored in Module: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: <pre> {{#invoke:Unit|get|Unit Name|Property Name}} </pre> {|class="wikitable" ! Name ! Description ! Example ! Result |- | name | Unit name (localized) | <..."
 
No edit summary
Line 19: Line 19:
| name
| name
| Unit name (localized)
| Unit name (localized)
| <pre>{{#invoke:Unit|get|Ash Dragon|name}}</pre>
| <pre>{{#invoke:Unit|get|Angel|name}}</pre>
| {{#invoke:Unit|get|Ash Dragon|name}}
| {{#invoke:Unit|get|Angel|name}}
|-
|-
| description
| description
| Narrative description (localized with data substitutions)
| Narrative description (localized with data substitutions)
| <pre>{{#invoke:Unit|get|Ash Dragon|description}}</pre>
| <pre>{{#invoke:Unit|get|Angel|description}}</pre>
| {{#invoke:Unit|get|Ash Dragon|description}}
| {{#invoke:Unit|get|Angel|description}}
|-
|-
| faction
| faction
| Unit faction
| Unit faction
| <pre>{{#invoke:Unit|get|Ash Dragon|faction}}</pre>
| <pre>{{#invoke:Unit|get|Angel|faction}}</pre>
| {{#invoke:Unit|get|Ash Dragon|faction}}
| {{#invoke:Unit|get|Angel|faction}}
|-
|-
| tier
| tier
| Unit tier
| Unit tier
| <pre>{{#invoke:Unit|get|Ash Dragon|tier}}</pre>
| <pre>{{#invoke:Unit|get|Angel|tier}}</pre>
| {{#invoke:Unit|get|Ash Dragon|tier}}
| {{#invoke:Unit|get|Angel|tier}}
|-
|-
| nativeBiome
| nativeBiome
| Native biome
| Native biome
| <pre>{{#invoke:Unit|get|Ash Dragon|nativeBiome}}</pre>
| <pre>{{#invoke:Unit|get|Angel|nativeBiome}}</pre>
| {{#invoke:Unit|get|Ash Dragon|nativeBiome}}
| {{#invoke:Unit|get|Angel|nativeBiome}}
|-
|-
| cost
| cost
| Hiring cost
| Hiring cost
| <pre>{{#invoke:Unit|get|Ash Dragon|cost}}</pre>
| <pre>{{#invoke:Unit|get|Angel|cost}}</pre>
| {{#invoke:Unit|get|Ash Dragon|cost}}
| {{#invoke:Unit|get|Angel|cost}}
|-
|-
| increment
| increment
| Base weekly increment from main building
| Base weekly increment from main building
| <pre>{{#invoke:Unit|get|Ash Dragon|increment}}</pre>
| <pre>{{#invoke:Unit|get|Angel|increment}}</pre>
| {{#invoke:Unit|get|Ash Dragon|increment}}
| {{#invoke:Unit|get|Angel|increment}}
|-
|-
| experience
| experience
| Experience gained when defeating the unit
| Experience gained when defeating the unit
| <pre>{{#invoke:Unit|get|Ash Dragon|experience}}</pre>
| <pre>{{#invoke:Unit|get|Angel|experience}}</pre>
| {{#invoke:Unit|get|Ash Dragon|experience}}
| {{#invoke:Unit|get|Angel|experience}}
|-
|-
| hp
| hp
| Maximum health
| Maximum health
| <pre>{{#invoke:Unit|get|Ash Dragon|hp}}</pre>
| <pre>{{#invoke:Unit|get|Angel|hp}}</pre>
| {{#invoke:Unit|get|Ash Dragon|hp}}
| {{#invoke:Unit|get|Angel|hp}}
|-
|-
| offence
| offence
| Offence parameter
| Offence parameter
| <pre>{{#invoke:Unit|get|Ash Dragon|offence}}</pre>
| <pre>{{#invoke:Unit|get|Angel|offence}}</pre>
| {{#invoke:Unit|get|Ash Dragon|offence}}
| {{#invoke:Unit|get|Angel|offence}}
|-
|-
| defence
| defence
| Defence parameter
| Defence parameter
| <pre>{{#invoke:Unit|get|Ash Dragon|defence}}</pre>
| <pre>{{#invoke:Unit|get|Angel|defence}}</pre>
| {{#invoke:Unit|get|Ash Dragon|defence}}
| {{#invoke:Unit|get|Angel|defence}}
|-
|-
| damageMin
| damageMin
| Minimum damage dealt
| Minimum damage dealt
| <pre>{{#invoke:Unit|get|Ash Dragon|damageMin}}</pre>
| <pre>{{#invoke:Unit|get|Angel|damageMin}}</pre>
| {{#invoke:Unit|get|Ash Dragon|damageMin}}
| {{#invoke:Unit|get|Angel|damageMin}}
|-
|-
| damageMax
| damageMax
| Maximum damage dealt
| Maximum damage dealt
| <pre>{{#invoke:Unit|get|Ash Dragon|damageMax}}</pre>
| <pre>{{#invoke:Unit|get|Angel|damageMax}}</pre>
| {{#invoke:Unit|get|Ash Dragon|damageMax}}
| {{#invoke:Unit|get|Angel|damageMax}}
|-
|-
| morale
| morale
| Default morale
| Default morale
| <pre>{{#invoke:Unit|get|Ash Dragon|morale}}</pre>
| <pre>{{#invoke:Unit|get|Angel|morale}}</pre>
| {{#invoke:Unit|get|Ash Dragon|morale}}
| {{#invoke:Unit|get|Angel|morale}}
|-
|-
| luck
| luck
| Default luck
| Default luck
| <pre>{{#invoke:Unit|get|Ash Dragon|luck}}</pre>
| <pre>{{#invoke:Unit|get|Angel|luck}}</pre>
| {{#invoke:Unit|get|Ash Dragon|luck}}
| {{#invoke:Unit|get|Angel|luck}}
|-
|-
| initiative
| initiative
| Initiative
| Initiative
| <pre>{{#invoke:Unit|get|Ash Dragon|initiative}}</pre>
| <pre>{{#invoke:Unit|get|Angel|initiative}}</pre>
| {{#invoke:Unit|get|Ash Dragon|initiative}}
| {{#invoke:Unit|get|Angel|initiative}}
|-
|-
| speed
| speed
| Speed (movement per turn in hexes during combat)
| Speed (movement per turn in hexes during combat)
| <pre>{{#invoke:Unit|get|Ash Dragon|speed}}</pre>
| <pre>{{#invoke:Unit|get|Angel|speed}}</pre>
| {{#invoke:Unit|get|Ash Dragon|speed}}
| {{#invoke:Unit|get|Angel|speed}}
|-
|-
| baseClass
| baseClass
| Base class (describes basic passive abilities of the creature)
| Base class (describes basic passive abilities of the creature)
| <pre>{{#invoke:Unit|get|Ash Dragon|baseClass}}</pre>
| <pre>{{#invoke:Unit|get|Angel|baseClass}}</pre>
| {{#invoke:Unit|get|Ash Dragon|baseClass}}
| {{#invoke:Unit|get|Angel|baseClass}}
|-
|-
| activeAbilities
| activeAbilities
| List of active abilities (activated manually during the unit's turn)
| List of active abilities (activated manually during the unit's turn)
| <pre>{{#invoke:Unit|get|Ash Dragon|activeAbilities}}</pre>
| <pre>{{#invoke:Unit|get|Angel|activeAbilities}}</pre>
| {{#invoke:Unit|get|Ash Dragon|activeAbilities}}
| {{#invoke:Unit|get|Angel|activeAbilities}}
|-
|-
| passiveAbilities
| passiveAbilities
| List of passive abilities (act continuously)
| List of passive abilities (act continuously)
| <pre>{{#invoke:Unit|get|Ash Dragon|passiveAbilities}}</pre>
| <pre>{{#invoke:Unit|get|Angel|passiveAbilities}}</pre>
| {{#invoke:Unit|get|Ash Dragon|passiveAbilities}}
| {{#invoke:Unit|get|Angel|passiveAbilities}}
|-
|-
| alternativeAttacks
| alternativeAttacks
| List of alternative attacks (selected manually during the unit's turn)
| List of alternative attacks (selected manually during the unit's turn)
| <pre>{{#invoke:Unit|get|Ash Dragon|alternativeAttacks}}</pre>
| <pre>{{#invoke:Unit|get|Angel|alternativeAttacks}}</pre>
| {{#invoke:Unit|get|Ash Dragon|alternativeAttacks}}
| {{#invoke:Unit|get|Angel|alternativeAttacks}}
|-
|-
| hireBuildingsInCity
| hireBuildingsInCity
| Buildings where the unit can be hired in the city
| Buildings where the unit can be hired in the city
| <pre>{{#invoke:Unit|get|Ash Dragon|hireBuildingsInCity}}</pre>
| <pre>{{#invoke:Unit|get|Angel|hireBuildingsInCity}}</pre>
| {{#invoke:Unit|get|Ash Dragon|hireBuildingsInCity}}
| {{#invoke:Unit|get|Angel|hireBuildingsInCity}}
|-
|-
| hireBuildingsOnMap
| hireBuildingsOnMap
| Buildings where the unit can be hired on the map
| Buildings where the unit can be hired on the map
| <pre>{{#invoke:Unit|get|Ash Dragon|hireBuildingsOnMap}}</pre>
| <pre>{{#invoke:Unit|get|Angel|hireBuildingsOnMap}}</pre>
| {{#invoke:Unit|get|Ash Dragon|hireBuildingsOnMap}}
| {{#invoke:Unit|get|Angel|hireBuildingsOnMap}}
|-
|-
| stats.property
| stats.property
| Access to specific property in stats object
| Access to specific property in stats object
| <pre>{{#invoke:Unit|get|Ash Dragon|stats.hp}}</pre>
| <pre>{{#invoke:Unit|get|Angel|stats.hp}}</pre>
| {{#invoke:Unit|get|Ash Dragon|stats.hp}}
| {{#invoke:Unit|get|Angel|stats.hp}}
|-
|-
| baseClass.property
| baseClass.property
| Access to specific property in baseClass object
| Access to specific property in baseClass object
| <pre>{{#invoke:Unit|get|Ash Dragon|baseClass.name}}</pre>
| <pre>{{#invoke:Unit|get|Angel|baseClass.name}}</pre>
| {{#invoke:Unit|get|Ash Dragon|baseClass.name}}
| {{#invoke:Unit|get|Angel|baseClass.name}}
|-
|-
| cost.property
| cost.property
| Access to specific property in unitCost object
| Access to specific property in unitCost object
| <pre>{{#invoke:Unit|get|Ash Dragon|cost.gold}}</pre>
| <pre>{{#invoke:Unit|get|Angel|cost.gold}}</pre>
| {{#invoke:Unit|get|Ash Dragon|cost.gold}}
| {{#invoke:Unit|get|Angel|cost.gold}}
|-
|-
| arrayName.index.property
| arrayName.index.property
| Access to specific property in array elements (e.g., activeAbilities.1.name)
| Access to specific property in array elements (e.g., activeAbilities.1.name)
| <pre>{{#invoke:Unit|get|Ash Dragon|activeAbilities.1.name}}</pre>
| <pre>{{#invoke:Unit|get|Angel|activeAbilities.1.name}}</pre>
| {{#invoke:Unit|get|Ash Dragon|activeAbilities.1.name}}
| {{#invoke:Unit|get|Angel|activeAbilities.1.name}}
|}
|}


Line 162: Line 162:


For example:
For example:
* <pre>{{#invoke:Unit|get|Ash Dragon|name|en}}</pre> - English
* <pre>{{#invoke:Unit|get|Angel|name|en}}</pre> - English
* <pre>{{#invoke:Unit|get|Ash Dragon|name|ru}}</pre> - Russian
* <pre>{{#invoke:Unit|get|Angel|name|ru}}</pre> - Russian

Revision as of 12:45, 5 January 2026

Module for requesting characteristics of all existing units in Olden Era. Actual data is stored in Module: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}}
 2400Gold 1Gemstones
increment Base weekly increment from main building 
{{#invoke:Unit|get|Angel|increment}}
experience Experience gained when defeating the unit 
{{#invoke:Unit|get|Angel|experience}}
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
morale Default morale 
{{#invoke:Unit|get|Angel|morale}}
luck Default luck 
{{#invoke:Unit|get|Angel|luck}}
 0
initiative Initiative 
{{#invoke:Unit|get|Angel|initiative}}
 8
speed Speed (movement per turn in hexes during combat) 
{{#invoke:Unit|get|Angel|speed}}
 4
baseClass Base class (describes basic passive abilities of the creature) 
{{#invoke:Unit|get|Angel|baseClass}}
 table
activeAbilities List of active abilities (activated manually during the unit's turn) 
{{#invoke:Unit|get|Angel|activeAbilities}}
passiveAbilities List of passive abilities (act continuously) 
{{#invoke:Unit|get|Angel|passiveAbilities}}
alternativeAttacks List of alternative attacks (selected manually during the unit's turn) 
{{#invoke:Unit|get|Angel|alternativeAttacks}}
 table
hireBuildingsInCity Buildings where the unit can be hired in the city 
{{#invoke:Unit|get|Angel|hireBuildingsInCity}}
hireBuildingsOnMap Buildings where the unit can be hired on the map 
{{#invoke:Unit|get|Angel|hireBuildingsOnMap}}
stats.property Access to specific property in stats object 
{{#invoke:Unit|get|Angel|stats.hp}}
baseClass.property Access to specific property in baseClass object 
{{#invoke:Unit|get|Angel|baseClass.name}}
 Embodiment
cost.property Access to specific property in unitCost object 
{{#invoke:Unit|get|Angel|cost.gold}}
 2400
arrayName.index.property Access to specific property in array elements (e.g., activeAbilities.1.name) 
{{#invoke:Unit|get|Angel|activeAbilities.1.name}}

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|en}}
    - English
  • {{#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=7753"