Template:Alternatives/doc

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search
This is the documentation subpage of Template:Alternatives. It contains usage information that is not part of the underlying template.
This template uses Lua:
{{alternatives|foo|bar|...}}

Displays phrases from in-game text which can vary depending on some conditions - for example, gendered or race-specific terms referring to the player character.

This template can also be used via the shortcut {{alt}}.

Parameters

This template accepts an arbitrary number of unnamed parameters, each of which is one possible phrase that could appear in the same position in the surrounding text.

{{alternatives|a|b|c|...}}

Conditions can also be set for each alternate phrase, which show when the phrase is hovered over. This is done with a named parameter conditionN for each parameter "N".

{{alternatives
| 1 = the Warden
| condition1 = If player's patron deity is Azeyma
| 2 = the Fury
| condition2 = If player's patron deity is Halone
| 3 = the Destroyer
| condition3 = If player's patron deity is Rhalgr
}}

There are also named parameters which can be used for common conditions such as player character race and gender:

{{alternatives|m=sir|f=madam}}

The supported names and their meanings are:

  • m: If the player character is male.
  • f: If the player character is female.
  • hyur: If player character is a Hyur.
  • elezen: If player character is an Elezen.
  • lalafell: If player character is a Lalafell.
  • miqote: If player character is a Miqo'te.
  • roegadyn: If player character is a Roegadyn.
  • aura: If player character is an Au Ra.
  • viera: If player character is a Viera.
  • hrothgar: If player character is a Hrothgar.
  • morning: If during morning Eorzea time.
  • day: If during daytime Eorzea time.
  • night: If during nighttime Eorzea time.
  • gridania: If the player character's starting city is Gridania.
  • limsa: If the player character's starting city is Limsa Lominsa.
  • uldah: If the player character's starting city is Ul'dah.

These different forms can be used together in a single call as necessary.