Difference between revisions of "Template:NHClothing/doc"

From Nookipedia, the Animal Crossing wiki
(Docs page from NHFurniture, needs to be updated)
 
Line 57: Line 57:
 
:;<code>category</code>
 
:;<code>category</code>
 
::The category of the item as seen in the catalog.
 
::The category of the item as seen in the catalog.
::''Possible values: Housewares, Miscellaneous, Wall-mounted, Wallpaper, Floors, Rug, Fashion Items, Creatures, Other''
+
::''Possible values:'' Tops, Bottoms, Dress-Ups, Headwears, Accessories, Socks, Shoes, Bags
  
:;<code>collection</code>
+
:;<code>theme</code>
::The collection the item is a part of. A [[series]] or [[set]].
+
::Theme of the item.
  
:;<code>theme1</code>, <code>theme2</code>, <code>theme3</code>, <code>theme4</code>, <code>theme5</code>
+
:;<code>label1</code>, <code>label2</code>, <code>label3</code>, <code>label4</code>, <code>label5</code>
::Themes that the item belongs to. For furniture, this refers to [[Theme (furniture)|HHA concepts]]. For clothing, this refers to [[Label]] themes.
+
::Themes for the [[Label]]'s fashion check.
  
 
:;<code>color1</code>, <code>color2</code>
 
:;<code>color1</code>, <code>color2</code>
::The colors for the item (for the purposes of [[feng shui]]). Each item has two. For items with variations, <code>color1</code> and <code>color2</code> should be set to those of the "default" (first) variation. Colors for variations can be defined in <code>var1-color1</code>/<code>var1-color2</code>, <code>var2-color1</code>/<code>var2-color2</code>, etc.
+
::The colors for the item. Each item has two. For items with variations, <code>color1</code> and <code>color2</code> should be set to those of the "default" (first) variation. Colors for variations can be defined in <code>var1-color1</code>/<code>var1-color2</code>, <code>var2-color1</code>/<code>var2-color2</code>, etc.
 
 
:;<code>function1</code>, <code>function2</code>
 
::The functionality of the item (e.g. bathtub, lighting, table).
 
  
 
:;<code>length</code>
 
:;<code>length</code>
Line 77: Line 74:
 
::The width of the item as a float (e.g. 1.0, 1.5). Sources an image using {{t|Size}}.
 
::The width of the item as a float (e.g. 1.0, 1.5). Sources an image using {{t|Size}}.
  
:;<code>interactable</code>
+
:;<code>height</code>
::Boolean of whether the player can interact with the item.
+
::The height of the item as a float (e.g. 1.0, 1.5). Generates an appropriately sized silhouette and line to show height relative to the player.
::''Currently not displayed in the template''.
 
  
:;<code>sound</code>
+
=== Acquiring ===
::Boolean of whether the item produces sound.
+
:;<code>availability1</code>, <code>availability2</code>
::''Currently not displayed in the template''.
+
::How the item can be acquired. Value should match one of the options in [[Template:Availability]].
  
:;<code>lighting</code>
+
:;<code>availability1-note</code>, <code>availability2-note</code>
::Boolean of whether the item emits light.
+
::Notes for the availability (e.g. Season, requirements, etc.).
::''Currently not displayed in the template''.
 
  
:;<code>animated</code>
+
:;<code>diy-availability</code>, <code>diy-availability2</code>
::Whether the item is animated without any interaction. This will mostly be used with some wallpapers/flooring, but some furniture as well (e.g. fires, wind turbine, etc.)
+
::If the item is produced using a DIY recipe, this parameter is used to note how the recipe can be acquired. Value should match one of the options in [[Template:Availability]].  
::''Currently not displayed in the template''.
 
  
=== Acquiring ===
+
:;<code>diy-notes</code>, <code>diy-notes2</code>
:;<code>availability</code>, <code>availability2</code>
+
::Notes that will appear in parentheses after the diy-availability.
::How the item can be acquired. Value should match one of the options in [[Template:Availability]].
 
  
 
