Template:Variant

Documentation

[purge]

Template:Variant creates an infobox and main body of information for cosmetic item pages.

Uses templates

In addition to the code found here, this template relies on the following templates:

• {{infobox variant}} — The infobox.
• {{variant/gallery}} — Gallery for Trophies.
• {{filter shop}} — Filters valid shorthand for shop names into the desired, capitalized display names.
• {{variant/filter promobundlelist}} — Filters "promobundle" into a bullet list (Supports multiple bundle/packs).
• {{variant/filter events}} — Filters (most) legacy Bilge Rat Adventures & Campaigns to display appropriate requirements.

Parameters

Basic data

Parameter	Example values	Notes
type	pistol, bucket	Indicates generic parent item.
pet	Capuchin	Defines Pet type for Pet Outfits
default	Yes (single value)	Indicates whether the item is provided to players by default as part of their initial inventory. Omit this value if otherwise.
shop	Shipwright's Shop, Weaponsmith's Shop	Indicates the shop of purchase. Some keywords redirect to proper names. (See template code for details)
source	Twitch Drops	Indicates non-shop sources of earning an item. Multiple sources are accepted if separated by a comma. Source type examples: Season Six, Log-in bonus, Twitch Drops, Jewels of the Deep, SoTShot Contest
cost	1000000	Gold cost of item (including 0 gold if specified by shop).
cost-d	10	Doubloon cost of item (including 0 doubloons if specified by shop).
cost-a	123	Ancient Coin cost of item (including 0 ancient gold if specified by shop).
cost-irl	5.99	Real currency cost of item, indicated in US Dollars without currency symbol.
free	yes (single value)	Indicate Yes if the item can only be obtained directly at no cost and not through a shop or game code.
timelimited	Yes	Indicate Yes if the items is time-limited.
shop-history	* January 20 - February 10, 2022 ([[2.4.1]])	Bullet list "timeline" for any recurring time-limited shop items such as Seasonal exclusives. Should include a patch or Content Update in parenthesis for additional reference.
set	Sailor	Defines Cosmetic Set
description	Lovely money!	Indicates in-game description, "renders in italics within quotation marks."
emote	Lamp Juggling Emote	Indicates integrated Costume Emote.

Requirement data

Parameter	Example values	Notes
hoarder-level	50	Indicates required Reputation level in Gold Hoarders.
merchant-level	50	Indicates required Reputation level in Merchant Alliance.
souls-level	50	Indicates required Reputation level in Order of Souls.
hunter-level	50	Indicates required Reputation level in The Hunter's Call.
seadog-level	50	Indicates required Reputation level in Sea Dogs.
athena-level	10	Indicates required Reputation level in Athena's Fortune.
legendary	yes	Indicates Pirate Legend requirement.
faction	Guardians of Fortune	Indicated Faction item is associated with.
allegiance	50	Allegiance level required to purchase item.
promo	Merchant Bosun	Indicates required Promotion for availability.
title	Legendary Cargo Runner	Indicates required Title for availability.
title2	Collector of Legendary Black Powder	Indicates any second required Title for availability.
commendation	The Festival Party Boat	Indicates required Commendation for availability.
comm-grade	3	Indicates any required Commendation Grade for availability. If left blank and a Commendation is defined, comm-grade will default to 5.
milestone	Days at Sea	Indicates required Milestone for availability.
alignment	The Feared	Indicates required Alignment for availability.
class	17	Indicates required Class of Milestone or Alignment for availability. Not used for Trophies.
class1	1	Indicates required Class for availability of an admired Trophy. If not entered, this will default to 10.
class2	2	Indicates required Class for availability of a prized Trophy. If not entered, this will default to 20.
class3	3	Indicates required Class for availability of a treasured Trophy. If not entered, this will default to 50.
class4	5	Indicates required Class for availability of a cherished Trophy. If not entered, this will default to 100.
requires	Requires your soul.	Extra requirement to obtain a cosmetic, this is listed in a bullet point. Season, Insider, and Emissary rewards are automated by other parameters listed below.
insider-week	10	Indicates the week that an Insider Programme reward becomes available to earn.
ledger-tier	1	Indicates Emissary Ledger placement tier. 1 for first tier, 2 for second tier placement.
ledger-level	6	Sets the required number of times to have reached a tier for the Emissary Ledger reward.
season	Six	Season number as text.
season-level	10	Season level.
seasononly	yes	Used for Season exclusive items that are part of a bundles. Not for use with bundles that are sold in the Pirate Emporium or other shops.
event	Mercenary Voyages (Part 4)	Indicates the Bilge Rat Adventure that accompanied the sale period.
key	yes (single value)	Indicates whether the item can only be obtained after redeeming a game code.
bundle	Lodestar Weapon Bundle	Indicates whether the item can be acquired from a bundle.
bundleonly	Lodestar Costume Set	Indicates whether the item can only be acquired from a bundle.
essentialbundle	Lodestar Essential Ship Bundle	Indicates whether the item is included in an "Essential" bundle.
bigbundle	Lodestar Big Bundle	Indicates whether the item is included in a "Big" bundle.
promobundle	Gilded Phoenix Weapon Set	Indicates whether the item is included in a promotional bundle.

Template

{{Variant
| type =
| default =
| shop =
| source = 
| region =
| cost =
| cost-d =
| cost-a = 
| cost-irl = 
| promo =
| title =
| title2 =
| commendation =
| milestone =
| alignment =
| class =
| class1 =
| class2 =
| class3 =
| class4 =
| hoarder-level =
| merchant-level =
| souls-level =
| hunter-level =
| seadog-level =
| athena-level =
| legendary =
| faction = 
| allegiance = 
| insider-week =
| ledger-tier =
| ledger-level =
| season = 
| season-level =
| requires =
| description =
| event =
| key =
| free =
| bundle =
| bundleonly =
| essentialbundle =
| bigbundle =
| promobundle =
| set =
| pet =
| emote = 
}}

The above documentation is transcluded from Template:Variant/doc. (edit | history)

This template defines the table "Variants". View table.