WoW:API setglobal - Revision history

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

2023-08-15T04:47:18Z

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

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 06:57, 21 May 2020

2020-05-21T06:57:09Z

← Older revision		Revision as of 06:57, 21 May 2020
Line 1:		Line 1:
	{{wowapi}}		{{wowapi\|toc=0}}
			Set a global variable, from a string.
	~~[[API_getglobal\|getglobal]] and setglobal are deprecated and replaced with _G[]<ref>http://forums.worldofwarcraft.com/thread.html?topicId=25626580975&sid=1</ref>. Their functionality will be removed~~ from ~~the game at~~ a ~~future date~~. ~~Change all references of getglobal and~~ setglobal:		setglobal( "globalName", value )

	~~var = getglobal~~(~~varName~~) ~~--getglobal deprecated~~
	~~var = _G[varName] --new syntax to get a global~~

	~~setglobal(otherName, otherVar) --~~setglobal deprecated		== Deprecation ==
	_G[~~otherName~~] = ~~otherVar --new syntax to set~~ a ~~global~~		Both [[API_getglobal\|getglobal]] and setglobal are deprecated and replaced with the '_G[]' <ref>http://forums.worldofwarcraft.com/thread.html?topicId=25626580975&sid=1</ref> the global table. Their functionality will be removed from the game at a future date.

			Replace all references of 'getglobal':
			var = getglobal(varName) --getglobal deprecated
			var = _G[varName] --new syntax to get a global

	~~Set a global variable, from a string.~~		Replace all references of 'setglobal':
	setglobal( ~~"globalName"~~, ~~value~~ )		setglobal(otherName, otherVar) --setglobal deprecated
			_G[otherName] = otherVar --new syntax to set a global

	== Parameters ==		== Parameters ==
Line 34:		Line 35:
	local prevval = _G["MyVariable"] ''-- "getglobal()"''		local prevval = _G["MyVariable"] ''-- "getglobal()"''
	_G["MyVariable"] = 1234 ''-- "setglobal()"''		_G["MyVariable"] = 1234 ''-- "setglobal()"''

	Function calls always cost some overhead, so if a large number of getglobal calls are being made, the getfenv table will be a faster route. Note that for few or infrequent calls the performance gain of this method is negligible.		Function calls always cost some overhead, so if a large number of getglobal calls are being made, the getfenv table will be a faster route. Note that for few or infrequent calls the performance gain of this method is negligible.

			== References ==
			{{Reflist}}

WoWWiki>Pauladin: setglobal is deprecated and replaced with _G[]

2010-10-24T12:38:35Z

setglobal is deprecated and replaced with _G[]

@@ Line 1: / Line 1: @@
 {{wowapi}}
 Set a global variable, from a string.
   setglobal( "globalName", value )

WoWWiki>Tekkub at 08:55, 18 July 2007

2007-07-18T08:55:32Z

← Older revision		Revision as of 08:55, 18 July 2007
Line 1:		Line 1:
	{{wowapi}} ~~__NOTOC__~~		{{wowapi}}


	~~<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->~~
	Set a global variable, from a string.		Set a global variable, from a string.
			setglobal( "globalName", value )
	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~
	setglobal( "globalName", value );


	== Parameters ==		== Parameters ==

	=== Arguments ===		=== Arguments ===
	~~<!-- List each argument, together with its type -->~~
	:("globalName", value)		:("globalName", value)

