Module:Item class

Module documentation[view] [edit] [history] [purge]

This module depends on the following other modules:

• Module:No globals
• Module:Util
• Module:Game
• Module:Item class/config
• Module:Infocard

Implements {{item class list}} and {{item class infocard}}.

The above documentation is transcluded from Module:Item class/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

-------------------------------------------------------------------------------
-- 
--                        Module:Item class infocard
-- 
-- This module implements Template:Item class infocard
-------------------------------------------------------------------------------

-- ----------------------------------------------------------------------------
-- Includes
-- ----------------------------------------------------------------------------

local getArgs = require('Module:Arguments').getArgs
local m_util = require('Module:Util')

-- Should we use the sandbox version of the game data?
local use_sandbox = m_util.misc.maybe_sandbox('Item class infocard')

local m_game = use_sandbox and mw.loadData('Module:Game/sandbox') or mw.loadData('Module:Game')

local i18n = {
    page = '[[Item class]]',
    info = m_util.html.abbr('(?)', 'Item classes categorize items. Classes are often used to restrict items or skill gems to a specific class or by item filters'),
    also_referred_to_as = 'Also referred to as: %s',
    filterid = 'Item filter ID: %s',
    is_suppressed = "''Suppressed from most item class lists.''",
    is_uncertain = "''Data may be incorrect.'' " .. m_util.html.abbr('(?)', 'Some of this information is questionable. If you can confirm or correct it, please let us know on the talk page.'),
    long_upper = 'Long uppercase name: %s',
    long_lower = 'Long lowercase name: %s',

    errors = {
        invalid_class = 'The item class name "%s" is invalid.',
    },
}

-- ----------------------------------------------------------------------------
-- Exported functions
-- ----------------------------------------------------------------------------
local p = {}

function p.main(frame)
    -- Get args
    local tpl_args = getArgs(frame, {
        parentFirst = true
    })

    frame = m_util.misc.get_frame(frame)
    
    if not doInfoCard then
        doInfoCard = require('Module:Infocard')._main
    end

    local constinfo = nil
    local filterid = nil
    for id, row in pairs(m_game.constants.item.classes) do
        if row['full'] == tpl_args.name then
            constinfo = row
            filterid = id
            break
        end
    end
    
    if constinfo == nil then
        error(string.format(i18n.errors.invalid_class, tostring(tpl_args.name)))
    end

    --
    
    local infocard_args = {}

    if tpl_args.name_list ~= nil then
        local names = m_util.string.split(tpl_args.name_list, ',%s*')
        local ul = mw.html.create('ul')
        for _, item in ipairs(names) do
            ul
                :tag('li')
                    :wikitext(item)
                    :done()
        end
        table.insert(infocard_args, string.format(i18n.also_referred_to_as, tostring(ul)))    
    end
    
    table.insert(infocard_args, string.format(i18n.long_upper, tostring(constinfo['long_upper'])))
    table.insert(infocard_args, string.format(i18n.long_lower, tostring(constinfo['long_lower'])))
    table.insert(infocard_args, string.format(i18n.filterid, tostring(filterid)))

    if (constinfo['is_suppressed'] == true) then
        table.insert(infocard_args, i18n.is_suppressed)
        if (constinfo['is_suppressed_details'] ~= nil) and (constinfo['is_suppressed_details'] ~= "") then
            table.insert(infocard_args, tostring(constinfo['is_suppressed_details']))
        end
    end
    
    if (constinfo['is_uncertain'] == true) then
        table.insert(infocard_args, i18n.is_uncertain)
        if (constinfo['is_uncertain_details'] ~= nil) and (constinfo['is_uncertain_details'] ~= "") then
            table.insert(infocard_args, tostring(constinfo['is_uncertain_details']))
        end
    end
    
    -- Output Infocard

    infocard_args['header'] = tpl_args.name
    infocard_args['subheader'] = i18n.page .. i18n.info
    
    -- cats
    
    local cats = {
        'Item classes',
        tpl_args.name,
    }
    
    -- Done
    
    return doInfoCard(infocard_args) .. m_util.misc.add_category(cats, {ignore_blacklist=tpl_args.debug})
end

return p