Template:Infobox/doc

< Template:Infobox
Revision as of 00:12, 23 May 2023 by Lizz (talk | contribs) (→‎placement: add doors)

Description

This template creates an Info Box with key information about a page, or properties of an item. It automatically adds select categories to a page based on values provided.

Usage

The convention is to add an infobox section as the first item on the page. There are multiple possible parameters, which will be outlined below.


Infobox/doc
Decorative Steamboat.png
Information
Type: Menu Icon Furniture.png Furniture
Categories: Decor.png Decor
Art.png Art
Placement: 2x1 (Surfaces)
Tags:
Colors:
Event Cost: Centennial Token.png 30
Costs: Star Coin icon.png 2,720
From: Centennial Star Path (T6 Premium)

was created from...

{{infobox
|image=Decorative Steamboat.png
|type=Furniture
|category=Decor, Art
|buyprice=2720
|color=white, black, brown
|tags=Elegant, Dining Room, Living Room, Study, Quirky
|universe=Mickey & Friends
|from={{name|Centennial Star Path}} (T6 Premium)
|eventprice={{price|30|centennialtoken}}
|size=2x1
|placement=surfaces
}}


or


Blue Dress Pants
Blue Dress Pants (2).png
Blue Dress Pants (2) m.png
Information
Type: Menu Icon Clothing.png Clothing
Categories: Menu Icon Pants.png Pants
Tags:
Colors:
Costs: Star Coin icon.png 5,200
From: Menu Icon Scrooge Store.png Scrooge's Store

was created from...