:;<code>mat1</code>, <code>mat2</code>, <code>mat3</code>, <code>mat4</code>, <code>mat5</code>, <code>mat6</code>
 
:;<code>mat1</code>, <code>mat2</code>, <code>mat3</code>, <code>mat4</code>, <code>mat5</code>, <code>mat6</code>
Line 102: Line 95:
 
:;<code>mat1-num</code>, <code>mat2-num</code>, <code>mat3-num</code>, <code>mat4-num</code>, <code>mat5-num</code>, <code>mat6-num</code>
 
:;<code>mat1-num</code>, <code>mat2-num</code>, <code>mat3-num</code>, <code>mat4-num</code>, <code>mat5-num</code>, <code>mat6-num</code>
 
::Number of material needed.
 
::Number of material needed.
 
:;<code>season</code>, <code>season2</code>
 
::The season an item is exclusively available in.
 
  
 
:;<code>buy</code>
 
:;<code>buy</code>
Line 115: Line 105:
 
::Sell price in Bells.
 
::Sell price in Bells.
  
=== Customization ===
+
=== Variations ===
:;<code>customizable</code>
+
:;<code>variation1</code>, <code>variation2</code>, <code>variation3</code>, <code>variation4</code>, <code>variation5</code> <code>variation6</code>, <code>variation7</code>, <code>variation8</code>
::True or False for whether the item is customizable.
+
::The name of each variation of an item.
 
 
:;<code>custom-kits</code>
 
::The number of customization kits required to do a customization.
 
 
 
:;<code>pattern</code>
 
::If set to True, item can be customized with patterns.
 
 
 
:;<code>pattern1</code>, <code>pattern2</code>, <code>pattern3</code>, <code>pattern4</code>, <code>pattern5</code>, <code>pattern6</code>, <code>pattern7</code>, <code>pattern8</code>
 
::The name of a pattern.
 
::''Currently not displayed in the template''.
 
 
 
:;<code>var</code>
 
::The name of the default (first) variation; this is what is shown at the top of the template.
 
 
 
:;<code>var1</code>, <code>var2</code>, <code>var3</code>, <code>var4</code>, <code>var5</code> <code>var6</code>, <code>var7</code>, <code>var8</code>
 
::Additional variation names.
 
  
 
:;<code>var1-img</code>, <code>var2-img</code>, <code>var3-img</code>, <code>var4-img</code>, <code>var5-img</code> <code>var6-img</code>, <code>var7-img</code>, <code>var8-img</code>
 
:;<code>var1-img</code>, <code>var2-img</code>, <code>var3-img</code>, <code>var4-img</code>, <code>var5-img</code> <code>var6-img</code>, <code>var7-img</code>, <code>var8-img</code>
 +
::The image associated with each variant, not including the leading 'File:'. For items with both variants and patterns, these parameters should contain images for each variant using the first (default) pattern.
  
 
:;<code>var1-color1</code>, <code>var2-color1</code>, <code>var3-color1</code>, <code>var4-color1</code>, <code>var5-color1</code> <code>var6-color1</code>, <code>var7-color1</code>, <code>var8-color1</code>
 
:;<code>var1-color1</code>, <code>var2-color1</code>, <code>var3-color1</code>, <code>var4-color1</code>, <code>var5-color1</code> <code>var6-color1</code>, <code>var7-color1</code>, <code>var8-color1</code>
 +
::The first color associated with each variant.
  
 
:;<code>var1-color2</code>, <code>var2-color2</code>, <code>var3-color2</code>, <code>var4-color2</code>, <code>var5-color2</code> <code>var6-color2</code>, <code>var7-color2</code>, <code>var8-color2</code>
 
:;<code>var1-color2</code>, <code>var2-color2</code>, <code>var3-color2</code>, <code>var4-color2</code>, <code>var5-color2</code> <code>var6-color2</code>, <code>var7-color2</code>, <code>var8-color2</code>
 +
::The second color associated with each variant. Should be left blank if a variant can also has a pattern, as the second color is derived from the pattern.
  
 
=== Other ===
 
=== Other ===
 
