WoW:API SetCVar: Difference between revisions

WoW:API SetCVar (source)

Revision as of 00:01, 18 April 2007

468 bytes added , 18 April 2007

Added information on scriptCVar

Anonymous user

WoWWiki>Shadowed

@@ Line 1: / Line 1: @@
 {{wowapi}}
-<center>'''SetCVar("cvar",value{,"scriptCVar"})'''</center>
+Changes a variable located inside Config.wtf
+  SetCVar( "cvar", value[, "scriptCVar"] );
-SetCVar allows you to set the content of the variables defined in the config.wtf file (which is in the WTF directory).
+== Parameters ==
+=== Arguments ===
-Settings changed in this manner are applied to the game UI immediately, however settings are not saved until exit and settings which were previously not defined in config.wtf are not available to GetCVar until the file has been saved (at logout).
+:;cvar : String - CVar to modify
+:;value : New value of the CVar, the game
+:;scriptCVar : String - First argument for the CVAR_UPDATE event, if none is passed then the event isn't fired
-SetCVar("UnitNamePlayer", "1") - enables player nametags.
+----
+=== Details ===
+Settings that are changed using this will be applied to the game UI immediately, however settings are not saved until exit and settings which were previously not defined in Config.wtf are not available to GetCVar until the file has been saved at logout.
-See [[Config.wtf defaults]] for more.
+Some options require a call to [[API_RestartGx|RestartGx]]() before they take effect.
+If you try and pass an invalid CVar you'll get an error, check [[Config.wtf defaults]] for a list of valid CVars.
+By default CVAR_UPDATE is not fired when you call SetCVar, to make sure it does you need to pass the third argument scriptCVar which will be the first argument in the event when it's fired.
+__NOTOC__