Locale.HasTextKey (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.


Determine if a textkey can be found in the Localization System's string dictionary


Usage

bool Locale.HasTextKey(string textkey)


Returned Value

Returns true if found, false otherwise

Parameters

textkey: The key to look for in the dictionary.


Examples

local bFound = Locale.HasTextKey("TXT_KEY_MAIN_MENU");


Source code samples

Redundant occurences have been removed.

CivilopediaScreen.lua

UI/Civilopedia/CivilopediaScreen.lua
1814
return Locale.HasTextKey(tag);


LoadMenu.lua

UI/FrontEnd/LoadMenu.lua
0144
if(Locale.HasTextKey(name)) then
0172
if(v.DescriptionKey and Locale.HasTextKey(v.DescriptionKey)) then


Lobby.lua

UI/FrontEnd/Multiplayer/Lobby.lua
0312
if(Locale.HasTextKey(serverWorldSize)) then



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.