Template:GameText

From Terraria Wiki
Jump to navigation Jump to search
This template is i18n-ready, which means it is easy to localize for different languages. Please see I18n & l10n for templates to learn more.
This template uses Lua.
This template uses Module:GameText, a script written in the Lua programming language. To learn more about Lua, see Terraria Wiki:Lua.
Template-info.svg Documentation The documentation below is transcluded from Template:GameText/doc. (edit | history)

This template is used to display text used in Terraria, exactly as in-game. Since the data is taken directly from the source code, the template facilitates automatic updates when a new patch is released. Therefore, it is the preferred choice when displaying game interface text in wiki articles.

Note: This template is relatively slow, so please use other database templates first, if possible.

Usage

{{ gameText | <index key> | lang = <lang> | x_<name> = <value> | ... | y_<name> = <value> | ... }}

First unnamed parameter

The index key for the text. It is the same as in the in-game language JSON files. See examples below.

To find the index key for a specific text, visit Template:GameText/table and use your browser's search function to locate the text. Note that some texts use placeholder values like {PlayerName}, so you can try to reduce your search if it doesn't succeed.

lang

Language code, defaults to {{lang}}. Currently, there are nine languages, as in-game: English (en), Spanish (es), Italian (it), Chinese (zh), German (de), Russian (ru), French (fr), Polish (pl), and Portuguese (pt). All other languages will use the English database.

All x_<name> and y_<name> parameters

Replacement for placeholders. There are two types of placeholder in the game texts: {xxx} and <yyy>, indexed by x_... and y_..., respectively. See examples below.

Notes

  • You can use {{#invoke:gameText|getRaw|{{{key|}}}}} to get a raw string from the GameText info database. It also takes lang and replacement arguments. This is mainly for use in other templates.
  • {{gameText}} will keep leading/trailing spaces.
  • {{gameText}} is roughly equal to <span class="gameText">{{nl2br| {{#invoke:gameText | getRaw |{{{key|}}}}} }}</span>, except for the latter will trim leading/trailing spaces.

Examples

Code Result
{{gameText|ItemName.IronPickaxe}} Iron Pickaxe
{{gameText|LegacyMultiplayer.21}} /players
x{{gameText|LegacyMenu.108}}x xZoom In x
{{gameText|ItemTooltip.BeeKeeper}} Summons killer bees after striking your foe
Small chance to cause confusion
{{gameText|UI.WorldSizeFormat}} {0} World
{{gameText|UI.WorldSizeFormat|x_0=Large}} Large World
{{gameText|UI.LightMode_Color}} Lighting: Color
{{gameText|LegacyDialog.19}} {PlayerName} is it? I've heard good things, friend!
{{gameText|LegacyDialog.19|x_PlayerName=myName}} myName is it? I've heard good things, friend!
{{gameText|Misc.ResolutionChanged}} Resolution changed to: {0}x{1}.
{{gameText|Misc.ResolutionChanged|x_1=768}} Resolution changed to: {0}x768.
{{gameText|Misc.ResolutionChanged|x_0=1024|x_1=768}} Resolution changed to: 1024x768.
{{gameText|ItemTooltip.GoodieBag}} <right> to open
{{gameText|ItemTooltip.GoodieBag|y_right=Right click}} Right click to open
{{gameText|ItemTooltip.GoodieBag|y_right={{key|open}}}} Open / Activate to open
{{gameText|ItemName.IronPickaxe|lang=es}} Pico de hierro
{{gameText|ItemName.IronPickaxe|lang=it}} Iron Pickaxe FAIL! (expected: Piccone di ferro)
{{gameText|ItemName.IronPickaxe|lang=de}} Iron Pickaxe FAIL! (expected: Eisenspitzhacke)
{{gameText|ItemName.IronPickaxe|lang=ru}} Iron Pickaxe FAIL! (expected: Железная кирка)


Data storage

The Lua database is comprised of the following modules:

Language Database Loader
Flag de.svg German: Module:GameText/db-de (clear cache) Module:GameText/loaddata-de
Flag us.svg English: Module:GameText/db-en (clear cache) Module:GameText/loaddata-en
Flag es.svg Spanish: Module:GameText/db-es (clear cache) Module:GameText/loaddata-es
Flag fr.svg French: Module:GameText/db-fr (clear cache) Module:GameText/loaddata-fr
Flag it.svg Italian: Module:GameText/db-it (clear cache) Module:GameText/loaddata-it
Flag pl.svg Polish: Module:GameText/db-pl (clear cache) Module:GameText/loaddata-pl
Flag pt.svg Portuguese: Module:GameText/db-pt (clear cache) Module:GameText/loaddata-pt
Flag ru.svg Russian: Module:GameText/db-ru (clear cache) Module:GameText/loaddata-ru
Flag ua.svg Ukrainian: Module:GameText/db-uk (clear cache) Module:GameText/loaddata-uk
Flag cn.svg Chinese: Module:GameText/db-zh (clear cache) Module:GameText/loaddata-zh