Module:ItemData

Revision as of 22:57, 9 September 2024 by Saag (talk | contribs) (return nil instead of false for is_active function)

Loads data from Data:ItemData.json

Usage

{{#invoke:ItemData|FUNCTION_NAME|PARAMETER1|PARAMETER2}}

Functions

  • 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

Example

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")

-- returns the table of a specific item
function get_json_item(name)
	for i,v in pairs(data) do
		if (v["Name"] == name) then
			return v
		end
	end
	return nil
end

--{{#invoke:ItemData|get_cost|ITEM_NAME}}--
p.get_cost = function(frame)
	local item_name = frame.args[1]
	local item = get_json_item(item_name)
	if(item == nil) then return "Item Not Found" 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

--{{#invoke:ItemData|get_type|ITEM_NAME}}--
p.get_type = function(frame)
	local item_name = frame.args[1]
	local item = get_json_item(item_name)
	if(item == nil) then return "Item Not Found" 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

--{{#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 "Item Not Found" end
	
	if (item["Activation"] == "Passive") then
		return	nil
	else 
		return true
	end
end

--{{#invoke:ItemData|get_prop|ITEM_NAME|PROPERTY}}--
--check Data:ItemData.json for properties
p.get_prop = function(frame)
	local item_name = frame.args[1]
	local property = frame.args[2]
	local item = get_json_item(item_name)
	if(item == nil) then return "Item Not Found" 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 "Item Not Found" 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

return p