Module:Test

This module is used for development.

Purpose

This module is used to query information from the uploaded and parsed game files.

Its main purpose is to populate the infoboxes.

Usage

A note on the order of named parameters. All of the parameters that look like ...=... are called named parameters and their order is not important (this is true for all templates).

query

{{#invoke:Test|query|<def ID>[|...|][|tag|][|sibling=...]}}

The work-horse. Output varies based on use:

If only the <def ID> parameter is set, it will show the whole Def in the log.

If simple values are queried it will return them.

If lists are queried it will return nothing but call {{#vardefine}} on all the simple values within it. What got defined can be seen in the page's log.

Named parameters:

<def ID>

This parameter identifies the Def so it is mandatory. It can take two forms, if both are defined then defName takes preference.

defName=<defName>

<defName> (case sensitive) should be replaced with the actual defName of a Def.

label=<label>

<label> (case insensitive) should be replaced with the actual label of a Def.

[sibling=...] (optional) (case sensitive)

Allows querying for something if we know its sibling's value (works only for values at the moment).

Anonymous parameters:

[|...|] (optional) (case sensitive)

Anonymous paramaters before the last one ([tag]) are here to help uniquely identify it. If the [tag] is already unique within a Def tree, then these additional parameters are not needed.

[|tag|] (optional) (case sensitive)

The final anonymous parameter defines what is to be queried.

count

{{#invoke:Test|count|<def ID>[|...|][|tag|][|sibling=...]}}

Parameters are the same as for query. It's basically a wrapped up query that behaves a bit differently.

The difference is in how it handles lists. If a list is queried, unlike query, it will return the length of the list.

How-to

Take a look at a Def

{{#invoke:Test|query|label=desert}}

undefined category

Data is in the log.

Retrieve a simple value

{{#invoke:Test|query|defName=Caribou|description}}

undefined category

Dealing with lists

{{#invoke:Test|query|defName=Mech_Scyther|tools}}

undefined category

When a list is retrieved there will be no output but the log will contain a list of defined variables.

For convenience the list is reprinted here:

tools_1_linkedBodyPartsGroup = LeftBlade
tools_1_cooldownTime = 2
tools_1_label = left blade
tools_1_DPS = 10
tools_1_power = 20
tools_1_capacities_1 = Cut
tools_1_capacities_2 = Stab
tools_2_linkedBodyPartsGroup = RightBlade
tools_2_cooldownTime = 2
tools_2_label = right blade
tools_2_DPS = 10
tools_2_power = 20
tools_2_capacities_1 = Cut
tools_2_capacities_2 = Stab
tools_3_linkedBodyPartsGroup = HeadAttackTool
tools_3_capacities_1 = Blunt
tools_3_label = head
tools_3_DPS = 4.5
tools_3_chanceFactor = 0.2
tools_3_power = 9
tools_3_cooldownTime = 2

All of the above can be accessed with the use of {{#var:...}}.

{{#var:tools_1_DPS}}

DPS is not a normal member of this table but has been added with Lua. Let's call it a virtual field.

Retrieve something if a sibling is known

{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}

undefined category

---

---------------
-- load data --
---------------

local Biomes = mw.loadData('Module:Test/data/biomes')
--local Buildings = mw.loadData('Module:Test/data/buildings')
local Races = mw.loadData('Module:Test/data/races')

-----------------------
-- private functions --
-----------------------

local function find_key_in_table(key, table)
  for k, v in pairs(table) do
    if k == key then return v
    elseif type(v) == "table" then
      local found = find_key_in_table(key, v)
      if found then return found end
    end
  end
end


local function parent_defName(def, category)
  local parent_name = category[def]["ParentName"]
  if type(category[parent_name]) == "table" then
    return parent_name
  end
end


local function find_in_parents(tag, def, category)
  if not category[def] then
    return def .. " not found in category"
  end

  local parent_def = parent_defName(def, category)
  if not parent_def then
    return tag .." not found in parent defs"
  end

  local found = find_key_in_table(tag, category[parent_def])
  if found then return found
  else
    found = find_in_parents(tag, parent_def, category)
    if found then
      return found
    end
  end
end


local function query(tag, def, category)
  if not category[def] then
    return def .. " not found in category"
  end

  local found = find_key_in_table(tag, category[def])
  if found then return found end

  found = find_in_parents(tag, def, category)
  if found then return found end

  return tag .. " not found"
end

--------------------------------
-- publicly exposed functions --
--------------------------------

local p = {}

function p.query(frame)
  local category = frame.args[1]
  local def = frame.args[2]
  local tag = frame.args[3]
  local sublist_query = frame.args[4]

  if category == "Races" then category = Races
  elseif category == "Biomes" then category = Biomes
  else return "undefined category" end

  local queried = query(tag, def, category)

  if sublist_query == "count" then
    if type(queried) == "table" then
      local count = 0;
      for k, v in pairs(queried) do
        count = count + 1
      end
      return table.maxn(queried)
    else
      return tag .. " is not a table (not countable)"
    end
  elseif sublist_query then
    return queried[tonumber(sublist_query)]
  end

  return queried
end

-- os.clock() may be logging time that is not the time I want
mw.log("Module:DefInfo:os.clock() " .. os.clock()*1000 .. " ms")

return p