Template:ItemDescription: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(line break adjustments seemed to break h2 and h3 sizes for acquisition, use, notes - changed to html tags for now. tweaked documentation, but left commented out. uncommented warning that template is under construction.) |
||
| Line 152: | Line 152: | ||
|Disney Parks Star Path={{price|{{{eventTokens|}}}|parkstoken}} '''Parks tokens''' | |Disney Parks Star Path={{price|{{{eventTokens|}}}|parkstoken}} '''Parks tokens''' | ||
|#default=}} from the Tier {{{tier|}}} {{#ifeq:{{{premium|}}}|yes|Premium|}} Rewards. | |#default=}} from the Tier {{{tier|}}} {{#ifeq:{{{premium|}}}|yes|Premium|}} Rewards. | ||
| | |Wonder of Pixar Star Path=It is available to unlock and collect for a limited time during the [[{{{from|}}}]] event using {{price|{{{eventTokens|}}}|XXXXX}} '''event tokens''' from the Tier {{{tier|}}} {{#ifeq:{{{premium|}}}|yes|Premium|}} Rewards. | ||
|#default=The source of this item is: {{{from|}}} }}<!--/from--><!--TODO: extra line break here IFF clothingCollection OR furnitureCollection OR craftingCollection OR critterCollection--> {{#switch:{{{clothingCollection|}}} | |#default=The source of this item is: {{{from|}}} }}<!--/from--><!--TODO: extra line break here IFF clothingCollection OR furnitureCollection OR craftingCollection OR critterCollection--> {{#switch:{{{clothingCollection|}}} | ||
|yes=Once collected it is added to the '''Clothing Set Collection'''. | |yes=Once collected it is added to the '''Clothing Set Collection'''. | ||
| Line 170: | Line 170: | ||
|Character Customization=It can be equipped using the '''Wardrobe''' tab inside the Inventory, under the Customize section. | |Character Customization=It can be equipped using the '''Wardrobe''' tab inside the Inventory, under the Customize section. | ||
|Clothing=It can be equipped using the '''Wardrobe''' tab inside the Inventory. | |Clothing=It can be equipped using the '''Wardrobe''' tab inside the Inventory. | ||
|Companion=It can be equipped using the '''Wardrobe''' tab inside the Inventory. | |Companion=It can be equipped using the '''Wardrobe''' tab inside the Inventory, under the '''Companions''' category. | ||
|Character Dream Style=It can be applied from the [[Characters]] tab of the [[Collections]] menu. | |Character Dream Style=It can be applied from the [[Characters]] tab of the [[Collections]] menu. | ||
|House Dream Style=It can be applied using furniture placement mode by picking up the [[Player's House]], which enables an option to '''Replace''', and then choose a replacement House Dream Style. The Player's House must be fully upgraded to change its Dream Style. | |House Dream Style=It can be applied using furniture placement mode by picking up the [[Player's House]], which enables an option to '''Replace''', and then choose a replacement House Dream Style. The Player's House must be fully upgraded to change its Dream Style. | ||
| Line 186: | Line 186: | ||
|bare=. It must be placed on bare ground | |bare=. It must be placed on bare ground | ||
|#default=}}.<!--/placement--><!--TODO: fix this logic--> | |#default=}}.<!--/placement--><!--TODO: fix this logic--> | ||
|#default=}}<!--/type-->{{#if:{{{functions|}}}| Once it is placed in the world, {{#switch:{{{functions|}}} | |#default=}}<!--/type--> {{#if:{{{functions|}}}| Once it is placed in the world, {{#switch:{{{functions|}}} | ||
|Attraction=the Player can '''Interact''' with the object to toggle the movement of the attraction. | |Attraction=the Player can '''Interact''' with the object to toggle the movement of the attraction. | ||
|Bed=the Player can '''Lounge''' on the object. | |Bed=the Player can '''Lounge''' on the object. | ||
| Line 208: | Line 208: | ||
|#default=the Player can interact with the object. | |#default=the Player can interact with the object. | ||
}}|}}<!--/functions-->{{#if:{{{note|}}}| | }}|}}<!--/functions-->{{#if:{{{note|}}}| | ||
<h3>Note</h3> | |||
{{{note|}}}|}}<!--/note-->{{#ifeq:{{{from|}}}|Quest| | {{{note|}}}|}}<!--/note-->{{#ifeq:{{{from|}}}|Quest| | ||
{{#ifeq:{{{questStage|}}}|reward|| | {{#ifeq:{{{questStage|}}}|reward|| | ||
<h2>Acquisition</h2> | |||
:{{quest|{{{questName|}}}}} - {{{acquisition|}}} | :{{quest|{{{questName|}}}}} - {{{acquisition|}}} | ||
| Line 225: | Line 225: | ||
* verify placement/environment/functions consistent with new usage | * verify placement/environment/functions consistent with new usage | ||
*improve language for surface area/table language | *improve language for surface area/table language | ||
*language for default item and "adding" to collection | |||
*unlock and collect language for premium critter on star path page 1? | |||
<!--*change category param for clothing to functions?--> | <!--*change category param for clothing to functions?--> | ||
<!--[[Category:Storage Container]]--> | <!--[[Category:Storage Container]]--> | ||
<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== | ==Description== | ||
This template generates a text description using key properties of an item. | This template generates a text description using key properties of an item. | ||
==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 | 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. | ||
| Line 242: | Line 243: | ||
'''type''' specifies... | '''type''' specifies... | ||
Possible Values: Character Customization | Possible Values: | ||
*Character Customization | |||
*Clothing | |||
*Companion | |||
*Crafted Furniture | |||
*Furniture | |||
*Character Dream Style | |||
*House Dream Style | |||
*Temporary Quest Furniture | |||
====universe==== | ====universe==== | ||
'''universe''' specifies... | |||
| Line 253: | Line 263: | ||
|from= | |from= | ||
</pre> | </pre> | ||
'''from''' specifies how the item is obtained. | '''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: | Possible Values: | ||
| Line 264: | Line 274: | ||
*'''Level''' - must also specify the '''playerLevel''' parameter | *'''Level''' - must also specify the '''playerLevel''' parameter | ||
*'''Friendship''' - must also specify the '''character''' and '''friendshipLevel''' parameters | *'''Friendship''' - must also specify the '''character''' and '''friendshipLevel''' parameters | ||
*'''Quest''' - must also specify the ''' | *'''Quest''' - must also specify the '''questName''', '''questRealm''' (if applicable), '''questCharacter''', and '''friendshipLevel''' (if applicable) parameters. Should also specify '''questStage''', if not, generic language is used. | ||
*'''Quest, Crafting''' - must also specify the ''' | *'''Quest, Crafting''' - must also specify the '''questName''', '''questRealm''' (if applicable), '''questCharacter''', and '''friendshipLevel''' (if applicable) parameters. Provide '''rewardContainer''' (if relevant). Should also specify '''questStage''', if not, generic language is used. | ||
*'''Scrooge's Store''' | *'''Scrooge's Store''' | ||
*'''Furniture Pouch''' | *'''Furniture Pouch''' | ||
| Line 282: | Line 292: | ||
====questName==== | ====questName==== | ||
====questRealm==== | |||
| Line 291: | Line 304: | ||
====questStage==== | ====questStage==== | ||
during | Possible Values: | ||
*during | |||
*reward | |||
====tier==== | ====tier==== | ||
====premium==== | ====premium==== | ||
====eventTokens==== | ====eventTokens==== | ||
====clothingCollection==== | ====clothingCollection==== | ||
Possible Values: yes, no | |||
====critterCollection==== | ====critterCollection==== | ||
Possible Values: yes, no | |||
====craftingCollection==== | ====craftingCollection==== | ||
Possible Values: yes, no | |||
====furnitureCollection==== | ====furnitureCollection==== | ||
Possible Values: yes, no | |||
| Line 358: | Line 375: | ||
==Clothing== | ==Clothing== | ||
<!-- | |||
<h4>TODO - language for default item and "adding" to collection - Clothing / Universe: param not provided / Permanent / Source: Default (Equipped) / Collection: Clothing </h4> | <h4>TODO - language for default item and "adding" to collection - Clothing / Universe: param not provided / Permanent / Source: Default (Equipped) / Collection: Clothing </h4> | ||
{{ItemDescription | {{ItemDescription | ||
| Line 366: | Line 384: | ||
|clothingCollection=yes | |clothingCollection=yes | ||
}} | }} | ||
--> | |||
<!-- | <!-- | ||
<h4>Clothing / Empty universe param / Permanent / Source: Scrooge / Functionality: Coat / Collection: empty clothingCollection param</h4> | <h4>Clothing / Empty universe param / Permanent / Source: Scrooge / Functionality: Coat / Collection: empty clothingCollection param</h4> | ||
| Line 1,097: | Line 1,115: | ||
==Companions== | ==Companions== | ||
<!-- | |||
<h4>TODO - weird collection wording - Companion / Universe: no param / Premium Limited Time / Source: Star Path - Premium / Collection: NOT critters </h4> | <h4>TODO - weird collection wording - Companion / Universe: no param / Premium Limited Time / Source: Star Path - Premium / Collection: NOT critters </h4> | ||
{{ItemDescription | {{ItemDescription | ||
| Line 1,109: | Line 1,128: | ||
|critterCollection=no | |critterCollection=no | ||
}} | }} | ||
--> | |||
<!-- | <!-- | ||
| Line 1,285: | Line 1,305: | ||
}} | }} | ||
</pre> | </pre> | ||
<pre> | |||
{{ItemDescription | |||
|Volcanic Stove | |||
|type=Furniture | |||
|universe=The Lion King | |||
|from=Quest | |||
|questName=The Making of a Monarch | |||
|questCharacter=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 | |||
|questCharacter=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. | |||
}} | |||
Revision as of 16:50, 2 June 2023
TODOs
- fix extra spacing when no collection param provided - temporary quest furniture, dream styles too? - avoided for now
- verify placement/environment/functions consistent with new usage
- improve language for surface area/table language
- language for default item and "adding" to collection
- unlock and collect language for premium critter on star path page 1?
This template is currently still being developed and not yet confirmed for widespread wiki usage.
Examples
Character Houses
Clothing
Crafted Furniture
Permanent Furniture
Limited Time, Premium Items
Untracked Quest Furniture
Companions
Companion
{{ItemDescription
|Celestial Sea Turtle
|type=Companion
|critterType=Sea Turtle
|from=Founder's Pack: Deluxe Edition
|environment=outdooronly
|critterCollection=no
}}
Celestial Sea Turtle is a Sea Turtle Companion.
It is available to players who purchase the Founder's Pack: Deluxe Edition or Founder's Pack: Ultimate Edition. It is not tracked in the Critter Collection.
It can be equipped using the Wardrobe tab inside the Inventory, under the Companions category.
Crafted Furniture
{{ItemDescription
|Wooden Lamppost with Blue Light
|type=Crafted Furniture
|craftingcategory=Furniture
|universe=Other
|from=Crafting
|craftingCollection=yes
|furnitureCollection=yes
|functions=Lighting (Controllable)
}}
Wooden Lamppost with Blue Light is a non-themed piece of lighting craftable furniture.
It can be crafted and collected using a Crafting Station. Once collected it is added to both the Crafting Collection and the Furniture Set Collection.
It can be positioned and placed using furniture placement mode. Once it is placed in the world, the Player can Interact with the object to toggle the light on and off.
Dream Style - Character
{{ItemDescription
|Ranger Donald
|type=Character Dream Style
|character=Donald Duck
|universe=Mickey & Friends
|from=Disney Parks Star Path
|tier=5
|premium=yes
|eventTokens=50
}}
Ranger Donald is a Character Dream Style that can be applied to the Mickey & Friends Character Donald Duck.
It was available to unlock and collect for a limited time during the Disney Parks Star Path event using 
50 Parks tokens from the Tier 5 Premium Rewards.
It can be applied from the Characters tab of the Collections menu.
Dream Style - House
{{ItemDescription
|Purple Cottage
|type=House Dream Style
|from=Premium Shop
|bundleName=Purple Cottage
|bundlePrice=3000
}}
Purple Cottage is a House Dream Style that can be applied to the Player's House.
It is available to purchase in the Purple Cottage bundle from the Premium Shop for 
3,000 Moonstones.
It can be applied using furniture placement mode by picking up the Player's House, which enables an option to Replace, and then choose a replacement House Dream Style. The Player's House must be fully upgraded to change its Dream Style.
Furniture
{{ItemDescription
|<<NAME>>
|type=Furniture
|craftingcategory=
|universe=
|from=
|tier=
|premium=<<yes, no>>
|eventTokens=
|bundleName=
|bundlePrice=
|questName=
|questCharacter=
|friendshipLevel=
|questStage=<<during, reward>>
|acquisition=
|use=
|placement=
|environment=
|disappears=<<yes, no>>
|craftingCollection=<<yes, no>>
|furnitureCollection=<<yes, no>>
|canReorder=<<no>>if not defined, assumed value of yes
|functions=
|note=
}}
{{ItemDescription
|Volcanic Stove
|type=Furniture
|universe=The Lion King
|from=Quest
|questName=The Making of a Monarch
|questCharacter=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.
}}
Volcanic Stove is a The Lion King themed piece of Cooking Station Furniture.
It is obtained as a reward from the Scar Friendship Level 10 quest 
The Making of a Monarch. Once collected it is added to the Furniture Set Collection.
It can be positioned and placed using furniture placement mode. Once it is placed in the world, the Player can Use the object to prepare cooked Meals.
Note
The ability to purchase this from Scrooge's Catalog after unlocking it was removed in update 1.2. Since that update it can still be purchased from Scrooge's Catalog for 
1 Star Coins, but only if the Player is "Hanging Out" with Scar while shopping.