Module:Sandbox/Aurelain/Cargo
From Heroes of Might and Magic: Olden Era Official Wiki
Documentation for this module may be created at Module:Sandbox/Aurelain/Cargo/doc
local p = {}
local FACTION_ORDER = {
human = 1,
undead = 2,
nature = 3,
demon = 4,
unfrozen = 5,
dungeon = 6,
neutral = 7,
}
local FACTION_MAPPING = {
Temple = 'human',
Necropolis = 'undead',
Grove = 'nature',
Hive = 'demon',
Schism = 'unfrozen',
Dungeon = 'dungeon',
}
-- Note: The right side is just a fallback, it will seldom be used.
local TRANSLATION_IDS = {
creature = 'Creature',
faction = 'Faction',
tier = 'Tier',
wiki_cost = 'Cost',
hp = 'Hp',
offence = 'Offence',
defence = 'Defence',
damage = 'Damage',
initiative = 'Initiative',
morale = 'Morale',
luck = 'Luck',
speed = 'Speed',
wiki_units_neutral = 'Neutral',
wiki_units_archetype = 'Archetype',
melee_attack = 'Melee Attack', -- melee_attack = 1
wiki_units_no_counter = 'Melee no counter', -- melee_attack_no_counter = 2
remote_attack = 'Long Reach', -- remote_attack = 3
ranged_attack = 'Ranged Attack', -- ranged_attack = 4
wiki_units_no_close = 'Ranged<br>no melee penalty', -- ranged_attack_no_close = 5
wiki_units_no_range = 'Ranged<br>no range penalty', -- ranged_attack_no_range = 6
wiki_units_no_range_close = 'Ranged full', -- ranged_attack_no_range_close = 7
}
local RESOURCE_ICONS = {
wood_cost = 'Wood',
ore_cost = 'Ore',
mercury_cost = 'Mercury',
dust_cost = 'Dust',
crystal_cost = 'Crystal',
gemstone_cost = 'Gemstones'
}
local STAT_ICONS = {
hp = 'Icon_Stats_Health',
offence = 'Icon_Stats_Attack',
defence = 'Icon_Stats_Defence',
damage = 'Icon_Stats_Damage',
morale = 'Icon_Stats_Morale',
luck = 'Icon_Stats_Luck',
initiative = 'Icon_Stats_Initiative',
speed = 'Icon_Stats_Speed',
}
local ATTACK_RANKS = {
base_passive_melee_attack_name = 1, -- Swordsman 100, 0, 0, 0, 0, 0, 0, 0, 0
base_passive_melee_attack_no_counter_name = 2, -- Vampire Lord 101, 0, 0, 0, 0, 0, 0, 0, 0
base_passive_remote_attack_name = 3, -- Graverobber 0, 100, 0, 0, 0, 0, 0, 0, 0
base_passive_ranged_attack_name = 4, -- Onyx Dancer 50, 100, 100, 90, 80, 70, 60, 50, 50
base_passive_ranged_attack_no_close_name = 5, -- Faun 100, 100, 100, 90, 80, 70, 60, 50, 50
base_passive_ranged_attack_no_range_name = 6, -- Marksman 50, 100, 100, 100, 100, 100, 100, 100, 100
base_passive_ranged_attack_no_range_close_name = 7, -- Archangel 100, 100, 100, 100, 100, 100, 100, 100, 100
}
local ATTACK_ICONS = {
base_passive_melee_attack_name = 'Base_passive_melee_attack',
base_passive_melee_attack_no_counter_name = 'Base_passive_noncounter',
base_passive_remote_attack_name = 'Base_passive_remote_attack',
base_passive_ranged_attack_name = 'Base_passive_ranged_attack', -- TODO: clarify icon
base_passive_ranged_attack_no_close_name = 'Base_passive_evasive_0', -- TODO: clarify icon
base_passive_ranged_attack_no_range_name = 'Arbitrator_passive_1', -- TODO: clarify icon
base_passive_ranged_attack_no_range_close_name = 'Base_passive_sharpshooter', -- TODO: clarify icon
}
local ATTACK_WORDS = {
base_passive_melee_attack_name = 'melee_attack',
base_passive_melee_attack_no_counter_name = 'wiki_units_no_counter',
base_passive_remote_attack_name = 'remote_attack',
base_passive_ranged_attack_name = 'ranged_attack',
base_passive_ranged_attack_no_close_name = 'wiki_units_no_close',
base_passive_ranged_attack_no_range_name = 'wiki_units_no_range',
base_passive_ranged_attack_no_range_close_name = 'wiki_units_no_range_close',
}
local ROMAN = { 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII' }
local PAGES = {
Stinger = 'Stinger_(unit)',
}
local MORALE_AND_LUCK = {
'<span class="elevated1">1</span>',
'<span class="elevated2">2</span>',
'<span class="elevated3">3</span>',
}
-- Awards a number from 0 to 3 for a unit, based on how upgraded it is
------------------------------------------------------------------------------------------------------------------------
local function computeUpgradeRank(row)
local base = (row['base'] and row['base'] ~= "") and 1 or 0
local upgrade = (row['upgrade'] and row['upgrade'] ~= "") and 10 or 0
local sum = base + upgrade
if sum == 1 then
return 3
elseif sum == 10 then
return 1
elseif sum == 0 then
return 0
else
return 2
end
end
-- Returns one of the ATTACK_RANKS keys (e.g. 'base_passive_melee_attack_name') or an empty string
------------------------------------------------------------------------------------------------------------------------
local function computeAttackType(row)
local abilities = row['shared_abilities']
if type(abilities) ~= "string" then
return ""
end
for key, _ in pairs(ATTACK_RANKS) do
local pattern = "%f[%w]" .. key .. "%f[%W]"
if string.match(abilities, pattern) then
return key
end
end
return ""
end
-- Returns a rich wikitext with numbers and icons
------------------------------------------------------------------------------------------------------------------------
local function computeCost(row)
local gold = row['gold_cost']
local cost = gold .. '[[File:Icon_Resource_Gold.png|24px|link=]]'
for key, icon in pairs(RESOURCE_ICONS) do
local val = row[key]
if val and val ~= '' and val ~= 0 then
cost = cost .. ' ' .. val .. '[[File:Icon_Resource_' .. icon .. '.png|24px|link=]]'
end
end
return cost
end
-- Retrieves the data from Cargo
------------------------------------------------------------------------------------------------------------------------
local function query(lang, forcedFaction)
local tables = 'Unit, Translation'
local fields = '' ..
'Unit.id=id, ' ..
'Unit.faction=faction, ' ..
'Unit.tier=tier, ' ..
'Unit.hp=hp, ' ..
'Unit.offence=offence, ' ..
'Unit.defence=defence, ' ..
'Unit.damage_min=damage_min, ' ..
'Unit.damage_max=damage_max, ' ..
'Unit.morale=morale, ' ..
'Unit.luck=luck, ' ..
'Unit.initiative=initiative, ' ..
'Unit.speed=speed, ' ..
'Unit.shared_abilities=shared_abilities, ' .. -- we use it for range detection
-- costs
'Unit.gold_cost=gold_cost, ' ..
'Unit.wood_cost=wood_cost, ' ..
'Unit.ore_cost=ore_cost, ' ..
'Unit.mercury_cost=mercury_cost, ' ..
'Unit.dust_cost=dust_cost, ' ..
'Unit.crystal_cost=crystal_cost, ' ..
'Unit.gemstone_cost=gemstone_cost, ' ..
-- upgrade
'Unit.base_sid=base, ' ..
'Unit.upgrade_sid=upgrade, ' ..
-- Translation
'Translation.language=language, ' ..
'Translation.name=transName'
-- where:
local where = {}
if forcedFaction then
table.insert(where, 'Unit.faction="' .. forcedFaction .. '"')
end
table.insert(where, '(Translation.language = "en" OR Translation.language = "' .. lang .. '")')
-- Get BOTH the English row AND the target language row
local cargoArgs = {
join = 'Unit.id = Translation.target_id',
where = table.concat(where, ' AND '),
orderBy = 'Unit.id ASC',
limit = 1000 -- Increased limit since each unit will return 2 rows
}
return mw.ext.cargo.query(tables, fields, cargoArgs)
end
-- Scans the Cargo results and folds the EN and lang rows into a single row
------------------------------------------------------------------------------------------------------------------------
local function consolidateResults(results, lang)
local units = {}
for _, row in ipairs(results) do
local id = row['id']
-- If this is the first time seeing this id, set up its basic stats
if not units[id] then
units[id] = mw.clone(row)
units[id].upgradeRank = computeUpgradeRank(row)
units[id].attackType = computeAttackType(row)
units[id].cost = computeCost(row)
end
-- Save the names based on which language row we are currently looping over
if row['language'] == 'en' then
units[id].nameEn = row['transName']
end
if row['language'] == lang then
units[id].nameX = row['transName']
end
end
-- Convert the Dictionary into an Array
local unitsArray = {}
for _, unitData in pairs(units) do
table.insert(unitsArray, unitData)
end
return unitsArray
end
-- Decides the order between two units, for sorting purposes.
------------------------------------------------------------------------------------------------------------------------
local function sortUnits(unitA, unitB)
local rankA = FACTION_ORDER[unitA.faction] or 99
local rankB = FACTION_ORDER[unitB.faction] or 99
if rankA ~= rankB then
return rankA < rankB
end
if unitA.tier ~= unitB.tier then
return unitA.tier < unitB.tier
end
if unitA.upgradeRank ~= unitB.upgradeRank then
return unitA.upgradeRank < unitB.upgradeRank
end
return unitA.hp < unitB.hp
end
-- Retrieves the text for some specific ids from Cargo Translations.
------------------------------------------------------------------------------------------------------------------------
local function translateIds(ids, lang, extra)
-- Key list
local list = {}
for key, _ in pairs(ids) do
list[#list + 1] = key
end
local idListString = '"' .. table.concat(list, '", "') .. '"'
-- Cargo
local where = {}
table.insert(where, 'target_id IN (' .. idListString .. ')')
table.insert(where, 'language = "' .. lang .. '"')
if extra then
table.insert(where, extra)
end
local results = mw.ext.cargo.query('Translation', 'target_id, name', {
where = table.concat(where, ' AND '),
limit = 100
})
-- Dictionary
local dictionary = mw.clone(ids)
for key, value in pairs(dictionary) do
dictionary[key] = value .. '[[Data:WikiTranslations/' .. lang .. '#' .. key .. '|💬]]'
--dictionary[key] = value
end
for _, row in ipairs(results) do
local name = row['name']
if name and name ~= '' and not name:find('💬') then
dictionary[row['target_id']] = name
end
end
return dictionary
end
-- Displays a variable
------------------------------------------------------------------------------------------------------------------------
local function dump(target)
return '<pre>' .. mw.dumpObject(target) .. '</pre>'
end
-- Builds an icon+text combo for the unit's name
------------------------------------------------------------------------------------------------------------------------
local function renderUnitName(u, suffix)
local stem = PAGES[u.nameEn] or u.nameEn
local page = stem .. suffix
local img = '[[File:' .. u.nameEn .. ' icon.png|64px|link=' .. page .. ']]'
local text = '[[' .. page .. '|' .. u.nameX .. ']]'
return img .. ' ' .. text
end
-- Boilerplate for the header cells
------------------------------------------------------------------------------------------------------------------------
local function addTh(tr, text)
tr:tag('th'):wikitext(text):done()
end
-- Boilerplate for stat tds
------------------------------------------------------------------------------------------------------------------------
local function createStat(tr, value, pngName)
tr:tag('td'):wikitext(value .. '[[File:' .. pngName .. '.png|link=]]'):done()
end
-- Boilerplate for the separator
------------------------------------------------------------------------------------------------------------------------
local function addSeparator(htmlTable, className, content)
htmlTable:tag('tr')
:addClass('separator')
:addClass(className)
:tag('td'):attr('data-sort-value', ''):attr('colspan', 100):wikitext(content):done()
end
------------------------------------------------------------------------------------------------------------------------
local function addFactionWords(words, lang, suffix, frame)
for key, _ in pairs(FACTION_ORDER) do
if key == 'neutral' then
local file = '[[File:Primordial_Chaos.png|24px]]'
words[key] = file .. ' [[Neutral_Units' .. suffix .. '|'.. words.wiki_units_neutral .. ']]'
else
words[key] = frame:preprocess('{{F|' .. key .. '|' .. lang .. '}}')
end
end
end
------------------------------------------------------------------------------------------------------------------------
local function renderIconWithHint(fileName, text, frame)
local file = '[[File:' .. fileName .. '.png|32px|link=]]';
return frame:preprocess('{{Hint|' .. file .. '|' .. text .. '}}')
end
------------------------------------------------------------------------------------------------------------------------
local function createHeader(htmlTable, words, frame)
local header = htmlTable:tag('tr')
-- 1 to 4 (general)
addTh(header, words.creature)
addTh(header, words.faction)
addTh(header, words.tier)
addTh(header, words.wiki_cost)
-- 5 to 12 (main stats)
addTh(header, renderIconWithHint(STAT_ICONS.hp, words.hp, frame))
addTh(header, renderIconWithHint(STAT_ICONS.offence, words.offence, frame))
addTh(header, renderIconWithHint(STAT_ICONS.defence, words.defence, frame))
addTh(header, renderIconWithHint(STAT_ICONS.damage, words.damage, frame))
addTh(header, renderIconWithHint(STAT_ICONS.morale, words.morale, frame))
addTh(header, renderIconWithHint(STAT_ICONS.luck, words.luck, frame))
addTh(header, renderIconWithHint(STAT_ICONS.initiative, words.initiative, frame))
addTh(header, renderIconWithHint(STAT_ICONS.speed, words.speed, frame))
-- 13 (others)
addTh(header, renderIconWithHint('Trick_demon_passive_1', words.wiki_units_archetype, frame))
end
------------------------------------------------------------------------------------------------------------------------
local function createBody(htmlTable, units, words, suffix, frame)
local currentTier = units[1].tier
local currentFaction = units[1].faction
for _, u in ipairs(units) do
-- separators
if u.faction ~= currentFaction then
currentFaction = u.faction
currentTier = u.tier
addSeparator(htmlTable, 'separator-large', words[currentFaction])
elseif u.tier ~= currentTier then
currentTier = u.tier
addSeparator(htmlTable, 'separator-tiny', '')
end
local tr = htmlTable:tag('tr'):addClass('unit')
if u.upgradeRank == 2 or u.upgradeRank == 3 then
tr:addClass('upgraded')
end
-- 1 to 4 (general)
tr:tag('td'):wikitext(renderUnitName(u, suffix)):done()
tr:tag('td'):wikitext(words[currentFaction]):done()
tr:tag('td'):wikitext(ROMAN[tonumber(u.tier)]):done()
tr:tag('td'):attr('data-sort-value', string.match(u.cost, "^%d+")):wikitext(u.cost):done()
-- 5 to 12 (main stats)
createStat(tr, u.hp, STAT_ICONS.hp)
createStat(tr, u.offence, STAT_ICONS.offence)
createStat(tr, u.defence, STAT_ICONS.defence)
createStat(tr, u.damage_min .. '-' .. u.damage_max, STAT_ICONS.damage)
createStat(tr, MORALE_AND_LUCK[tonumber(u.morale)] or u.morale, STAT_ICONS.morale)
createStat(tr, MORALE_AND_LUCK[tonumber(u.luck)] or u.luck, STAT_ICONS.luck)
createStat(tr, u.initiative, STAT_ICONS.initiative)
createStat(tr, u.speed, STAT_ICONS.speed)
-- 13 (others)
local wording = ATTACK_WORDS[u.attackType]
local icon = renderIconWithHint(ATTACK_ICONS[u.attackType], words[wording], frame)
tr:tag('td'):attr('data-sort-value', ATTACK_RANKS[u.attackType]):wikitext(icon):done()
end
end
-- Main public function
------------------------------------------------------------------------------------------------------------------------
function p.display(frame)
--do return dump(frame) end
-- Args
local args = frame.args
local lang = args.lang ~= '' and args.lang or 'en'
--lang = 'ja'
local forcedFaction = FACTION_MAPPING[args.faction] or nil
--forcedFaction = 'human'
-- Language
local suffix = lang ~= 'en' and '/' .. lang or ''
local words = translateIds(TRANSLATION_IDS, lang)
addFactionWords(words, lang, suffix, frame)
-- Cargo
local results = query(lang, forcedFaction)
local units = consolidateResults(results, lang)
table.sort(units, sortUnits)
-- Table
local htmlTable = mw.html.create('table')
htmlTable:addClass('wikitable sortable')
if forcedFaction then
htmlTable:addClass('forced-faction')
end
createHeader(htmlTable, words, frame)
createBody(htmlTable, units, words, suffix, frame)
-- Output
local styleTag = frame:extensionTag('templatestyles', '', { src = frame:getTitle() .. '/styles.css' })
return '<div class="units-overview">' .. styleTag .. tostring(htmlTable) .. '</div>'
end
return p
