Locale.LookupLanguage (Civ5 API)

From Civilization Modding Wiki
Jump to navigationJump to search

This page is a part of the Lua and UI Reference (Civ5).


Function.png This function is a member of Locale.

This is a static method, invoke it with a dot.


Lookup a textkey using another language as the primary language


Usage

string Locale.LookupLanguage(string language, string key, ...)


Returned Value

Returns the textkey if it cannot be found in the dictionary, or a translated string.

Parameters

language: A valid language type.
key: A valid text key.
...: none or many arguments that are used when composing the final localized string.

Notes

This localized string may or may not be in the language specified. With support for fall-back language support, the localization system will attempt to search all available languages for the string.


Examples

local mainMenu = Locale.LookupLanguage("fr_FR", "TXT_KEY_MAIN_MENU");


Source code samples

Redundant occurences have been removed.

OptionsMenu.lua

UI/Options/OptionsMenu.lua
0239
Controls.CountdownMessage:SetText( Locale.LookupLanguage(g_Languages[g_chosenLanguage].Type, "TXT_KEY_OPSCREEN_LANGUAGE_TIMER") );
0242
Locale.LookupLanguage( g_Languages[g_chosenLanguage].Type, "TXT_KEY_YES_BUTTON"),
0247
Locale.LookupLanguage( g_Languages[g_chosenLanguage].Type, "TXT_KEY_NO_BUTTON"),



The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.