Template:Obtainable parameter/doc

This is the documentation subpage of Template:Obtainable parameter. It contains usage information that is not part of the underlying template page.

Documentation

This template is intended for use on any pages where we want to track acquisition information, such as mounts, TT cards, bardings, etc. Currently it is only implemented on the Mount infobox, but we will be adding it to additional infoboxes.

{{Obtainable parameter
| source-type =
| obtain-by =
| obtainable =
| cash-shop =
}}

Parameters

The following parameters are set by {{Obtainable parameter}}. Note that these are not displayed on the pages; they are only used in semantic results lists. Be sure to test the formatting of any text in "obtain-by":

source-type

Optional. Primary activity/method required to obtain the item. (Secondary methods such as the cash shop may be explained in obtain-by.) Defaults to "Unknown". Sets Property:Has source type. Refer to the property page for allowed values.

obtain-by

Optional. More detailed summary on the requirements to obtain the item. Multiple requirements may be formatted as a bulleted list, i.e.:

obtain-by = * Do this thing to acquire the thing.
* This other thing works too.

Values may include wiki formatting, including templates. Sets Property:Is obtained by.

obtainable

Optional. Boolean. Whether or not an item is currently obtainable. Defaults to "true". Sets Property:Is obtainable.

cash-shop

Optional. Boolean. Whether or not an item is available for purchase in the online store. Defaults to "false". Sets Property:Is online store item.

Examples

| source-type = Trials
| obtain-by = * Random drop upon completion of {{questlink|trial|The Jade Stoa (Extreme)}}.
* Purchased from [[Eschina]] for 99 {{item icon|Byakko Totem}}s.
| obtainable = y
| cash-shop = n

Implemented On

{{Mount infobox}}