{{infobox
|name=Blue Dress Pants
|image=Blue Dress Pants (2).png
|image_m=Blue Dress Pants (2) m.png
|type=Clothing
|category=Pants
|buyprice=5200
|color=blue, pink
|tags=Professional, Modern, Bold, Pants
|from=[[Scrooge's Store]]
|storeSlot=trio
}}


or


Infobox/doc
Pumpkin Soup.png

A thick, creamy soup with an orange hue.

Information
Type: Menu Icon Meals.png Meal
Categories: Appetizers.png Appetizer
Sells for: Star Coin icon.png 1,500 or more
Energy: Energy.png+1,431 or more
Ingredients: Vegetables.png Any Vegetable

Milk
Ginger
Pumpkin

was created from...

{{infobox
|image=Pumpkin Soup.png
|description=A thick, creamy soup with an orange hue.
|type=Meal
|category=Appetizers
|stars=4
|energy=1431
|sellprice=1500
|ingredients={{name|Pumpkin}}<br>
{{name|Ginger}}<br>
{{name|Milk}}<br>
{{ingredient|Vegetables}}
}}


or


Infobox/doc
Iron Crafting Station.png
Information
Type: Menu Icon Furniture.png Crafted Furniture
Crafting Category: Functional Items.png Functional Items
Functionality: Crafting.png Crafting Station
Reward From: Menu Icon Quests.png Scrooge McDuck's Grand Re-opening Scrooge McDuck.png Menu Icon Story.png
Crafting Recipe: Iron Ingot (10)

Hardwood (10)
Topaz

was created from...

{{infobox
|image=Iron Crafting Station.png				
|type=Crafted Furniture
|craftingcategory=Functional Items
|category=none
|color=
|tags=
|universe=Other
|reward={{quest|Scrooge McDuck's Grand Re-opening|realm=Story|friendship=Scrooge McDuck}}
|recipe={{name|Iron Ingot|10}}<br>
{{name|Hardwood|10}}<br>
{{name|Topaz}}
|functions=Crafting Station
}}

Parameters

name

|name=Blue Dress Pants

name only needs to be provided if the name of the item differs from the name of the page. This happens in cases where there are multiple items with identical names, or the actual name contains a character that cannot be used in a page name. It will be displayed in the top bar of the infobox.

image

|image=Blue Dress Pants (2).png

image specifies the full file name, including extension, of the focal image to use in the infobox. The image and the page should be named identically.


image_m

Applicable For: Clothing

|image_m=Blue Dress Pants (2) m.png

image_m specifies the full file name, including extension, of the male avatar image to use in the infobox. This is applicable for Coats, Costumes, Dresses, Socks, Pants, Shoes, Shorts, Skirts, and Tops; other Clothing types do not have separate male and female images. The image_m should be named identically to the page, but with an additional " m" before the .png file extension.


width

|width=350px

width controls the width of the image in the infobox. This is typically not necessary to specify, and can be omitted.


type

|type=Furniture

type specifies the overall classification of the item.

Possible Values: Clothing, Companion, Crafted Furniture, Crafting, Currency, Fish, Flooring, Foraging, Furniture, Gem, Ingredient, Landscaping, Meal, Memory, Quest Item, Wallpaper.


craftingcategory

Applicable For: Crafting

|craftingcategory=Functional Items

craftingcategory specifies the subcategory of Crafting of this item, as labeled on the Crafting Collection tab. There will be exactly one value. The value should be provided as a simple text. When displayed in the infobox, it will be displayed with the inlineIcon template, with an anchored link to the Crafting page.

Possible Values: Refined Materials, Enchantments, Fences & Paving, Functional Items, Furniture


category

Applicable For: Clothing, Furniture

|category=Decor, Misc.

category specifies the category filters associated with the item. There can be multiple categories. If the value is "none", the item has no associated colors, and it will ONLY display in results when the All category filter is selected. Categories should be provided in the same order that they appear in the furniture and clothing menu. If creating a new item page and/or all categories have not been confirmed, add Category: Missing Categories to the bottom of the page, and leave the parameter blank.


stars

Applicable For: Meals

|stars=4

stars specifies the number of Stars a Meal Recipe has, which corresponds directly to how many Ingredients it requires. When displayed in the infobox, it will be displayed with the stars template.


energy

Applicable For: Meals

|energy=1431

energy specifies how much energy the Player gains by consuming the item. The value should be provided as a simple number, with no commas. When displayed in the infobox, it will be displayed with the energy template.


buyprice

|buyprice=6400

buyprice specifies the number of Star Coins that are required to purchase this item from Scrooge's Store, Goofy's Stall, Kristoff’s Stall, or Prince Eric's Blueprint Table. The value should be provided as a simple number, with no commas. When displayed in the infobox, it will be displayed with the price template.


sellprice

|sellprice=1500

sellprice specifies the number of Star Coins that are obtained in exchange for selling this item at Goofy's Stall or serving this meal at Chez Remy. The value should be provided as a simple number, with no commas. When displayed in the infobox, it will be displayed with the price template.


color

Applicable For: Clothing, Furniture

|color=white, black, brown

color specifies the color filters associated with the Clothing or Furniture item. There can be multiple colors. If the value is "none", the item has no associated colors, and it will ONLY display in results when no color filters are selected. Colors should be provided in the same order that they appear in the furniture and clothing menu. If creating a new item page and all colors have not been confirmed, add Category: Missing Colors to the bottom of the page, and leave the parameter blank.


tags

Applicable For: Clothing, Furniture

|tags=Elegant, Dining Room, Living Room, Study, Quirky

tags specifies both the Style and Furniture Zones filter values, which are grouped together when displayed in Scrooge's Shop and Scrooge's Catalog. There can be multiple tags. If the value is "none", the item has no associated tags, and it will ONLY display in results when no Style or Furniture Zones filters are selected. When displayed in the infobox, they call the tag template. Tags should be provided in the same order that they appear in Scrooge's Shop and Scrooge's Catalog. If creating a new item page and all tags have not been confirmed, add Category: Missing Tags to the bottom of the page, and leave the parameter blank. If you suspect that a page is missing tags, check the page's history log first, and then add Missing Tags if you think the item needs verification.


universe

Applicable For: Clothing, Furniture

|universe=Mickey & Friends

universe specifies the Universe associated with the Clothing or Furniture item. There can only be one Universe associated. If the value is "none", the item has no associated Universe - it will ONLY display in results when no Universe filters are selected.

Possible Values: Ancient Civilization, Beauty and the Beast, Cars, Cinderella, Coco, Disney, Encanto, Frozen, Hercules, Lightyear, Lilo & Stitch, Mickey & Friends, Moana, Monsters, Inc., Ratatouille, Sleeping Beauty, Snow White, Tangled, The Incredibles, The Lion King, The Little Mermaid, The Princess and the Frog, The Sword in the Stone, Toy Story, Up, WALL-E, Wreck-It Ralph, Other, none


from

|from={{name|Centennial Star Path}} (T6 Premium)


storeSlot

Applicable For: Clothing, Furniture sold in Scrooge's Store

|storeSlot=quad FL

storeSlot specifies the location in Scrooge's Store that a Clothing or Furniture item is sold on the floor. If creating a new item page and the storeSlot value has not been confirmed, add Category: Missing Store Slot to the bottom of the page, and leave the parameter blank. When displayed in the infobox, a friendly name for the storeSlot will be displayed, and a category will be automatically added to the page.

Possible Values:

  • Clothing Values:
    • clothing table
    • trio
    • window
  • Furniture Values: (labels are all relative to viewpoint from entering the store)
    • table 1 - table slot closest to the Iron Crafting Station
    • table 2
    • table 3
    • table 4 - table slot closet to the front of store
    • quad FL - quad display, front left item (closest to door)
    • quad FR - quad display, front right item
    • quad BL - quad display, back left item
    • quad BR - quad display, back right item
    • quad FL/F - quad display, front half (will be positioned in front left spot if only 2 items on the quad)
    • quad BR/B - quad display, back half (will be positioned in back right spot if only 2 items on the quad)
    • up L1, up L3 - upstairs left display, taking 1/2 of space, on left (when facing) (closer to door), or centered, taking full space
    • up L2, up L3, up R1
    • up L2, up R1, up R3
    • up M1, up M2, up M3 - upstairs center display, taking 1/2 of space on left or right, or centered, taking full space
    • up M3 - upstairs center display, large item taking full space
    • up R1, up R2, up R3 - upstairs right display, taking 1/2 of space on left or right, or centered, taking full space
    • up R2, up R3 - upstairs right display, taking 1/2 of space, on right (when facing) (closer to door), or centered, taking full space

eventprice

Applicable For: Clothing, Furniture available from Star Path

|eventprice={{price|30|centennialtoken}}

eventprice specifies the unlock price of an item during a limited-time event, i.e. a Star Path item. There will be exactly one value. The value will be rendered as-is, so it should be provided using the price template, with the appropriate token value and token type specified.


reward

|reward={{quest|Scrooge McDuck's Grand Re-opening|realm=Story|friendship=Scrooge McDuck}}

reward specifies the achievement that the item is obtained as a reward, i.e. a Friendship Level, Player Level, or Quest. If this is not applicable, it can be omitted. The value will be rendered as-is, so it should be provided using the applicable template, typically friendship or quest.


ingredients

Applicable For: Meals

|ingredients=
{{name|Pumpkin}}<br>
{{name|Ginger}}<br>
{{name|Milk}}<br>
{{ingredient|Vegetables}}

ingredients specifies the Ingredients required to cook a Meal. There can be up to 5 values. They should be provided using the name template, and separated using br tags, if multiple. For readability, it is preferred to also split multiple ingredients onto different lines.


recipe

Applicable For: Crafting

|recipe=
{{name|Iron Ingot|10}}<br>
{{name|Hardwood|10}}<br>
{{name|Topaz}}

recipe specifies the materials required to craft an item. There can be up to 5 values. They should be provided using the name template, and separated using br tags, if multiple. For readability, it is preferred to also split multiple materials onto different lines.


size

Applicable For: Furniture, Ingredients, Materials

|size=2x1

size specifies the dimensions of the item when placed in the world, denoted by the squares that appear in furniture placement mode. When placing items in the world, items will always face a default orientation relative to the viewer's perspective, so long as the viewer is squarely facing a cardinal direction (or a wall of a room, if indoors). Values should be provided in WIDTH x DEPTH or WIDTH x HEIGHT order of this default orientation.

The syntax for providing the dimensions for windows (which usually occupy the full 9 square height of the wall, but often have space above or below the window where items can be placed) has not yet been determined. The syntax for providing dimensions where items do not occupy the full rectangular space of the W x D also has not been determined.


surfaceArea

Applicable For: Furniture

|surfaceArea=1x1

surfaceArea specifies the dimensions of the item that can hold another item on top of it, denoted by the squares that appear in furniture placement mode. Values should be provided in the same WIDTH x DEPTH order of the default orientation that the size dimensions are provided. If the shape of the surface area is not rectangular, provide the value as NUMBER slots. A value of none should only be provided if there is a reasonable expectation that there would be a surface area, but none is available (e.g. the item has the word "table" in it, has the Table category, or similar items typically have a surface area).

Example Values: 2x1, 8 slots, none

placement

Applicable For: Furniture, Ingredients, Materials

|placement=surfaces

placement specifies any requirements or special cases about placing the item in the world. There will only be one value. A category may be automatically added to the page based on the value of placement.

Possible Values:

  • bare - Items that must be placed directly on bare ground, and no other object can be placed underneath them (e.g Rugs). These items may be placed on either paved or unpaved ground.
  • ceilings - Items that can only be placed from the ceiling in the Player's House.
  • doors - Items that can replace other Door items inside the Player's House.
  • surfaces - Items that can be placed either on the ground, or on the surfaces of other table-like items.
  • underneath - Items that can be placed partially or entirely underneath other items (e.g. Rugs, Fancy Mat).
  • unpaved - Items that can only be placed on unpaved ground.
  • walls - Items that can only be placed on walls of the Player's House.
  • wall-mounted - Items that must be placed against the walls of the Player's House. Unlike walls placement items, these items occupy floor space, and allow items to be placed on the wall behind them (e.g. Fireplaces)
  • water - Items or Character Houses that must be placed on water.
  • default - Items that can be placed on untiled or untiled ground, but not on surfaces. This is the most common type of placement. It will not be displayed in the infobox.

environment

Applicable For: Furniture

Possible Values: indooronly, outdooronly, wateronly


functions

Applicable For: Furniture

|functions=Crafting Station

functions specifies if the item has any functionality, interactive or otherwise, once placed in the game world. Most values will currently not be displayed in the infobox, with the exceptions of Cooking Station and Crafting Station, which will be displayed using the category template.

Possible Values:

  • Arch - An item that allows the Player to walk underneath it. The Player cannot interact with it.
  • Attraction - An item the Player can Interact with to toggle the sound/movement of the ride on/off
  • Clock - A clock that makes sound effects on the hour
  • Companion Interest - An item that Companions placed in the Cozy Companion Home will interact with, if placed nearby. The Player cannot interact with it.
  • Cooking Station - A station that the Player can Use to make Meals
  • Crafting Station - A station that the Player can use to craft items
  • Door - An item that can be used to replace a Door while in furniture placement mode. The Player can Enter it to move between rooms inside the Player's House.
  • Fireplace - An item the Player can Interact with to toggle the fire on/off
  • Fountain - An item that has a fountain animation, typically with sound effects. The Player cannot interact with it.
  • Lighting (Automatic) - An item that provides a light source, but that the Player cannot control (e.g. ceiling or wall lights).
  • Lighting - An item the Player can Interact with to toggle the light on/off
  • Lounge - An item the Player can Lounge on (e.g. beds, stools)
  • Mailbox - An item the Player can Check to view in-game messages
  • Memory Frame - An item the Player can Change to display unlocked Memories
  • Radio - An item the Player can Change to change the background music
  • Sit - An item the Player can Sit on (e.g. chairs, couches)
  • Storage (16) - An item the Player can Open Storage and store items in up to 16 inventory slots (e.g. some items with the Storage category, Small Chests)
  • Storage (32) - An item the Player can Open Storage and store items in up to 32 inventory slots (e.g. Medium Chests)
  • Storage (48) - An item the Player can Open Storage and store items in up to 48 inventory slots (e.g. Large Chests)
  • Window - An item that provides a light source as a window. The Player cannot interact with it.
  • none - Items that have no functionality. This does not need to be added to items that are clearly decorative. Its intended use is for items that seem like they may have a purpose, but are confirmed to be non-functional, like items with the Storage category that cannot store anything, or items that are heavily cooking- or crafting- themed but are not functional Cooking Stations or Crafting Stations (e.g. Hot Plate, Craft Desk).


Default Infoboxes

Characters

{{infobox
|image=
|from=
|voice=<<wikipedia link>>
|universe=
|house=
|unlockquest=
}}

Character Houses

{{infobox
|image=
|residents=
|universe=
|buyprice=<<if applicable>>
|found=<<location of unlock>>
|from=<<unlock source>>
}}

Crops

{{infobox
|image=
|description=
|type=<<Ingredient>>
|ingtype=<<Vegetables>>
|energy=
|buyprice=<<if sold>> 
|sellprice=
|seed=
|growtime=
|from=<<biome of Goofy stall>>
}}

Foraged Ingredients

{{infobox
|image=
|description=
|type=<<Ingredient>>
|ingtype=<<Spices/Fruit/Etc>>
|energy=
|buyprice=<<if applicable>>
|sellprice=
|found=<<biome>>
}}

Fish

{{infobox
|image=
|description=
|type=<<Ingredient>>
|ingtype=<<Fish>>
|pool=<<color of pool>>
|energy=
|sellprice=
|size=
|found=<<biome>>
}}

Meals

{{infobox
|image=
|description=
|type=<<Meal>>
|category=<<Appetizer/Dessert/Etc>>
|energy=
|sellprice=
|stars=
|ingredients=
}}

Clothing

{{infobox
|image=
|image_m=
|type=<<Clothing>>
|category=
|buyprice=
|color=
|tags=
|universe=
|from=
|storeSlot=<<if sold by scrooge>>
}}

Furniture