Template:Item/doc - Revision history

MikeB at 14:22, 12 January 2025

2025-01-12T14:22:15Z

← Older revision		Revision as of 14:22, 12 January 2025
Line 17:		Line 17:
	\|VersionUpdate =		\|VersionUpdate =
	\|Stack =		\|Stack =
			\|Uses =
	\|Rarity =		\|Rarity =
	\|Attributes =		\|Attributes =
Line 66:		Line 67:
	<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the item was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>		<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the item was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
	<tr><td>Stack</td><td>Yes</td><td>The number of items which can be stacked on top of each other (defaults to 1). Will be displayed in the infobox of the page.</td><td>positive number</td></tr>		<tr><td>Stack</td><td>Yes</td><td>The number of items which can be stacked on top of each other (defaults to 1). Will be displayed in the infobox of the page.</td><td>positive number</td></tr>
			<tr><td>Uses</td><td>Yes</td><td>The number of times this item can be used to produce an effect (defaults to 0). Negative values represent repeated uses per day. Will be displayed in the infobox of the page.</td><td>0 = not consumable; positive number X = can be used X times; negative number X = repeated uses X times per day</td></tr>
	<tr><td>Rarity</td><td>Yes</td><td>The incidence of the item. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:Rarity]] (other values are ignored): {{ListFormat\|{{Rarity\|TagList}}\|Bullets}}</td></tr>		<tr><td>Rarity</td><td>Yes</td><td>The incidence of the item. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:Rarity]] (other values are ignored): {{ListFormat\|{{Rarity\|TagList}}\|Bullets}}</td></tr>
	<tr><td>Attributes</td><td>No</td><td>One or more attributes which describe certain aspects of the item. Will be displayed in the infobox of the page. A list of predefined attributes can be found in [[Template:ItemAttributes]] (if new attributes are introduced, they should also be added there).</td><td>a semicolon-separated list of the values defined in [[Template:ItemAttributes]] (other values are ignored): {{ListFormat\|{{ItemAttributes\|Tag}}\|Bullets}}</td></tr>		<tr><td>Attributes</td><td>No</td><td>One or more attributes which describe certain aspects of the item. Will be displayed in the infobox of the page. A list of predefined attributes can be found in [[Template:ItemAttributes]] (if new attributes are introduced, they should also be added there).</td><td>a semicolon-separated list of the values defined in [[Template:ItemAttributes]] (other values are ignored): {{ListFormat\|{{ItemAttributes\|Tag}}\|Bullets}}</td></tr>

MikeB at 20:52, 11 January 2025

2025-01-11T20:52:14Z

← Older revision		Revision as of 20:52, 11 January 2025
Line 80:		Line 80:

	<tr><th colspan="4" style="text-align:left">''Value''</th></tr>		<tr><th colspan="4" style="text-align:left">''Value''</th></tr>
	<tr><td>Buy</td><td>Yes</td><td>The basic price of the item when bought from a merchant (without modifiers). Set to 0 when not buyable.</td><td>non-negative number</td></tr>		<tr><td>Buy</td><td>Yes</td><td>The basic price of the item when bought from a merchant (without modifiers). Set to -1 when not buyable.</td><td>non-negative number or -1</td></tr>
	<tr><td>Sell</td><td>Yes</td><td>The basic price of the item when sold to a merchant (without modifiers). Set to 0 when unsellable.</td><td>non-negative number</td></tr>		<tr><td>Sell</td><td>Yes</td><td>The basic price of the item when sold to a merchant (without modifiers). Set to -1 when unsellable.</td><td>non-negative number or -1</td></tr>

	<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>		<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>

MikeB: Replace Template:Elements by Template:Resistances

2025-01-11T13:24:39Z

Replace Template:Elements by Template:Resistances

