Template:Cosmetic: Difference between revisions

Revision as of 10:08, 15 March 2025

Creates an infobox and various standard sentences for Cosmetics pages.

Template parameters[Edit template data]
Parameter		Description	Type	Status
name	`name`	The name of the cosmetic Example Frog Friend	String	required
image	`image`	The (animated) image of the cosmetic, if the file is not found at File:{{{name}}}.png	File	optional
rarity2	`rarity2`	The (special) rarity of the cosmetic Suggested values `seasonal` `limited`	String	optional
added_in	`added_in`	The patch version the cosmetic was added Example 0.8.0	String	required
unlock_hint	`unlock_hint`	The in-game string for how this cosmetic is obtained. Not required if legacy cosmetic	String	suggested
scavenge_cosmetic	`scavenge_cosmetic`	Is the cosmetic token scavengeable?	Boolean	suggested
scavenge_blueprint	`scavenge_blueprint`	Is the blueprint scavengeable?	Boolean	suggested
legacy	`legacy`	Whether the cosmetic is obtained from the Legacy Machine. Overrides unlock_hint. Suggested values `yes`	String	optional
unlock_method	`unlock_method`	Sentences to be used to explain the unlocking method of the cosmetic	String	required
crafting_materials	`crafting_materials`	The required crafting materials for the cosmetic's blueprint, if it has one. Use a break tag between each material.	String	optional

@@ Line 84: / Line 84: @@
 	</group>
 	<group>
