Module:Wares/Data

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search

For more information on how this data is used, see Template:Wares#Display Format.

For information on editing module data in general, see Guidelines:Modules/Data.

Schema
Data
currencies
A list of currencies which have dedicated templates for displaying values, for example Template:Rupee and Template:Mon. Template:Wares will use the corresponding template when a price is listed in the given currency.
name
The name of the currency.
multigame
Indicates whether the currency template has a game parameter that needs to be passed on to the currency template (e.g. {{Rupee|BotW|100}}) or not (e.g. {{Mon|100}}).
items

Determines how certain items are listed.

fileFormat and quantityFormat strings can have any of the following variables:

  • ${singular}: The singular term for a given item in the given game.
  • ${plural}: The plural term for a given item in the given game.
  • ${quantity}: The value of the quantity parameter for a given item in the Wares table.

defaults
2D
Default configuration values for 2D games.
[fileScale]
[fileFormat]
[fileSize]
[quantityFormat]
[restocks]
3D
Default configuration values for 3D games.
[fileFormat]
[fileSize]
[quantityFormat]
[restocks]
<game>
[fileScale]
Image thumbnails for the given game are sized based on their original size multiplied by this scaling factor. Ensures that sprites maintain their sizes relative to one another.
[fileSize]
Image size in pixels for items in the given game.
[fileFormat]
Default fileFormat value for all items in the given game.
[quantityFormat]
Default quantityFormat value for all items in the given game.
[restocks]
Default restocks value for all items in the given game.

local function restockDsClock(game)
	return string.format("Restocks daily.{{Clarify|%s|reason= What time on the DS clock? Does Link have to do anything besides leave the shop and come back in?}}", game)
end

local function restockExitShop(game)
	return string.format("Restocks when Link leaves the {{Term|%s|Shop}}.", game)
end