← Older revision		Revision as of 13:24, 11 January 2025
Line 89:		Line 89:
	<tr><td>Offense</td><td>Yes</td><td>The offensive properties bonus/malus provided by consuming the item. See [[Template:Offense]] for further information.</td><td>a vector of 9 comma-separated numbers, representing offense values (e.g. "3,8,0,1,4,1,50,10,1")</td></tr>		<tr><td>Offense</td><td>Yes</td><td>The offensive properties bonus/malus provided by consuming the item. See [[Template:Offense]] for further information.</td><td>a vector of 9 comma-separated numbers, representing offense values (e.g. "3,8,0,1,4,1,50,10,1")</td></tr>
	<tr><td>Defense</td><td>Yes</td><td>The defensive properties bonus/malus provided by consuming the item. See [[Template:Defense]] for further information.</td><td>a vector of 4 comma-separated numbers, representing defense values (e.g. "2,15,5,2")</td></tr>		<tr><td>Defense</td><td>Yes</td><td>The defensive properties bonus/malus provided by consuming the item. See [[Template:Defense]] for further information.</td><td>a vector of 4 comma-separated numbers, representing defense values (e.g. "2,15,5,2")</td></tr>
	<tr><td>Resist</td><td>Yes</td><td>The resistance bonus/malus provided by consuming the item. See [[Template:~~Elements~~]] for further information.</td><td>a vector of 6 comma-separated numbers, representing resistance values (e.g. "10,0,50,-10,0,0")</td></tr>		<tr><td>Resist</td><td>Yes</td><td>The resistance bonus/malus provided by consuming the item. See [[Template:Resistances]] for further information.</td><td>a vector of 6 comma-separated numbers, representing resistance values (e.g. "10,0,50,-10,0,0")</td></tr>
	<tr><td>Effects</td><td>Yes</td><td>A short description of the effects provided by consuming the item.</td><td>a semicolon-separated list of effects</td></tr>		<tr><td>Effects</td><td>Yes</td><td>A short description of the effects provided by consuming the item.</td><td>a semicolon-separated list of effects</td></tr>
	<tr><td>Duration</td><td>No</td><td>The duration of the effects after consuming the item.</td><td>arbitrary text</td></tr>		<tr><td>Duration</td><td>No</td><td>The duration of the effects after consuming the item.</td><td>arbitrary text</td></tr>

MikeB at 20:07, 7 January 2025

2025-01-07T20:07:53Z

← Older revision		Revision as of 20:07, 7 January 2025
Line 16:		Line 16:
	\|Version =		\|Version =
	\|VersionUpdate =		\|VersionUpdate =
			\|Stack =
	\|Rarity =		\|Rarity =
	\|Attributes =		\|Attributes =
			\|Prerequisites =
	\|Quests =		\|Quests =
	~~\|Prerequisites =~~

	<!-- Media -->		<!-- Media -->
Line 64:		Line 65:
	<tr><td>Version</td><td>Yes</td><td>The game version in which the item was first introduced. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>		<tr><td>Version</td><td>Yes</td><td>The game version in which the item was first introduced. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
	<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the item was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>		<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the item was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
			<tr><td>Stack</td><td>Yes</td><td>The number of items which can be stacked on top of each other (defaults to 1). Will be displayed in the infobox of the page.</td><td>positive number</td></tr>
	<tr><td>Rarity</td><td>Yes</td><td>The incidence of the item. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:Rarity]] (other values are ignored): {{ListFormat\|{{Rarity\|TagList}}\|Bullets}}</td></tr>		<tr><td>Rarity</td><td>Yes</td><td>The incidence of the item. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:Rarity]] (other values are ignored): {{ListFormat\|{{Rarity\|TagList}}\|Bullets}}</td></tr>
	<tr><td>Attributes</td><td>No</td><td>One or more attributes which describe certain aspects of the item. Will be displayed in the infobox of the page. A list of predefined attributes can be found in [[Template:ItemAttributes]] (if new attributes are introduced, they should also be added there).</td><td>a semicolon-separated list of the values defined in [[Template:ItemAttributes]] (other values are ignored): {{ListFormat\|{{ItemAttributes\|Tag}}\|Bullets}}</td></tr>		<tr><td>Attributes</td><td>No</td><td>One or more attributes which describe certain aspects of the item. Will be displayed in the infobox of the page. A list of predefined attributes can be found in [[Template:ItemAttributes]] (if new attributes are introduced, they should also be added there).</td><td>a semicolon-separated list of the values defined in [[Template:ItemAttributes]] (other values are ignored): {{ListFormat\|{{ItemAttributes\|Tag}}\|Bullets}}</td></tr>
			<tr><td>Prerequisites</td><td>No</td><td>If specific prerequisites have to be fulfilled to use the item, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of prerequisites</td></tr>
	<tr><td>Quests</td><td>No</td><td>If the item is of importance for certain quests, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Quests]]s</nowiki></td></tr>		<tr><td>Quests</td><td>No</td><td>If the item is of importance for certain quests, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Quests]]s</nowiki></td></tr>
	<tr><td>Prerequisites</td><td>No</td><td>If specific prerequisites have to be fulfilled to use the item, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of prerequisites</td></tr>

	<tr><th colspan="4" style="text-align:left">''Media''</th></tr>		<tr><th colspan="4" style="text-align:left">''Media''</th></tr>

MikeB at 19:41, 7 January 2025