Line 19:		Line 11:

	=== Returns ===		=== Returns ===
	~~<!-- List each return value, together with its type -->~~
	~~<!-- :isTrue, retVal1, retVal2--> <!-- remove this line if it's just one value -->~~

	:;Always returns nil.		:;Always returns nil.


	== Example ==		== Example ==
	/script setglobal( "MyVariable", 1234 );		/script setglobal( "MyVariable", 1234 )

	=== Result ===		=== Result ===
	MyVariable = 1234		MyVariable = 1234


	== Details ==		== Details ==

	As of the introduction of [[API getfenv\|getfenv]]() into the API, setglobal() and [[API getglobal\|getglobal]]() are somewhat superfluous. You can always do something along the lines of:		As of the introduction of [[API getfenv\|getfenv]]() into the API, setglobal() and [[API getglobal\|getglobal]]() are somewhat superfluous. You can always do something along the lines of:
	local ~~globalenv~~ = getfenv();		local _G = getfenv()
	local prevval = ~~globalenv~~["MyVariable"]; ''-- "getglobal()"''		local prevval = _G["MyVariable"] ''-- "getglobal()"''
	~~globalenv~~["MyVariable"] = 1234; ''-- "setglobal()"''		_G["MyVariable"] = 1234 ''-- "setglobal()"''
			Function calls always cost some overhead, so if a large number of getglobal calls are being made, the getfenv table will be a faster route. Note that for few or infrequent calls the performance gain of this method is negligible.
	~~Since calling a function~~ always ~~requires~~ some ~~extra~~ overhead, ~~it's most likely~~ a ~~better idea to not use setglobal and~~ getglobal, ~~but to use~~ the ~~global environment (as above) instead~~.

WoWWiki>Egingell: Added a "/" before "script" in the Example section

2007-07-10T13:57:04Z

Added a "/" before "script" in the Example section

← Older revision		Revision as of 13:57, 10 July 2007
Line 26:		Line 26:

	== Example ==		== Example ==
	script setglobal( "MyVariable", 1234 );		/script setglobal( "MyVariable", 1234 );

	=== Result ===		=== Result ===

WoWWiki>WoWWiki-Two at 14:21, 28 September 2006

2006-09-28T14:21:42Z

← Older revision		Revision as of 14:21, 28 September 2006
Line 38:		Line 38:
	local prevval = globalenv["MyVariable"]; ''-- "getglobal()"''		local prevval = globalenv["MyVariable"]; ''-- "getglobal()"''
	globalenv["MyVariable"] = 1234; ''-- "setglobal()"''		globalenv["MyVariable"] = 1234; ''-- "setglobal()"''

			Since calling a function always requires some extra overhead, it's most likely a better idea to not use setglobal and getglobal, but to use the global environment (as above) instead.

WoWWiki>Mikk: /* Details */ Explain how getfenv() works equally well

2006-07-17T08:36:22Z

Details: Explain how getfenv() works equally well

← Older revision		Revision as of 08:36, 17 July 2006
Line 26:		Line 26:

	== Example ==		== Example ==
	~~<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->~~		script setglobal( "MyVariable", 1234 );
	script setglobal( "MyVariable", 1234 );

	====Result====		=== Result ===
	~~<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->~~
	MyVariable = 1234		MyVariable = 1234


	~~<!--~~==Details==		== Details ==
	~~Details not appropriate for the main description can go here.~~
	~~REMOVE the section if you're just going to restate the intro line!~~

	: ~~Does something particularly detailed.~~ -->		As of the introduction of [[API getfenv\|getfenv]]() into the API, setglobal() and [[API getglobal\|getglobal]]() are somewhat superfluous. You can always do something along the lines of:
			local globalenv = getfenv();
			local prevval = globalenv["MyVariable"]; ''-- "getglobal()"''
	-[~~[User:Tigerheart\|Tigerheart~~]~~] 21:42, 30 June 2006~~ (~~EDT~~)		globalenv["MyVariable"] = 1234; ''-- "setglobal()"''

WoWWiki>Tigerheart at 00:59, 1 July 2006

2006-07-01T00:59:39Z

New page

{{wowapi}} __NOTOC__


Set a global variable, from a string.


setglobal( "globalName", value );

== Parameters ==

=== Arguments ===

:("globalName", value)

:;globalName : String - Name of the global you want to change.
:;value : Any - Value you want to set the global to.

=== Returns ===

 

:;Always returns nil.

== Example ==

script setglobal( "MyVariable", 1234 );

====Result====

MyVariable = 1234



-[[User:Tigerheart|Tigerheart]] 21:42, 30 June 2006 (EDT)