WoW:API SetCVar: Difference between revisions

← Older edit

WoW:API SetCVar (source)

Revision as of 04:47, 15 August 2023

604 bytes added , 15 August 2023

m

Move page script moved page API SetCVar to WoW:API SetCVar without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-<center>'''SetCVar("cvar",value{,"scriptCVar"})'''</center>
+{{wowapi}}
+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 - This value is stored in Config.wtf as plain text. Passing anything other than a string or number is just silly.
+:;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.
+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 [[Console variables]] 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.
-{{WoW API}}
+__NOTOC__