WoW:API GetCVarDefault: 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 default value of a console variable.

value = GetCVarDefault("cvarName")

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