2025-01-07T19:41:03Z

← Older revision		Revision as of 19:41, 7 January 2025
Line 34:		Line 34:

	<!-- Stats -->		<!-- Stats -->
			\|Weight =
	\|Traits =		\|Traits =
	\|Stats =		\|Stats =
Line 81:		Line 82:

	<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>		<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>
			<tr><td>Weight</td><td>Yes</td><td>The weight of the armor. Will be displayed in the infobox of the page.</td><td>non-negative number</td></tr>
	<tr><td>Traits</td><td>Yes</td><td>The trait bonus/malus provided by consuming the item. See [[Template:Traits]] for further information.</td><td>a vector of 7 comma-separated numbers, representing trait values (e.g. "4,8,8,5,6,3,6")</td></tr>		<tr><td>Traits</td><td>Yes</td><td>The trait bonus/malus provided by consuming the item. See [[Template:Traits]] for further information.</td><td>a vector of 7 comma-separated numbers, representing trait values (e.g. "4,8,8,5,6,3,6")</td></tr>
	<tr><td>Stats</td><td>Yes</td><td>The base stats bonus/malus provided by consuming the item. See [[Template:Stats]] for further information.</td><td>a vector of 6 comma-separated numbers, representing stat values (e.g. "52,11,10,18,3,0")</td></tr>		<tr><td>Stats</td><td>Yes</td><td>The base stats bonus/malus provided by consuming the item. See [[Template:Stats]] for further information.</td><td>a vector of 8 comma-separated numbers, representing stat values (e.g. "30,20,8,2,-1,3,0,5")</td></tr>
	<tr><td>Offense</td><td>Yes</td><td>The offensive properties bonus/malus provided by consuming the item. See [[Template:Offense]] for further information.</td><td>a vector of 7 comma-separated numbers, representing offense values (e.g. "3,8,0,2,1,50,10")</td></tr>		<tr><td>Offense</td><td>Yes</td><td>The offensive properties bonus/malus provided by consuming the item. See [[Template:Offense]] for further information.</td><td>a vector of 9 comma-separated numbers, representing offense values (e.g. "3,8,0,1,4,1,50,10,1")</td></tr>
	<tr><td>Defense</td><td>Yes</td><td>The defensive properties bonus/malus provided by consuming the item. See [[Template:Defense]] for further information.</td><td>a vector of 2 comma-separated numbers, representing defense values (e.g. "2,15")</td></tr>		<tr><td>Defense</td><td>Yes</td><td>The defensive properties bonus/malus provided by consuming the item. See [[Template:Defense]] for further information.</td><td>a vector of 4 comma-separated numbers, representing defense values (e.g. "2,15,5,2")</td></tr>
	<tr><td>Resist</td><td>Yes</td><td>The resistance bonus/malus provided by consuming the item. See [[Template:Elements]] for further information.</td><td>a vector of 6 comma-separated numbers, representing resistance values (e.g. "10,0,50,-10,0,0")</td></tr>		<tr><td>Resist</td><td>Yes</td><td>The resistance bonus/malus provided by consuming the item. See [[Template:Elements]] for further information.</td><td>a vector of 6 comma-separated numbers, representing resistance values (e.g. "10,0,50,-10,0,0")</td></tr>
	<tr><td>Effects</td><td>Yes</td><td>A short description of the effects provided by consuming the item.</td><td>a semicolon-separated list of effects</td></tr>		<tr><td>Effects</td><td>Yes</td><td>A short description of the effects provided by consuming the item.</td><td>a semicolon-separated list of effects</td></tr>

