WoW:API GetCVar: Difference between revisions

Revision as of 17:04, 21 June 2010

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

Returns the current value of a console variable.

value = GetCVar("cvarName")

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
+Returns the current value of a console variable.
-GetCVar allows you to get the content of the variables defined in the config.wtf file (which is in the WTF directory).
   value = GetCVar("cvarName")
-== Parameters ==
+== Arguments ==
-=== Arguments ===
+;cvarName: String ([[CVar]]) - name of the CVar to query the value of.
-:;cvarName: String - see [[Config.wtf defaults]] for a list
-=== Returns ===
-:;value: String
+== Returns ==
-== Example ==
+;value: String - current value of the CVar.
-  DEFAULT_CHAT_FRAME:AddMessage(GetCVar("realmName"))
-Outputs your realm name in the chat frame.
 == Notes ==
+* Calling this function with an invalid variable name will cause an error.
-* Calling GetCVar with an invalid variable name will cause an error