Template:Equipment/doc: Difference between revisions

← Older edit

Template:Equipment/doc (edit)

Revision as of 15:52, 22 September 2016

283 bytes removed , 15:52, 22 September 2016

m

Updated wikidoc

TheCodingGamer

1,105

edits

@@ Line 1: / Line 1: @@
-The Equipment template is used to display information for various pieces of equipment in Dragon Quest games.  This template covers all types of equipment (weapons, armor, shields, helmets, accessories). This template describes a piece of equipment for a '''single game'''.
+The Equipment template is used to display information for various pieces of equipment in Dragon Quest games.  This template covers all types of equipment (weapons, armor, shields, helmets, accessories). This template describes a '''single piece of equipment''' for a '''single game'''.
 ==Usage==
@@ Line 5: / Line 5: @@
 ===Header===
 A header call to this template should be the first usage of this template on any page.
-<pre>{{Equipment|header}}</pre>
+<pre>{{Equipment|header|image=Broad_sword.png|name=Broad Sword|console=NES}}</pre>
-*header: A required parameter which marks this as the start of a equipment table.
+*'''header''': A required parameter which marks this as the start of a equipment table.
-===Subtable===
+*'''console''': An optional parameter for specifying the console version of the game the equipment appears in.
-A subtable call is made to designate equipment data for a specific console.  Note that pieces of equipment that have the exact same attributes across different consoles can be described in the same subtable.
+*'''name''': The name of the equipment.  This should be the localization name used in the game in which this piece of equipment appears.
-<pre>{{Equipment|subtable|console=NES,GBC}}</pre>
+*'''image''': if there is an image of this piece of equipment, it should be included here.  Note this is the filename only, not a link to the image.
-*subtable: A required parameter marking the start of a subtable.
+===Entry===
-*console: The console version of the game. '''Note:''' This parameter should contain multiple console values separated by commas if the attribute parameters are the same.
+An entry call is made to designate equipment data for a specific console.  Note that pieces of equipment that have the exact same attributes across different consoles can be described in the same entry.
-*name: The name of the piece of equipment.  Note that equipment with different localized names, can be combined if there other parameters are the same.  If this is the case, the most recent localization name should be used, with others following in parentheses (i.e. Steel Sword (Broad Sword)).
+<pre>{{Equipment|stat|name=Attack|modifier=+10}}</pre>
-*image: if there is an image of this piece of equipment, it should be linked here.
+*'''stat''': A required parameter marking a stat entry.
-*statModified: The stat being modified by the equipment
+*'''name''': The name of the stat being modified by the equipment
-*statModifier: The value (+/-) the stat is being modified.  Should include a + or - in front of the value.
+*'''modifier''': The value (+/-) the stat is being modified.  Should include a + or - in front of the value.
-*notes: Any special notes about this particular piece of equipment (cursed, in-battle effects, etc.)
-===Subtable Footer===
-This call is mainly for formatting purposes separate sets of equipment data.
-<pre>{{Equipment|subtablefooter}}</pre>
-*subtablefooter: A required parameter marking the end of a subtable.
 ===Footer===
 The footer call marks the end of the equipment table.
-<pre>{{Shop|footer}}</pre>
+<pre>{{Equipment|footer|sellPrice=300|flavor=This is some flavor.|notes=These are notes.}}</pre>
-*footer: A required parameter marking the template as the footer.
+*'''footer''': A required parameter marking the template as the footer.
-==Notes on condensing tables==
+*'''class''': The class of the piece of equipment.
-It is common that many pieces of equipment have slight differences in different console versions of a game.  If only the name of the equipment has changed, the console versions may share a common subtable with the name detailed as instructed above.  However, if there are changes to the equipment stats or notes parameters, each console version should have a separate subtable.  This keeps the table more readable and requires less effort to comprehend.
+*'''equipableBy''': List of characters who can equip the weapon.
+*'''buyPrice''': The price of the equipment when bought from a shop.
+*'''sellPrice''': The price of the equipment when sold to a shop.
+*'''flavor''': If there is specific flavor text used to describe this equipment in the game, it should be quoted here. This paramter is optional.
+*'''notes''': Any special notes about this particular piece of equipment (cursed, in-battle effects, etc.) This parameter is optional.
 ==Example==
 ===Sample===
-{{Equipment|header}}
+{{Equipment|header|image=Lottery_icon.png|name=Giant Hammer|console=GBC}}
-{{Equipment|subtable|console=DS|name=Club|statModified=Attack|statModifier=+8}}
+{{Equipment|stat|name=Attack|modifier=+8}}
-{{Equipment|subtablefooter}}
+{{Equipment|stat|name=Agility|modifier=-10}}
-{{Equipment|subtable|name=Club|console=SNES|statModified=Attack|statModifier=+10|notes=Casts Blaze in battle when used as an item}}
+{{Equipment|footer|buyPrice=60g|sellPrice=30g|flavor=A giant hammer with destructive power.|notes=Casts Slow when used in battle.|class=Hammer}}
-{{Equipment|subtablefooter}}
-{{Equipment|footer}}
 ===Code===
 <pre>
-{{Equipment|header}}
+{{Equipment|header|image=Lottery_icon.png|name=Giant Hammer|console=GBC}}
-{{Equipment|subtable|console=DS|name=Club|statModified=Attack|statModifier=+8}}
+{{Equipment|stat|name=Attack|modifier=+8}}
-{{Equipment|subtablefooter}}
+{{Equipment|stat|name=Agility|modifier=-10}}
-{{Equipment|subtable|name=Club|console=SNES|statModified=Attack|statModifier=+10|notes=Casts Blaze in battle when used as an item}}
+{{Equipment|footer|buyPrice=60g|sellPrice=30g
-{{Equipment|subtablefooter}}
+|flavor=A giant hammer with destructive power.
-{{Equipment|footer}}
+|notes=Casts Slow when used in battle.}}
 </pre>