MikeB: Created page with "== Description == This is the main template for all item pages. It determines the layout of the individual page and provides functionality for extracting specific item information for use in other pages. == Usage ==

 {{Item |Mode = {{{1|Page}}} |Param1 = {{{2|}}} |Param2 = {{{3|}}}   |Name =  |Pagename =  |Status =  |Type =  |Version =  |VersionUpdate =  |Rarity =  |Attributes =  |Quests =  |Prerequisites =    |Image =  |Icon =   <..."

2023-08-23T18:48:26Z

Created page with "== Description == This is the main template for all item pages. It determines the layout of the individual page and provides functionality for extracting specific item information for use in other pages. == Usage == <pre> {{Item |Mode = {{{1|Page}}} |Param1 = {{{2|}}} |Param2 = {{{3|}}}  |Name = |Pagename = |Status = |Type = |Version = |VersionUpdate = |Rarity = |Attributes = |Quests = |Prerequisites =  |Image = |Icon = <..."

New page

== Description ==
This is the main template for all item pages. It determines the layout of the individual page and provides functionality for extracting specific item information for use in other pages.

== Usage ==
<pre>
{{Item
|Mode = {{{1|Page}}}
|Param1 = {{{2|}}}
|Param2 = {{{3|}}}


|Name =
|Pagename =
|Status =
|Type =
|Version =
|VersionUpdate =
|Rarity =
|Attributes =
|Quests =
|Prerequisites =


|Image =
|Icon =


|Description =
|Notes =


|Buy =
|Sell =


|Traits =
|Stats =
|Offense =
|Defense =
|Resist =
|Effects =
|Duration =


|FoundIn =
|DroppedBy =
|SoldBy =
|RewardedBy =
}}</pre>

== Parameters ==
<table class="wikitable">
<tr><th>Name</th><th>Required</th><th>Description</th><th>Values</th></tr>
<tr><td>Mode</td><td>Yes</td><td>Determines the mode of execution of the template ([[#Extracting specific item information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{1|Page}}}</nowiki> (should not be changed)</td></tr>
<tr><td>Param1</td><td>Yes</td><td>Used for routing a selection parameter to the template in certain modes ([[#Extracting specific item information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{2|}}}</nowiki> (should not be changed)</td></tr>
<tr><td>Param2</td><td>Yes</td><td>Used for routing a selection parameter to the template in certain modes ([[#Extracting specific item information for use in other pages|see below]]). Changing the predefined value may lead to unexpected behavior.</td><td><nowiki>{{{3|}}}</nowiki> (should not be changed)</td></tr>

<tr><th colspan="4" style="text-align:left">''Quick Facts''</th></tr>
<tr><td>Name</td><td>Yes</td><td>The name of the item. Usually identical to the page title. Will be displayed in the infobox of the page.</td><td>arbitrary text</td></tr>
<tr><td>Pagename</td><td>Yes</td><td>The title of the item page, needed for linking purposes. Note: Do not use magic words such as <nowiki>{{PAGENAME}}</nowiki> here, as this prevents proper linking when transcluding information from this page on other pages.</td><td>arbitrary text</td></tr>
<tr><td>Status</td><td>No</td><td>If the page has a special status, it can be set here. A corresponding box will be displayed at the top of the page.</td><td>one of the values defined in [[Template:PageStatus]]</td></tr>
<tr><td>Type</td><td>Yes</td><td>The specific type of the item. Will be displayed in the infobox of the page. A list of predefined types can be found in [[Template:ItemType]] (if new types are introduced, they should also be added there).</td><td>one of the values defined in [[Template:ItemType]] (other values are ignored): {{ListFormat|{{ItemType|TagList}}|Bullets}}</td></tr>
<tr><td>Version</td><td>Yes</td><td>The game version in which the item was first introduced. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
<tr><td>VersionUpdate</td><td>No</td><td>The game version in which the item was last updated. Will be displayed in the infobox of the page.</td><td>version number in the form X.Y.Z</td></tr>
<tr><td>Rarity</td><td>Yes</td><td>The incidence of the item. Will be displayed in the infobox of the page.</td><td>one of the values defined in [[Template:Rarity]] (other values are ignored): {{ListFormat|{{Rarity|TagList}}|Bullets}}</td></tr>
<tr><td>Attributes</td><td>No</td><td>One or more attributes which describe certain aspects of the item. Will be displayed in the infobox of the page. A list of predefined attributes can be found in [[Template:ItemAttributes]] (if new attributes are introduced, they should also be added there).</td><td>a semicolon-separated list of the values defined in [[Template:ItemAttributes]] (other values are ignored): {{ListFormat|{{ItemAttributes|Tag}}|Bullets}}</td></tr>
<tr><td>Quests</td><td>No</td><td>If the item is of importance for certain quests, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Quests]]s</nowiki></td></tr>
<tr><td>Prerequisites</td><td>No</td><td>If specific prerequisites have to be fulfilled to use the item, they can be listed here. Will be displayed in the infobox of the page.</td><td>a semicolon-separated list of prerequisites</td></tr>

<tr><th colspan="4" style="text-align:left">''Media''</th></tr>
<tr><td>Image</td><td>Yes</td><td>The image (PNG or JPG) to be displayed in the infobox of the page.</td><td>image name (including file extension)</td></tr>
<tr><td>Icon</td><td>No</td><td>The image (PNG or JPG) to be displayed as an icon in item tables, lists, etc. If nothing is specified, a small version of ''Image'' is used instead.</td><td>image name (including file extension)</td></tr>

<tr><th colspan="4" style="text-align:left">''Info''</th></tr>
<tr><td>Description</td><td>Yes</td><td>A concise description of the item itself. Is used as an introductory paragraph and should not be too excessive (2−3 sentences are usually enough).</td><td>arbitrary text</td></tr>
<tr><td>Notes</td><td>No</td><td>Any kind of ancillary information (which does not seem appropriate anywhere else) can be provided here.</td><td>arbitrary text, ideally formatted as a bullet list (using <nowiki>*</nowiki>)</td></tr>

<tr><th colspan="4" style="text-align:left">''Value''</th></tr>
<tr><td>Buy</td><td>Yes</td><td>The basic price of the item when bought from a merchant (without modifiers). Set to 0 when not buyable.</td><td>non-negative number</td></tr>
<tr><td>Sell</td><td>Yes</td><td>The basic price of the item when sold to a merchant (without modifiers). Set to 0 when unsellable.</td><td>non-negative number</td></tr>

<tr><th colspan="4" style="text-align:left">''Stats''</th></tr>
<tr><td>Traits</td><td>Yes</td><td>The trait bonus/malus provided by consuming the item. See [[Template:Traits]] for further information.</td><td>a vector of 7 comma-separated numbers, representing trait values (e.g. "4,8,8,5,6,3,6")</td></tr>
<tr><td>Stats</td><td>Yes</td><td>The base stats bonus/malus provided by consuming the item. See [[Template:Stats]] for further information.</td><td>a vector of 6 comma-separated numbers, representing stat values (e.g. "52,11,10,18,3,0")</td></tr>
<tr><td>Offense</td><td>Yes</td><td>The offensive properties bonus/malus provided by consuming the item. See [[Template:Offense]] for further information.</td><td>a vector of 7 comma-separated numbers, representing offense values (e.g. "3,8,0,2,1,50,10")</td></tr>
<tr><td>Defense</td><td>Yes</td><td>The defensive properties bonus/malus provided by consuming the item. See [[Template:Defense]] for further information.</td><td>a vector of 2 comma-separated numbers, representing defense values (e.g. "2,15")</td></tr>
<tr><td>Resist</td><td>Yes</td><td>The resistance bonus/malus provided by consuming the item. See [[Template:Elements]] for further information.</td><td>a vector of 6 comma-separated numbers, representing resistance values (e.g. "10,0,50,-10,0,0")</td></tr>
<tr><td>Effects</td><td>Yes</td><td>A short description of the effects provided by consuming the item.</td><td>a semicolon-separated list of effects</td></tr>
<tr><td>Duration</td><td>No</td><td>The duration of the effects after consuming the item.</td><td>arbitrary text</td></tr>

<tr><th colspan="4" style="text-align:left">''Location''</th></tr>
<tr><td>FoundIn</td><td>No</td><td>If the item is found in certain areas, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Area]]s</nowiki></td></tr>
<tr><td>DroppedBy</td><td>No</td><td>If the item is dropped by certain characters/creatures, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Character]]s</nowiki> and/or <nowiki>[[Creature]]s</nowiki></td></tr>
<tr><td>SoldBy</td><td>No</td><td>If the item can by bought from certain merchants, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Character]]s</nowiki></td></tr>
<tr><td>RewardedBy</td><td>No</td><td>If the item is rewarded by certain quests, they can be listed here.</td><td>a semicolon-separated list of <nowiki>[[Quest]]s</nowiki></td></tr>
</table>

== Extracting specific item information for use in other pages ==
=== Syntax ===
You can transclude information from an item page in any other page by using the following syntax:
<pre>
{{:<pagename>|<mode>|<param1>|<param2>}}
</pre>
Here, <pagename> is the item's full page name (in main namespace), <mode> determines the type of information to be transcluded, and <param1> & <param2> represent selection parameters required by certain modes.

=== Modes and parameters ===
<table class="wikitable>
<tr><th>Mode</th><th>Description</th><th>Parameter 1</th><th>Parameter 2</th></tr>
<tr><td>Page</td><td>Outputs the full item page. This is the default mode.</td><td>none</td><td>none</td></tr>
<tr><td>TableHead</td><td>Outputs the header of an item table (intended for constructing overview tables).</td><td>none</td><td>none</td></tr>
<tr><td>TableEntry</td><td>Outputs a table row containing specific item information (intended for constructing overview tables). If a selector is specified in <param1>, output is only generated if the selector of a specific item matches the value of <param2>. If no selector is specified, output is always generated.</td><td>one of the following selectors: {{ListFormat|Type; Attribute|Bullets}}</td><td>one of the possible values of the specified selector</td></tr>
</table>