Module:ItemData: Difference between revisions
Jump to navigation
Jump to search
reverted is_active to use false instead of nil Tag: Manual revert |
m get_json_item now searches for non-disabled items only |
||
(13 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
local data = mw.loadJsonData("Data:ItemData.json") | local data = mw.loadJsonData("Data:ItemData.json") | ||
-- | ---------------------------------------- Utility functions | ||
function get_json_item(name) | |||
for | -- Returns the table of a specific item | ||
if (v["Name"] == name) then | -- @function get_json_item | ||
-- @param {string} | |||
-- @return {table} | |||
local function get_json_item(name) | |||
for _, v in pairs(data) do | |||
if (v["Name"] == name and not v["Disabled"]) then | |||
return v | return v | ||
end | end | ||
Line 12: | Line 17: | ||
end | end | ||
--{{ | -- Returns an array of item tables that have the same properties | ||
-- @function get_similar_items | |||
-- @param {string} | |||
-- @return {array of tables} | |||
local function get_similar_items(property) | |||
local similarItems = {} | |||
for _, v in pairs(data) do | |||
if (v[property] ~= nil) then | |||
table.insert(similarItems, v) | |||
end | |||
end | |||
return similarItems | |||
end | |||
-- Adds commas delimiter to the thousands place | |||
local lang = mw.language.getContentLanguage() | |||
local function Format(amount) | |||
local formatted = amount | |||
if(type(formatted) ~= "number") then return "<span style=\"color:red;\">Cannot format non-number value.</span>" end | |||
return lang:formatNum(tonumber(formatted)) | |||
end | |||
--- Get cost of an item | |||
-- @function get_cost | |||
-- @param {string} | |||
-- @return {number} | |||
local function get_cost(item_name) | |||
local item = get_json_item(item_name) | local item = get_json_item(item_name) | ||
if(item == nil) then return "Item Not Found" end | if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end | ||
local cost = 0 | local cost = 0 | ||
Line 31: | Line 60: | ||
end | end | ||
--{ | --- Get type/slot/category of an item | ||
-- @function get_type | |||
-- @param {string} | |||
-- @return {string} | |||
local function get_type(item_name) | |||
local item = get_json_item(item_name) | local item = get_json_item(item_name) | ||
if(item == nil) then return "Item Not Found" end | if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end | ||
if (item["Slot"] == "Weapon") then | if (item["Slot"] == "Weapon") then | ||
Line 46: | Line 77: | ||
return nil | return nil | ||
end | end | ||
end | |||
---------------------------------------- Invocable functions | |||
--- {{#invoke:ItemData|get_cost|ITEM_NAME}} access point | |||
p.get_cost = function(frame) | |||
local item_name = frame.args[1] | |||
return Format(get_cost(item_name)) | |||
end | |||
-- Module access point | |||
function p._get_cost(a) | |||
a = tostring(a) or '0' | |||
return get_cost(a) | |||
end | |||
-- {{#invoke:ItemData|get_type|ITEM_NAME}} access point | |||
p.get_type = function(frame) | |||
local item_name = frame.args[1] | |||
return get_type(item_name) | |||
end | |||
-- Module access point | |||
function p._get_type(a) | |||
a = tostring(a) or "" | |||
return get_type(a) | |||
end | end | ||
Line 52: | Line 110: | ||
local item_name = frame.args[1] | local item_name = frame.args[1] | ||
local item = get_json_item(item_name) | local item = get_json_item(item_name) | ||
if(item == nil) then return "Item Not Found" end | if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end | ||
if (item["Activation"] == "Passive") then | if (item["Activation"] == "Passive") then | ||
Line 64: | Line 122: | ||
--check Data:ItemData.json for properties | --check Data:ItemData.json for properties | ||
p.get_prop = function(frame) | p.get_prop = function(frame) | ||
local tableValues = {} | |||
local item_name = frame.args[1] | local item_name = frame.args[1] | ||
local property = frame.args[2] | local property = frame.args[2] | ||
local item = get_json_item(item_name) | local item = get_json_item(item_name) | ||
if(item == nil) then return "Item Not Found" end | if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end | ||
if(type(item[property]) == "table") then | |||
for i,v in pairs(item[property]) do | |||
local tableValues = table.insert(tableValues, v) | |||
end | |||
return table.concat(tableValues, ", ") | |||
end | |||
return item[property] | return item[property] | ||
end | end | ||
p.get_component_name = function(frame) | p.get_component_name = function(frame) | ||
local item_name = frame.args[1] | local item_name = frame.args[1] | ||
local item = get_json_item(item_name) | local item = get_json_item(item_name) | ||
if(item == nil) then return "Item Not Found" end | if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end | ||
local components = item['Components'] | local components = item['Components'] | ||
Line 86: | Line 151: | ||
return component['Name'] | return component['Name'] | ||
end | |||
-- {{Items count}} access point | |||
function p.get_headcount() | |||
local iter = 0 | |||
local tbl = get_similar_items("Disabled") | |||
for _, v in ipairs(tbl) do | |||
if (v["Disabled"] == false and v["Name"] ~= nil) then | |||
iter = iter + 1 | |||
end | |||
end | |||
return iter | |||
end | end | ||
return p | return p |
Latest revision as of 14:33, 9 October 2024
Loads data from Data:ItemData.json
Usage[edit source]
{{#invoke:ItemData|FUNCTION_NAME|PARAMETER1|PARAMETER2}}
Functions[edit source]
get_cost|ITEM_NAME
- Returns the total cost including components.
get_type|ITEM_NAME
- The ItemData.json has different names for each category: Weapon = Weapon, Vitality = Armor, Spirit = Tech. This function will return Weapon, Vitality, or Spirit
is_active|ITEM_NAME
- returns true/false
get_prop|ITEM_NAME|PROPERTY
- check the json file for item properties
Example[edit source]
To get the total cost of Boundless Spirit you'd type:
{{#invoke:ItemData|get_cost|Boundless Spirit}}
and it would return:
9800
local p = {};
local data = mw.loadJsonData("Data:ItemData.json")
---------------------------------------- Utility functions
-- Returns the table of a specific item
-- @function get_json_item
-- @param {string}
-- @return {table}
local function get_json_item(name)
for _, v in pairs(data) do
if (v["Name"] == name and not v["Disabled"]) then
return v
end
end
return nil
end
-- Returns an array of item tables that have the same properties
-- @function get_similar_items
-- @param {string}
-- @return {array of tables}
local function get_similar_items(property)
local similarItems = {}
for _, v in pairs(data) do
if (v[property] ~= nil) then
table.insert(similarItems, v)
end
end
return similarItems
end
-- Adds commas delimiter to the thousands place
local lang = mw.language.getContentLanguage()
local function Format(amount)
local formatted = amount
if(type(formatted) ~= "number") then return "<span style=\"color:red;\">Cannot format non-number value.</span>" end
return lang:formatNum(tonumber(formatted))
end
--- Get cost of an item
-- @function get_cost
-- @param {string}
-- @return {number}
local function get_cost(item_name)
local item = get_json_item(item_name)
if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end
local cost = 0
local cur_item = item
repeat
cost = cost + cur_item["Cost"]
if(cur_item["Components"] == nil) then
break
end
cur_item = data[cur_item["Components"][1]]
until cur_item == nil
return cost
end
--- Get type/slot/category of an item
-- @function get_type
-- @param {string}
-- @return {string}
local function get_type(item_name)
local item = get_json_item(item_name)
if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end
if (item["Slot"] == "Weapon") then
return "Weapon"
elseif (item["Slot"] == "Armor") then
return "Vitality"
elseif (item["Slot"] == "Tech") then
return "Spirit"
else
return nil
end
end
---------------------------------------- Invocable functions
--- {{#invoke:ItemData|get_cost|ITEM_NAME}} access point
p.get_cost = function(frame)
local item_name = frame.args[1]
return Format(get_cost(item_name))
end
-- Module access point
function p._get_cost(a)
a = tostring(a) or '0'
return get_cost(a)
end
-- {{#invoke:ItemData|get_type|ITEM_NAME}} access point
p.get_type = function(frame)
local item_name = frame.args[1]
return get_type(item_name)
end
-- Module access point
function p._get_type(a)
a = tostring(a) or ""
return get_type(a)
end
--{{#invoke:ItemData|is_active|ITEM_NAME}}--
p.is_active = function(frame)
local item_name = frame.args[1]
local item = get_json_item(item_name)
if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end
if (item["Activation"] == "Passive") then
return false
else
return true
end
end
--{{#invoke:ItemData|get_prop|ITEM_NAME|PROPERTY}}--
--check Data:ItemData.json for properties
p.get_prop = function(frame)
local tableValues = {}
local item_name = frame.args[1]
local property = frame.args[2]
local item = get_json_item(item_name)
if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end
if(type(item[property]) == "table") then
for i,v in pairs(item[property]) do
local tableValues = table.insert(tableValues, v)
end
return table.concat(tableValues, ", ")
end
return item[property]
end
p.get_component_name = function(frame)
local item_name = frame.args[1]
local item = get_json_item(item_name)
if(item == nil) then return "<span style=\"color:red;\">Item Not Found.</span>" end
local components = item['Components']
--return empty string if no component found
if(components == nil) then return nil end
local component_key = components[1]
local component = data[component_key]
if (component == nil) then return nil end
return component['Name']
end
-- {{Items count}} access point
function p.get_headcount()
local iter = 0
local tbl = get_similar_items("Disabled")
for _, v in ipairs(tbl) do
if (v["Disabled"] == false and v["Name"] ~= nil) then
iter = iter + 1
end
end
return iter
end
return p