Template:ItemDescription/doc: Difference between revisions

→‎Dream Style - House: update bundlename
(Move content from main template page into separate doc page, add some additional details and values for from params)
 
(→‎Dream Style - House: update bundlename)
 
(6 intermediate revisions by the same user not shown)
Line 6: Line 6:
* How to obtain the item. Whether or not the item is tracked in any Collections.
* How to obtain the item. Whether or not the item is tracked in any Collections.
* How to equip or place the item. Any functions the item has.
* How to equip or place the item. Any functions the item has.


==Usage==
==Usage==
The convention is to add an ''ItemDescription'' section immediately below the '''''infoBox''''', as the second item on the page. There are multiple possible parameters, which are partially outlined below.
The convention is to add an ''ItemDescription'' section immediately below the '''''infoBox''''', as the second item on the page. There are multiple possible parameters, which are partially outlined below.


==Parameters==


====type====
===type===
<!--'''type''' specifies...-->
<!--'''type''' specifies...-->


Line 26: Line 29:




====universe====
===universe===
<!--'''universe''' specifies... uses '''''UniverseAnchorLink''''' template.....-->
<!--'''universe''' specifies... uses '''''UniverseAnchorLink''''' template.....-->




====from====
===from===
'''from''' specifies how the item is obtained. Some values require additional values to also be provided in order to correctly generate a description.
'''from''' specifies how the item is obtained. Some values require additional values to also be provided in order to correctly generate a description.


Line 42: Line 45:
*'''Default, Scrooge's Store''' - One is available and unlocked by default when beginning a new game, and additional items can be purchased from Scrooge's Store (Memory Frame)
*'''Default, Scrooge's Store''' - One is available and unlocked by default when beginning a new game, and additional items can be purchased from Scrooge's Store (Memory Frame)
*'''Feeding Critters'''
*'''Feeding Critters'''
*'''Blueprint Table''' - must also specify the '''recipePrice''' parameter
*'''Blueprint Table''' - Items that first require purchasing their Blueprint at Eric's Blueprint Table before they can be crafted. Must also specify the '''recipePrice''' parameter
*'''Crafting'''
*'''Crafting'''
*'''Pickup, Crafting''' - must also specify the '''found''' parameter
*'''Pickup, Crafting''' - must also specify the '''found''' parameter
*'''Level''' - must also specify the '''playerLevel''' parameter
*'''Level''' - must also specify the '''playerLevel''' parameter
*'''Friendship''' - must also specify the '''character''' and '''friendshipLevel''' parameters
*'''Friendship''' - Items that are rewarded for reaching Friendship Levels. Must also specify the '''character''', '''friendshipLevel''', and '''recipePrice''' parameters
Friendship, Blueprint Table
*'''Friendship, Blueprint Table''' - (Donald Friendship Rewards) must also specify the '''character''' and '''friendshipLevel''' parameters
*'''Crafted for Quest''' - Crafted during a quest and not available prior to the quest. Must also specify the '''questName''', '''questRealm''' (if applicable), '''character''', and '''friendshipLevel''' (if applicable) parameters.
*'''Crafted for Quest''' - Crafted during a quest and not available prior to the quest. Must also specify the '''questName''', '''questRealm''' (if applicable), '''character''', and '''friendshipLevel''' (if applicable) parameters.
*'''Quest, Crafting''' - Will be crafted during a Quest, but can also be crafted prior to and independently of the quest. Must also specify the '''questName''', '''questRealm''' (if applicable), '''character''', and '''friendshipLevel''' (if applicable) parameters. Provide '''rewardContainer''' (if relevant). Should also specify '''questStage''', if not, generic language is used.
*'''Quest, Crafting''' - Will be crafted during a Quest, but can also be crafted prior to and independently of the quest. This is intended for use for resource-intensive items, such as the Rustic Clock Tower or Blue and Silver Balloon Arch. Must also specify the '''questName''', '''questRealm''' (if applicable), '''character''', and '''friendshipLevel''' (if applicable) parameters. Provide '''rewardContainer''' (if relevant). Should also specify '''questStage''', if not, generic language is used.
*'''Quest''' - must also specify the '''questName''', '''questRealm''' (if applicable), '''character''', and '''friendshipLevel''' (if applicable)  parameters. Should also specify '''questStage''', if not, generic language is used.
*'''Quest''' - must also specify the '''questName''', '''questRealm''' (if applicable), '''character''', and '''friendshipLevel''' (if applicable)  parameters. Should also specify '''questStage''', if not, generic language is used.
*'''Scrooge's Store'''
*'''Scrooge's Store'''
Line 66: Line 69:
*'''The Wonder of Pixar Star Path'''
*'''The Wonder of Pixar Star Path'''


===questName===


====questName====


===questRealm===


====questRealm====


 
===character===
====character====
Used both for quests, and for friendship rewards
Used both for quests, and for friendship rewards




====friendshipLevel====
===friendshipLevel===
Used both for quests, and for friendship rewards
Used both for quests, and for friendship rewards




====questStage====
===questStage===
Possible Values:
Possible Values:
*'''during'''
*'''during'''
Line 87: Line 89:




====tier====
===tier===
Same values as used for '''''[[Template:Infobox/doc#tier|Infobox]]'''''




====premium====
===premium===
Same values as used for '''''[[Template:Infobox/doc#premium|Infobox]]'''''




====eventTokens====
===eventTokens===
Same values as used for '''''[[Template:Infobox/doc#eventTokens|Infobox]]'''''