:;<code>notes</code>
 
:;<code>notes</code>
 
::Any additional notes (special properties, glitches, attribution, etc.).
 
::Any additional notes (special properties, glitches, attribution, etc.).
 +
 +
:;<code>max-length</code>
 +
::Optional parameter that can be used to force the 2-column or 3-column display of the item name translations. The default value is 30. Increasing the value creates a tendency towards a 3-column display, decreasing it, a 2-column display.

Revision as of 12:09, May 24, 2020

See also:

Parameters

Names

name
The English name of the item.
Default value: Item name in page title.
ja-name
The Japanese name of the item.
fr-name
The French name of the item.
frq-name
The Quebec French name of the item.
de-name
The German name of the item.
ko-name
The Korean name of the item.
it-name
The Italian name of the item.
nl-name
The Dutch name of the item.
zh-name
The Simplified Chinese name of the item.
zht-name
The Traditional Chinese name of the item.
es-name
The Spanish name of the item.
esl-name
The Latin American Spanish name of the item.
ru-name
The Russian name of the item.
identifier
An identifier that connects this item to items in other iterations of Animal Crossing. If an item changes name from game to game, the identifier remains constant. The identifier should be the name of the item as it appears in the earliest Animal Crossing game. For items which can only be obtained as a customization option in a later game (e.g. the Black Pawn & White Pawn become customization options for the Pawn in ACNL), the later name is used instead.
Default value: Item name in page title.

Metadata

category
The category of the item as seen in the catalog.
Possible values: Tops, Bottoms, Dress-Ups, Headwears, Accessories, Socks, Shoes, Bags
theme
Theme of the item.
label1, label2, label3, label4, label5
Themes for the Label's fashion check.
color1, color2
The colors for the item. Each item has two. For items with variations, color1 and color2 should be set to those of the "default" (first) variation. Colors for variations can be defined in var1-color1/var1-color2, var2-color1/var2-color2, etc.
length
The length of the item as a float (e.g. 1.0, 1.5). Sources an image using {{Size}}.
width
The width of the item as a float (e.g. 1.0, 1.5). Sources an image using {{Size}}.
height
The height of the item as a float (e.g. 1.0, 1.5). Generates an appropriately sized silhouette and line to show height relative to the player.

Acquiring

availability1, availability2
How the item can be acquired. Value should match one of the options in Template:Availability.
availability1-note, availability2-note
Notes for the availability (e.g. Season, requirements, etc.).
diy-availability, diy-availability2
If the item is produced using a DIY recipe, this parameter is used to note how the recipe can be acquired. Value should match one of the options in Template:Availability.
diy-notes, diy-notes2
Notes that will appear in parentheses after the diy-availability.
mat1, mat2, mat3, mat4, mat5, mat6
Names of materials needed. Value should match one of the options in Template:Material.
mat1-num, mat2-num, mat3-num, mat4-num, mat5-num, mat6-num
Number of material needed.
buy
Cost to purchase.
currency
Currency to purchase. Value should match one of the options in Template:Currency.
sell
Sell price in Bells.

Variations

variation1, variation2, variation3, variation4, variation5 variation6, variation7, variation8
The name of each variation of an item.
var1-img, var2-img, var3-img, var4-img, var5-img var6-img, var7-img, var8-img
The image associated with each variant, not including the leading 'File:'. For items with both variants and patterns, these parameters should contain images for each variant using the first (default) pattern.
var1-color1, var2-color1, var3-color1, var4-color1, var5-color1 var6-color1, var7-color1, var8-color1
The first color associated with each variant.
var1-color2, var2-color2, var3-color2, var4-color2, var5-color2 var6-color2, var7-color2, var8-color2
The second color associated with each variant. Should be left blank if a variant can also has a pattern, as the second color is derived from the pattern.

Other

notes
Any additional notes (special properties, glitches, attribution, etc.).
max-length
Optional parameter that can be used to force the 2-column or 3-column display of the item name translations. The default value is 30. Increasing the value creates a tendency towards a 3-column display, decreasing it, a 2-column display.