-		<header><center>Obtaining</center></header>
+		<header><center>Unlock Hint</center></header>
-		<data source="obtaining">
+		<data source="unlock_hint">
-			<format><center>{{{obtaining}}}</center></format>
+			<format>{{#if: {{{legacy|}}}||<center>{{{unlock_hint}}}}}</center></format>
+		</data>
+		<data source="legacy">
+			<format><center>This cosmetic is from a past event or season, so is now obtained from the [[Legacy Cosmetic Machine]].</center></format>
 		</data>
 	</group>
@@ Line 142: / Line 145: @@
 </infobox>
 {{#if:{{#iferror:{{#invoke:CosmeticDescription|getDescription|name={{{name}}}}}|}}|<blockquote>{{#invoke:CosmeticDescription|getDescription|name={{{name}}}}}</blockquote>}}
-'''{{{name}}}''' is a {{Rarity|{{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}|Text}}{{#if:{{{rarity2}}}| and {{Rarity|{{{rarity2}}}|Text}}}} {{Type|{{#invoke:CosmeticInfo|getType|name={{{name}}}}}}} [[cosmetic]], found within the {{Collection|{{#invoke:CosmeticInfo|getCollection|name={{{name}}}}}}}, that was introduced in [[Patch {{{added_in}}}]]. {{{unlock_method}}}{{#if:{{{colorable}}}|<br /><br />It is {{Colorable}}, meaning players can apply [[Chroma Pack|chroma packs]] to it, allowing them to change its colour.<br /><br />Owning it rewards the player with a total of {{Style Trophy|{{#expr:{{#invoke:CosmeticInfo|getTrophiesAwarded|name={{{name}}}}}+10}}|text = yes}} - {{Style Trophy|{{#invoke:CosmeticInfo|getTrophiesAwarded|name={{{name}}}}}}} for owning it and an extra {{Style Trophy|10}} if all 4 [[Chroma Pack|chroma packs]] are applied to it.|
+'''{{{name}}}''' is a {{Rarity|{{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}|Text}}{{#if:{{{rarity2}}}| and {{Rarity|{{{rarity2}}}|Text}}}} {{Type|{{#invoke:CosmeticInfo|getType|name={{{name}}}}}}} [[cosmetic]], found within the {{Collection|{{#invoke:CosmeticInfo|getCollection|name={{{name}}}}}}}, that was introduced in [[Patch {{{added_in}}}]]. {{{unlock_method}}}{{#if:{{#invoke:CosmeticInfo|isColorable|name={{{name}}}}}|<br /><br />It is {{Colorable}}, meaning players can apply [[Chroma Pack|chroma packs]] to it, allowing them to change its colour.<br /><br />Owning it rewards the player with a total of {{Style Trophy|{{#expr:{{#invoke:CosmeticInfo|getTrophiesAwarded|name={{{name}}}}}+10}}|text = yes}} - {{Style Trophy|{{#invoke:CosmeticInfo|getTrophiesAwarded|name={{{name}}}}}}} for owning it and an extra {{Style Trophy|10}} if all 4 [[Chroma Pack|chroma packs]] are applied to it.|
 It rewards the player with a total of {{Style Trophy|{{#invoke:CosmeticInfo|getTrophiesAwarded|name={{{name}}}}}|text = yes}}.}}{{#if:{{{scavenge_cosmetic}}}|<br /><br />Its token form can be scavenged for {{Silver|{{#switch: {{lc:{{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}}}<!--
      -->| common = 200<!--
@@ Line 149: / Line 152: @@
      -->| epic = 3,750<!--
      -->| legendary = 6,250<!--
-     -->| mythic = 18,000}}}} and {{Royal Reputation|{{#switch: {{lc:{{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}}}<!--
+     -->| mythic = 18,000}}}} [[Silver]] and {{Royal Reputation|{{#switch: {{lc:{{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}}}<!--
      -->| common = 1<!--
      -->| uncommon = 2<!--
@@ Line 155: / Line 158: @@
      -->| epic = 5<!--
      -->| legendary = 7<!--
-     -->| mythic = 10}}}} in the [[Scavenger's Hideout]].}}</includeonly><noinclude><templatedata>
+     -->| mythic = 10}}}} [[Royal Reputation]] in the [[Scavenger's Hideout]].}}
+==== Blueprint Recipe ====
+The blueprint form of the cosmetic must be crafted at the [[Blueprint Assembler]] into a cosmetic token before use. Alternatively, it can be scavenged for {{Silver|{{#switch: {{lc:{{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}}}<!--
+    -->| common = 50<!--
+    -->| uncommon = 150<!--
+    -->| rare = 300<!--
+    -->| epic = 850<!--
+    -->| legendary = 1,200<!--
+    -->| mythic = 3,500}}}} [[Silver]] in the [[Scavenger's Hideout]].
+{{Blueprint
+|item = {{#ifexist: File:{{{name}}}.png|[[File:{{{name}}}.png|25px]]|[[File:{{{image}}}|25px]]}} {{{name}}} Token
+|required_materials = {{{crafting_materials}}}
+|rarity = {{#invoke:CosmeticInfo|getRarity|name={{{name}}}}}
+|legacy = {{{legacy}}}
+}}
+</includeonly><noinclude><templatedata>
 {
 	"params": {
@@ Line 182: / Line 202: @@
 			"required": true
 		},
-		"obtaining": {
+		"unlock_hint": {
-			"description": "The in-game string for how this cosmetic is obtained",
+			"description": "The in-game string for how this cosmetic is obtained. Not required if legacy cosmetic",
 			"type": "string",
-			"required": true
+			"suggested": true
 		},
 		"scavenge_cosmetic": {
@@ Line 196: / Line 216: @@
 			"type": "boolean",
 			"suggested": true
+		},
+		"legacy": {
+			"description": "Whether the cosmetic is obtained from the Legacy Machine. Overrides unlock_hint.",
+			"type": "string",
+			"suggestedvalues": [
+				"yes"
+			]
+		},
+		"unlock_method": {
+			"description": "Sentences to be used to explain the unlocking method of the cosmetic",
+			"required": true,
+			"type": "string"
+		},
+		"crafting_materials": {
+			"description": "The required crafting materials for the cosmetic's blueprint, if it has one. Use a break tag between each material.",
+			"type": "string"
 		}
 	},
@@ Line 204: / Line 240: @@
 		"rarity2",
 		"added_in",
-		"obtaining",
+		"unlock_hint",
 		"scavenge_cosmetic",
-		"scavenge_blueprint"
+		"scavenge_blueprint",
+		"legacy",
+		"unlock_method",
+		"crafting_materials"
 	]
 }
 </templatedata>
 </noinclude>