Template:Collection UI/doc

Overview
Collection UI is a template used to create a collection rewards UI.

Syntax
collection, goto (Optional)

Parameters

 * - The collection to use. This will be an unenchanted version of any input item. Accepts inputs like "Diamond".
 * The ID of the UI to go to when clicked. Use comma to separate this and the previous item.
 * - The rewards for the collection. Accepts a bullet list of collection tier requirements, and rewards (Maximum of 27 tiers). Level one of the list represents the collection tier requirements, followed by an optional go-to ID linking it to another UI to show the collection rewards, separated by a comma. Level 2 of the list represents the rewards for that collection tier, followed by an optional reward type, followed by an optional item rarity, all separated by commas. See below for examples.
 * Specifies the type of the reward (the grey trailing words in tooltip). For example, 'Trade', 'Coming Soon', ' Experience'. Default is 'Recipe(s)'. Set it to 'None' to not display a type. Use comma to separate this and the previous item.
 * The template will attempt to get the rarity of the item from Module:Inventory slot/Tooltips. The default rarity is . Use comma to separate this and the previous item.
 * - Whether to enclose (wrap) it with a . Default false.
 * - Whether to generate all children UIs of it. Default true.
 * The parameters, , and are the same as UI. See the documentation on those parameters for further info. (See here for further info)

List Syntax
The collection rewards use a bullet list syntax to make writing collection UI's alot easier. The list syntax has two parts to it:
 * The first level, which is the collection requirement, followed by an optional go-to ID, separated by a comma.
 * The second level, which is the collection rewards, followed by an optional reward type, followed by an optional reward rarity, all separeted by a comma.

Examples
For example, if you wanted to create a collection tier that required Diamonds, and rewarded Perfect Armor recipes, and linked to the rewards UI named perfect-rewards, you would use the following syntax:
 * 50k, perfect-rewards
 * Perfect Helmet - Tier I
 * Perfect Chestplate - Tier I
 * Perfect Leggings - Tier I
 * Perfect Boots - Tier I

An Example Collection
Note: This is a completely made-up example to show the usage of this template. This collection does not exist in-game.


 * Produces

Diamond Collection

 * Produces

Redstone Collection

 * Produces