WoW API: GetText

From AddOn Studio
Revision as of 06:33, 7 January 2008 by WoWWiki>Egingell
Jump to navigation Jump to search

WoW API < GetText

"I" iconThis function is implemented in Lua here FrameXML/LocaleProperties.lua.


strResult = GetText(sIdentifier, nNumber, ordinal);

GetText is used to localize some game text like PvP-ranks or spell text.


Parameters

Arguments

sIdentifier
String - Identifier for the text to localize i.e.: PVP_RANK_5_1
nNumber
Number - Number that is used in the text (for format-strings), can be nil. GetText does not seem to use this.
ordinal
Unknown

Returns

strResult
String - The localized text corresponding to sIdentifier.


Notes

This is used for all the PvP-ranks titles that are displayed above characters (and some other stuff). So if you i.e. replace this with a function, that always returns "stupid", all players with PvP-ranks will run around with a name tag like "stupid xyz". This is used rarely and I am not sure what kind of ID-keys you can used.