Template:Mount infobox/doc

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

Use this infobox for defining mounts within the game.

{{Mount infobox
| name =
| icon =
| image = 
| description =
| tooltip =
| summon = 
| movement =
| action =
| seats =
| music =
| orchestrion = 
| patch =
| release =
| source-type = 
| obtain-by = 
| obtainable = 
| cash-shop = 
| id-gt =
}}

Parameters

name

Optional. Name of the article. Defaults to {{PAGENAME}}.

icon

Optional. Mount icon. Defaults to File:{{PAGENAME}}.png

image

Optional. Mount image.

description

Optional. Verbatim from the game's Mount Guide. Include the flavor quote after two line breaks.

tooltip

Optional. Verbatim from the tooltip of the button you click to summon the mount, NOT TO BE CONFUSED WITH the tooltip of the item (horn, fife, key, etc) you use to add the mount to your collection - that goes in the page for said item.

summon

Optional. The name of the item that summons the mount (i.e. horn, fife).

movement

Optional. Accepts terrestrial or airborne.

action

Optional. Comma-separated list of mount actions usable while riding the mount.

two-seater

Optional. Whether the mount can hold two players. Defaults to no. Deprecated. Please use the seats parameter instead.

seats

Optional. Number of players the mount can seat at a time. Defaults to 1.

music

Optional. The music that plays when riding the mount.

orchestrion

Optional. Set anything to convert the music to its respective orchestrion roll.

patch

Optional. Patch this mount was released in.

release

Optional. Expansion this mount belongs to. Accepts heavensward or stormblood or shadowbringers or endwalker or dawntrail.

id-gt

Optional. Internal ID number from the game files. Used to link to external sites such as Garland Tools, Teamcraft, and Universalis.

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.