Template:ItemDescription: Difference between revisions

8,951 bytes removed ,  15:20, 11 July 2023
Move docs to separate page
(link other companion sources in intro line)
(Move docs to separate page)
Line 414: Line 414:
-->
-->


<span style="color: crimson; font-weight: bold; font-size: 20px;">This template is currently still being developed and not yet confirmed for widespread wiki usage.</span>


<!--
==Description==
This template generates a text description using key properties of an item. It structures all descriptions in the following format:
* What the item is (type, universe, short function description if relevant)
* 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.
==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.
====type====
'''type''' specifies...
Possible Values:
*'''Character Customization'''
*'''Clothing'''
*'''Companion'''
*'''Crafted Furniture'''
*'''Furniture'''
*'''Character Dream Style'''
*'''House Dream Style'''
*'''Tool Dream Style'''
*'''Temporary Quest Furniture'''
====universe====
'''universe''' specifies... uses '''''UniverseAnchorLink''''' template.....
====from====
'''from''' specifies how the item is obtained. Some values require additional values to also be provided in order to correctly generate a description.
Possible Values:
*'''Founder's Pack: Standard Edition'''
*'''Founder's Pack: Deluxe Edition'''
*'''Founder's Pack: Ultimate Edition'''
*'''Default, Crafting'''
*'''Default, Scrooge's Store'''
*'''Default (Equipped)'''
*'''Crafting'''
*'''Blueprint Table''' - must also specify the '''recipePrice''' parameter
*'''Pickup, Crafting''' - must also specify the '''found''' parameter
*'''Level''' - must also specify the '''playerLevel''' parameter
*'''Friendship''' - must also specify the '''character''' and '''friendshipLevel''' parameters
*'''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, Crafting''' - 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.
*'''Scrooge's Store'''
*'''Furniture Pouch'''
*'''Scrooge's Catalog, Scrooge's Store'''
*'''Green Reward Chest, Scrooge's Store''' - must also specify the '''found''' parameter
*'''Pickup, Scrooge's Store''' - must also specify the '''found''' parameter
*'''Pickup''' - must also specify the '''found''' parameter
*'''Village Task''' - must also specify '''taskLinkedName''' (with formatting, if relevant), and '''taskRequirements'''
*'''Premium Shop''' - must also specify the '''bundleName''' and '''bundlePrice''' parameters
*'''Pixar Fest Star Path'''
*'''Villains' Star Path'''
*'''Festive Star Path'''
*'''Centennial Star Path'''
*'''Disney Parks Star Path'''
*'''The Wonder of Pixar Star Path'''
====questName====
====questRealm====
====character====
Used both for quests, and for friendship rewards
====friendshipLevel====
Used both for quests, and for friendship rewards
====questStage====
Possible Values:
*'''during'''
*'''reward'''
====tier====
====premium====
====eventTokens====
====clothingCollection====
Possible Values: yes, no
====critterCollection====
Possible Values: yes, no
====craftingCollection====
Possible Values: yes, no
====furnitureCollection====
Possible Values: yes, no
====placement====
Same values as used for '''''[[Template:Infobox/doc#placement|Infobox]]'''''
====environment====
Same values as used for '''''[[Template:Infobox/doc#environment|Infobox]]'''''
====functions====
Same values as used for '''''[[Template:Infobox/doc#functions|Infobox]]'''''
====note====
-->




Line 690: Line 567:
-->
-->


<!--
{{{{FULLPAGENAME}}/doc}}