return {
	currencies = {
		{
			name = "Rupee",
			multigame = true,
		},
		{
			name = "Mon",
			multigame = false,
		},
		{
			name = "Poe",
			multigame = false,
		},
	},
	items = {
		defaults = {
			["2D"] = {
				quantityFormat = "${quantity} [[${singular}|${plural}]]",
				fileFormat = "File:${game} ${singular} Sprite.png",
				fileScale = 3,
				fileSize = "64x64px",
			},
			["3D"] = {
				quantityFormat = "${quantity} [[${singular}|${plural}]]",
				fileFormat = "File:${game} ${singular} Model.png",
				fileSize = "64x64px",
			},
		},
		["ALttP"] = {
			["Arrow"] = {
				fileFormat = "File:ALttP Arrows ${quantity} Sprite.png",
			},
			["Bomb"] = {
				fileFormat = "File:ALttP Bombs ${quantity} Sprite.png",
			},
		},
		["LANS"] = {
			["Secret Medicine"] = {
				fileFormat = "File:LANS Secret Medicine Icon.png"
			},
		},
		["OoT"] = {
			quantityFormat = "[[${singular}|${plural}]] (${quantity} pieces)",	
			["Arrow"] = {
				fileFormat = "File:OoT Arrows ${quantity} Model.png",
			},
			["Heart"] = {
				fileFormat = "File:OoT Recovery Heart Model.png",
			},
			["Recovery Heart"] = {
				fileFormat = "File:OoT Recovery Heart Model.png",
			},
		},
		["OoT3D"] = {
			quantityFormat = "[[${singular}|${plural}]] (${quantity})",	
			["Arrow"] = {
				fileFormat = "File:OoT3D Arrows ${quantity} Model.png",
			},
			["Bombchu"] = {
				quantityFormat = "[[Bombchu]] (${quantity})",	
			},
			["Deku Seed"] = {
				fileFormat = "File:OoT3D Deku Seeds Model.png",
			},
		},
		["MM"] = {
			["Blue Potion"] = {
				fileFormat = "File:MM Blue Potion Model.png",
			},
			["Green Potion"] = {
				fileFormat = "File:MM Green Potion Model.png",
			},
			["Red Potion"] = {
				fileFormat = "File:MM Red Potion Model.png",
			},
			["Hero's Shield"] = {
				fileFormat = "File:MM Hero's Shield Item Model.png"
			},
		},
		["OoS"] = {
			["Heart"] = {
				quantityFormat = "[[${singular}|${plural}]]",
				fileFormat = "File:OoS Hearts Sprite.png",
			}	
		},
		["OoA"] = {
			["Heart"] = {
				quantityFormat = "[[${singular}|${plural}]]",
				fileFormat = "File:OoA Hearts Sprite.png",
			}	
		},
		["TWWHD"] = {
			fileFormat = "File:TWWHD ${singular} Artwork.png", -- This should probably be removed at some point, but for now we have way more artwork uploaded than models
			["Empty Bottle"] = {
				fileFormat = "File:TWWHD Empty Bottle Artwork.png" -- Current term from TWWHD is "Bottle" but I'm not sure I should change it
			},
			["Piece of Heart"] = {
				fileFormat = "File:TWWHD Piece of Heart Model.png",
			},
		},
		["TMC"] = {
			["Arrow"] = {
				fileFormat = "File: TMC Arrows ${quantity} Sprite.png"
			},
			["Bomb"] = {
				fileFormat = "File: TMC Bombs ${quantity} Sprite.png"
			},
			["Mysterious Shell"] = {
				fileFormat = "File: TMC Mysterious Shells ${quantity} Sprite.png"
			},
		},
		["TP"] = {
			quantityFormat = "[[${singular}|${plural}]] (${quantity})",
			["Arrow"] = {
				fileFormat = "File:TP Arrows Render.png",
			},
			["Blue Potion"] = {
				fileFormat = "File:TP Blue Potion Render.png",
			},
			["Bomb"] = {
				fileFormat = "File:TP Bomb Render.png",	
			},
			["Premium Kit"] = {
				fileFormat = "File:TPHD Bomb Bag Model.png",
			},
			["Red Potion"] = {
				fileFormat = "File:TP Red Potion Render.png",
			},
		},
		["TPHD"] = {
			quantityFormat = "[[${singular}|${plural}]] (${quantity})",
			["Arrow"] = {
				fileFormat = "File:TP Arrows Render.png",
			},
			["Blue Potion"] = {
				fileFormat = "File:TP Blue Potion Render.png",
			},
			["Premium Kit"] = {
				fileFormat = "File:TPHD Bomb Bag Model.png",
			},
			["Red Potion"] = {
				fileFormat = "File:TP Red Potion Render.png",
			},
			["Water Bomb"] = {
				fileFormat = "File:TPHD Water Bomb Artwork.png",
			},
		},
		["PH"] = {
			["Arrow"] = {
				fileFormat = "File:PH Arrows Model.png",
			},
			["Bomb"] = {
				fileFormat = "File:PH Bombs Model.png",
			},
			["Purple Potion"] = {
				restocks = restockExitShop("PH"),
			},
			["Red Potion"] = {
				restocks = restockExitShop("PH"),
			},
			["Yellow Potion"] = {
				restocks = restockExitShop("PH"),
			},
			["Treasure"] = {
				fileFormat = "",
				restocks = restockDsClock("PH"),
			},
			["Ship Part"] = {
				fileFormat = "File:PH Ship Part Model.png",
				restocks = restockDsClock("PH"),
			},
		},
		["ST"] = {
			["Arrow"] = {
				fileFormat = "File:ST Arrows Model.png",
			},
			["Bomb"] = {
				fileFormat = "File:ST Bombs Model.png",
			},
			["Treasure"] = {
				fileFormat = "",
				restocks = restockDsClock("ST"),
			},
		},
		["BotW"] = {
			quantityFormat = "[[${singular}]] x${quantity}",
			fileFormat = "File:${game} ${singular} Icon.png",
			restocks = "Restocks.{{When|BotW}}",
		},
		["TotK"] = {
			quantityFormat = "[[${singular}]] x${quantity}",
			fileFormat = "File:${game} ${singular} Icon.png",
			["Poe"] = {
				fileFormat = "File:TotK Poe Currency Icon.png"
			},
			restocks = "Restocks at midnight in-game.",
		},
		["HWAoC"] = {
			fileFormat = "File:${game} ${singular} Icon.png",
			restocks = "Restocks.{{When|HWAoC}}",
		},	
	},
}