Template:Emote infobox/doc

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

Usage

Use this infobox for defining emotes within the game.

{{Emote infobox
| name =
| icon = 
| image = 
| description = 
| type = 
| command = 
| can-use-while = 
| unlock-item = 
| patch =
| id-gt =
| online-store-id = 
| online-store-description1 = 
| online-store-description2 = 
}}

Parameters

name*

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

icon

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

image

Optional. Image of the emote.

description*

Optional. Verbatim from the game's emote.

type*

Required. The type the emote is placed under. Accepts general, special, expressions.

command*

Required. The slash command that evokes the emote in-game.

can-use-while*

Optional. All of the situations in which the emote can be used. Accepts: "standing", "swimming", "underwater", "lying down", "seated", "mounted", "umbrella", "wings", or "fishing".

unlock-item*

Optional. The item used to unlock the emote.

patch*

Optional. Patch this emote was released in.

id-gt*

Required. The internal ID of the emote.

The following parameters are handled by the {{online store description}} template:

online-store-id

Optional. If the item is sold on the Online Store, the number at the end of the url. For example, https://store.finalfantasyxiv.com/ffxivstore/en-us/product/2 would have an online-store-id of 2.

online-store-description1

Optional. The bold text under "Description" in the Online Store page of the item.

online-store-description2

Optional. The non-bold text under "Description" in the Online Store page of the item. Do not include additional text under "About This Item".

* These fields are based on data that is present in the raw game files, and should not be manually edited. Any inaccuracies should be reported to an admin.

Deprecated params

These values are now covered by the {{Obtainable parameter}} params. If we ever need these values individually, they can be queried from the associated pages.

activity

Optional. The name of the activity where the emote is unlocked.

event

Optional. The name of the event where the emote is unlocked.

quest

Optional. The name of the quest that unlocks the emote.

achievement

Optional. The name of the achievement that unlocks the emote.

purchased-from

Optional. How to purchase the emote

cost-type

Optional. The currency used to purchase the emote. Accepts: "gil", "mgp", "seals", "wolf marks", "kojin sango", "ananta dreamstaff", "namazu koban", "skybuilder scrip," "mythic clan mark logs", "usd"

cost

Optional. amount of the currency needed to purchase the emote.