WoW:API GetText: Difference between revisions

Revision as of 14:20, 5 September 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetText

This function is implemented in Lua here FrameXML/LocaleProperties.lua.

strResult = GetText(sIdentifier, nNumber);

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.

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.

@@ Line 1: / Line 1: @@
-'''function GetText(sIdentifier, nNumber);'''<br>
+{{framexmlfunc|FrameXML/LocaleProperties.lua}} __NOTOC__
-<br>
-GetText is used to localize some game text like PvP-ranks or spell text.<br>
-<br>
+ strResult = GetText(sIdentifier, nNumber);
-'''Parameters:'''<br>
-sIdentifier ''(string)'' - Identifier for the text to localize i.e.: PVP_RANK_5_1<br>
+GetText is used to localize some game text like PvP-ranks or spell text.
-nNumber ''(int)'' - Number that is used in the text (for format-strings), can be nil. GetText does not seem to use this.<br>
-<br>
-'''Returns:'''<br>
+== Parameters ==
-''(string)'' - The localized text corresponding to sIdentifier.<br>
+=== Arguments ===
-<br>
+:;sIdentifier:String - Identifier for the text to localize i.e.: PVP_RANK_5_1
-'''Notes:'''<br>
+:;nNumber:Number - Number that is used in the text (for format-strings), can be nil. GetText does not seem to use this.
+=== Returns ===
+:;:strResult:String - The localized text corresponding to sIdentifier.<br>
+== 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.
-{{template:WoW API}}

Navigation menu

Search