WoW:API SetCVar - Revision history

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

2023-08-15T04:47:18Z

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

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Resa1983: /* Details */

2010-03-29T13:34:27Z

Details

← Older revision		Revision as of 13:34, 29 March 2010
Line 17:		Line 17:
	Some options require a call to [[API_RestartGx\|RestartGx]]() before they take effect.		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.		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.		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.

WoWWiki>Egingell: ", the game" -removed

2008-07-22T10:46:56Z

", the game" -removed

← Older revision		Revision as of 10:46, 22 July 2008
Line 8:		Line 8:

	:;cvar : String - CVar to modify		:;cvar : String - CVar to modify
	:;value : New value of the CVar~~, the game~~		:;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		:;scriptCVar : String - First argument for the CVAR_UPDATE event, if none is passed then the event isn't fired

Line 22:		Line 22:


	~~== Notes ==~~
	~~From Ohklus: '''Do not overwrite this function!''' You'll have a very hard time finding the reason for those nasty "sry, your addon was blocked cause it called a secure function" errors.~~

	My example: hitting the escape key should just open the game menu. If you overwrite SetCVar you'll get the error each time you press Esc (except when closing a window). The error is released by the Blizzard UI functions [[API_SpellStopCasting]], [[API_SpellStopTargeting]] and [[API_ClearTarget]], because they appear in [[API_ToggleGameMenu]]. I've got no idea why SetCVar is called between hitting Esc and reaching [[API_ToggleGameMenu]].

	__NOTOC__		__NOTOC__

WoWWiki>Ohklus: Updated with new information

2008-07-20T23:37:30Z

Updated with new information

← Older revision		Revision as of 23:37, 20 July 2008
Line 20:		Line 20:

	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.		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.


			== Notes ==
			From Ohklus: '''Do not overwrite this function!''' You'll have a very hard time finding the reason for those nasty "sry, your addon was blocked cause it called a secure function" errors.

			My example: hitting the escape key should just open the game menu. If you overwrite SetCVar you'll get the error each time you press Esc (except when closing a window). The error is released by the Blizzard UI functions [[API_SpellStopCasting]], [[API_SpellStopTargeting]] and [[API_ClearTarget]], because they appear in [[API_ToggleGameMenu]]. I've got no idea why SetCVar is called between hitting Esc and reaching [[API_ToggleGameMenu]].

	__NOTOC__		__NOTOC__

WoWWiki>Shadowed: Added information on scriptCVar

2007-04-18T00:01:55Z

Added information on scriptCVar

← Older revision		Revision as of 00:01, 18 April 2007
Line 1:		Line 1:
	{{wowapi}}		{{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__

WoWWiki>Hobinbot: upgraded deprecated template

2007-01-06T17:31:29Z

upgraded deprecated template

← Older revision		Revision as of 17:31, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	<center>'''SetCVar("cvar",value{,"scriptCVar"})'''</center>		<center>'''SetCVar("cvar",value{,"scriptCVar"})'''</center>

Line 8:		Line 9:

	See [[Config.wtf defaults]] for more.		See [[Config.wtf defaults]] for more.
	~~----~~
	~~{{WoW API}}~~

WoWWiki>Farmbuyer at 14:02, 25 July 2006

2006-07-25T14:02:43Z

← Older revision		Revision as of 14:02, 25 July 2006
Line 7:		Line 7:
	SetCVar("UnitNamePlayer", "1") - enables player nametags.		SetCVar("UnitNamePlayer", "1") - enables player nametags.

			See [[Config.wtf defaults]] for more.
	----		----
	{{WoW API}}		{{WoW API}}

WoWWiki>Matrimus: Added detail to describe function purpose and effects

2006-01-05T10:41:22Z

Added detail to describe function purpose and effects

← Older revision		Revision as of 10:41, 5 January 2006
Line 1:		Line 1:
	{{API~~/Uncategorized~~}}		<center>'''SetCVar("cvar",value{,"scriptCVar"})'''</center>

			SetCVar allows you to set the content of the variables defined in the config.wtf file (which is in the WTF directory).

			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).

			SetCVar("UnitNamePlayer", "1") - enables player nametags.

			----
			{{WoW API}}

WoWWiki>Muert at 21:03, 30 December 2005

2005-12-30T21:03:19Z

New page