==Example ItemDescriptions==
===Clothing===
<pre>
{{ItemDescription
|Icy Blue Sweetheart Strapless Gown
|type=Clothing
|category=Dresses
|universe=Other
|from=Green Reward Chest, Scrooge's Store
|found=Scrooge's Store
|clothingCollection=yes
}}
</pre>
{{ItemDescription
|Icy Blue Sweetheart Strapless Gown
|type=Clothing
|category=Dresses
|universe=Other
|from=Green Reward Chest, Scrooge's Store
|found=Scrooge's Store
|clothingCollection=yes
}}
===Companion===
<pre>
{{ItemDescription
|Celestial Sea Turtle
|type=Companion
|critterType=Sea Turtle
|from=Founder's Pack: Deluxe Edition
|critterCollection=no
}}
</pre>
{{ItemDescription
|Celestial Sea Turtle
|type=Companion
|critterType=Sea Turtle
|from=Founder's Pack: Deluxe Edition
|critterCollection=no
}}
===Crafted Furniture===
<pre>
{{ItemDescription
|Wooden Lamppost with Blue Light
|type=Crafted Furniture
|craftingcategory=Furniture
|universe=Other
|from=Crafting
|craftingCollection=yes
|furnitureCollection=yes
|functions=Lighting
}}
</pre>
{{ItemDescription
|Wooden Lamppost with Blue Light
|type=Crafted Furniture
|craftingcategory=Furniture
|universe=Other
|from=Crafting
|craftingCollection=yes
|furnitureCollection=yes
|functions=Lighting
}}
===Dream Style - Character===
<pre>
{{ItemDescription
|Ranger Donald
|type=Character Dream Style
|character=Donald Duck
|universe=Mickey & Friends
|from=Disney Parks Star Path
|tier=5
|premium=yes
|eventTokens=50
}}
</pre>
{{ItemDescription
|Ranger Donald
|type=Character Dream Style
|character=Donald Duck
|universe=Mickey & Friends
|from=Disney Parks Star Path
|tier=5
|premium=yes
|eventTokens=50
}}
===Dream Style - House===
<pre>
{{ItemDescription
|Purple Cottage
|type=House Dream Style
|from=Premium Shop
|bundleName=Purple Cottage
|bundlePrice=3000
}}
</pre>
{{ItemDescription
|Purple Cottage
|type=House Dream Style
|from=Premium Shop
|bundleName=Purple Cottage
|bundlePrice=3000
}}
===Dream Style - Tool===
<pre>
{{ItemDescription
|Nefarious Fishing Rod
|type=Tool Dream Style
|tool=Fishing Pole
|from=Premium Shop
|bundleName=Nefarious Set
|bundlePrice=3750
|clothingCollection=no
}}
</pre>
{{ItemDescription
|Nefarious Fishing Rod
|type=Tool Dream Style
|tool=Fishing Pole
|from=Premium Shop
|bundleName=Nefarious Set
|bundlePrice=3750
|clothingCollection=no
}}
===Furniture===
<pre>
{{ItemDescription
|<<NAME>>
|type=Furniture
|craftingcategory=
|universe=
|from=
|tier=
|premium=<<yes, no>>
|eventTokens=
|bundleName=
|bundlePrice=
|questName=
|character=
|friendshipLevel=
|questStage=<<during, reward>>
|acquisition=
|use=
|disappears=<<yes, no>>
|craftingCollection=<<yes, no>>
|furnitureCollection=<<yes, no>>
|placement=
|environment=
|canReorder=<<no>>if not defined, assumed value of yes
|functions=
|customizable=<<yes>>
|note=
}}
</pre>
<pre>
{{ItemDescription
|Enchanted Cage Lanterns
|type=Furniture
|universe=Cinderella
|from=Friendship
|character=The Fairy Godmother
|friendshipLevel=8
|furnitureCollection=yes
|placement=default
|functions=Lighting, Arch
}}
</pre>
{{ItemDescription
|Enchanted Cage Lanterns
|type=Furniture
|universe=Cinderella
|from=Friendship
|character=The Fairy Godmother
|friendshipLevel=8
|furnitureCollection=yes
|placement=default
|functions=Lighting, Arch
}}
<pre>
{{ItemDescription
|Volcanic Stove
|type=Furniture
|universe=The Lion King
|from=Quest
|questName=The Making of a Monarch
|character=Scar
|friendshipLevel=10
|questStage=reward
|furnitureCollection=yes
|canReorder=no
|placement=
|functions=Cooking Station
|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.
}}
</pre>
{{ItemDescription
|Volcanic Stove
|type=Furniture
|universe=The Lion King
|from=Quest
|questName=The Making of a Monarch
|character=Scar
|friendshipLevel=10
|questStage=reward
|furnitureCollection=yes
|canReorder=no
|placement=
|functions=Cooking Station
|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===
<pre>
{{ItemDescription
|Space Ranger Buffet
|type=Temporary Quest Furniture
|from=Quest
|questName=The Definition of a Hero
|character=Buzz Lightyear
|friendshipLevel=10
|questStage=during
|acquisition=Given by [[Buzz Lightyear]]
|use=Place near [[Buzz's RV]]
|disappears=yes
}}
</pre>
{{ItemDescription
|Space Ranger Buffet
|type=Temporary Quest Furniture
|from=Quest
|questName=The Definition of a Hero
|character=Buzz Lightyear
|friendshipLevel=10
|questStage=during
|acquisition=Given by [[Buzz Lightyear]]
|use=Place near [[Buzz's RV]]
|disappears=yes
}}
{{{{FULLPAGENAME}}/doc}}
<!--


{{{{FULLPAGENAME}}/examples}}
{{{{FULLPAGENAME}}/examples}}
moderator
26,807

edits