====clothingCollection====
===clothingCollection===
Possible Values: yes, no
'''clothingCollection''' specifies whether an item is tracked in the Clothing Sets tab on the Collection menu. There will be exactly one value: yes or no. If no value is provided, the Clothing Collection is not mentioned.
 
Possible Values: <code>yes</code>, <code>no</code>
 
 
===critterCollection===
Specifies whether an item is tracked on the Critters tab on the Collection menu. There will be exactly one value: yes or no. If no value is provided, the Critter Collection is not mentioned.


'''Possible Values:''' yes, no


====critterCollection====
Possible Values: yes, no


===craftingCollection===
Specifies whether an item is tracked on the Crafting tab on the Collection menu. There will be exactly one value: yes or no. If no value is provided, the Crafting Collection is not mentioned.


====craftingCollection====
Possible Values: yes, no
Possible Values: yes, no




====furnitureCollection====
===furnitureCollection===
Specifies whether an item is tracked on the Furniture Sets tab on the Collection menu. There will be exactly one value: yes or no. If no value is provided, the Furniture Collection is not mentioned.
 
Possible Values: yes, no
Possible Values: yes, no




====placement====
===placement===
Same values as used for '''''[[Template:Infobox/doc#placement|Infobox]]'''''
Same values as used for '''''[[Template:Infobox/doc#placement|Infobox]]'''''




====environment====
===environment===
Same values as used for '''''[[Template:Infobox/doc#environment|Infobox]]'''''
Same values as used for '''''[[Template:Infobox/doc#environment|Infobox]]'''''




====functions====
===functions===
Same values as used for '''''[[Template:Infobox/doc#functions|Infobox]]'''''
'''functions''' specifies if the item has any functionality, interactive or otherwise, once placed in the game world. If defined, a brief clause or word alluding to the functionality will be added to the first line of the description, and a short description of the functionality will be added to the third paragraph of the description. <!--TODO: If value=none...-->


Possible Values: see values for '''''[[Template:Infobox/doc#functions|Infobox]]'''''


====note====


===note===


==Example ItemDescriptions==
==Example ItemDescriptions==
Line 149: Line 163:
|clothingCollection=yes
|clothingCollection=yes
}}
}}


===Companion===
===Companion===
Line 167: Line 182:
|critterCollection=no
|critterCollection=no
}}
}}


===Crafted Furniture===
===Crafted Furniture===
Line 191: Line 207:
|functions=Lighting
|functions=Lighting
}}
}}


===Dream Style - Character===
===Dream Style - Character===
Line 215: Line 232:
|eventTokens=50
|eventTokens=50
}}
}}


===Dream Style - House===
===Dream Style - House===
Line 222: Line 240:
|type=House Dream Style
|type=House Dream Style
|from=Premium Shop
|from=Premium Shop
|bundleName=Purple Cottage
|bundleName=Purple Cottage (Bundle){{!}}Purple Cottage
|bundlePrice=3000
|bundlePrice=3000
}}
}}
Line 230: Line 248:
|type=House Dream Style
|type=House Dream Style
|from=Premium Shop
|from=Premium Shop
|bundleName=Purple Cottage
|bundleName=Purple Cottage (Bundle){{!}}Purple Cottage
|bundlePrice=3000
|bundlePrice=3000
}}
}}
Line 256: Line 274:
}}
}}


===Furniture===
 
===Furniture - Full Template===
<pre>
<pre>
{{ItemDescription
{{ItemDescription
Line 287: Line 306:
</pre>
</pre>


===Furniture - Friendship Reward===
<pre>
<pre>
{{ItemDescription
{{ItemDescription
|Enchanted Cage Lanterns
|Snowgies Plushie
|type=Furniture
|type=Furniture
|universe=Cinderella
|universe=Frozen
|from=Friendship
|from=Friendship
|character=The Fairy Godmother
|character=Olaf
|friendshipLevel=8
|friendshipLevel=5
|furnitureCollection=yes
|furnitureCollection=yes
|placement=default
|placement=surfaces
|functions=Lighting, Arch
}}
}}
</pre>
</pre>
{{ItemDescription
{{ItemDescription
|Enchanted Cage Lanterns
|Snowgies Plushie
|type=Furniture
|type=Furniture
|universe=Cinderella
|universe=Frozen
|from=Friendship
|from=Friendship
|character=The Fairy Godmother
|character=Olaf
|friendshipLevel=8
|friendshipLevel=5
|furnitureCollection=yes
|furnitureCollection=yes
|placement=default
|placement=surfaces
|functions=Lighting, Arch
}}
}}


===Furniture - Quest Reward===
<pre>
<pre>
{{ItemDescription
{{ItemDescription
Line 344: Line 365:
|note=The ability to purchase this from [[Scrooge's Store|Scrooge's Catalog]] after unlocking it was removed in update [[Version History/Update 2|1.2]]. Since that update it can still be purchased from [[Scrooge's Store|Scrooge's Catalog]] for {{price|1}} [[Star Coins|Star Coins]], but only if the Player is "Hanging Out" with [[Scar]] while shopping.
|note=The ability to purchase this from [[Scrooge's Store|Scrooge's Catalog]] after unlocking it was removed in update [[Version History/Update 2|1.2]]. Since that update it can still be purchased from [[Scrooge's Store|Scrooge's Catalog]] for {{price|1}} [[Star Coins|Star Coins]], but only if the Player is "Hanging Out" with [[Scar]] while shopping.
}}
}}


===Temporary Quest Furniture===
===Temporary Quest Furniture===
moderator
27,068

edits