WoW:API getglobal - Revision history

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

2023-08-15T04:45:56Z

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

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

Bear at 20:49, 22 October 2012

2012-10-22T20:49:25Z

← Older revision		Revision as of 20:49, 22 October 2012
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	~~{{removedfromgame\|patch=4.0.1}}~~

	getglobal and [[API_setglobal\|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:		''Note: getglobal and [[API_setglobal\|setglobal]] are deprecated and replaced with _G[]<ref>http://forums.worldofwarcraft.com/thread.html?topicId=25626580975&sid=1</ref>. Change all references of getglobal and setglobal:''

	var = getglobal(varName) --getglobal deprecated		var = getglobal(varName) --getglobal deprecated
Line 9:		Line 8:
	setglobal(otherName, otherVar) --setglobal deprecated		setglobal(otherName, otherVar) --setglobal deprecated
	_G[otherName] = otherVar --new syntax to set a global		_G[otherName] = otherVar --new syntax to set a global


	== Description ==		== Description ==


	Get a global variable, from a string.		Get a global variable, from a string.
	local targetGlobal = getglobal("globalName")		local targetGlobal = getglobal("globalName")

			== Arguments ==

	~~== Parameters ==~~

	=== Arguments ===
	:("globalName")		:("globalName")

	:;globalName : String - Name of the global you want to get.		:;globalName : String - Name of the global you want to get.

	=== Returns ===		== Returns ==
	:;The value from the given string, or nil if not found		:;The value from the given string, or nil if not found

WoWWiki>Pauladin: getglobal deprecated, replace with _G

2010-10-24T12:37:18Z

getglobal deprecated, replace with _G

@@ Line 1: / Line 1: @@
 {{wowapi}}
 {{removedfromgame|patch=4.0.1}}
 Get a global variable, from a string.
   local targetGlobal = getglobal("globalName")
 == Parameters ==

WoWWiki>Egingell at 23:18, 14 October 2010

2010-10-14T23:18:00Z

← Older revision		Revision as of 23:18, 14 October 2010
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
			{{removedfromgame\|patch=4.0.1}}
	Get a global variable, from a string.		Get a global variable, from a string.
	local targetGlobal = getglobal("globalName")		local targetGlobal = getglobal("globalName")
Line 24:		Line 25:
	Function calls always cost some overhead, so if a large number of getglobal calls are being made, the global table will be a faster route. Note that for few or infrequent calls the performance gain of this method is negligible (but given the lack of any loss of functionality, recommended).		Function calls always cost some overhead, so if a large number of getglobal calls are being made, the global table will be a faster route. Note that for few or infrequent calls the performance gain of this method is negligible (but given the lack of any loss of functionality, recommended).

	''Note:'' Accessing the global table through the function getfenv() was common within addons presumably because the global '_G' (the direct global table) was hidden from the WoW environment. It seems to have since been uncovered, and now calling it directly for global access is possible:		''Note:'' Accessing the global table through the function getfenv() was common within addons presumably because the global '[[Dump_G\|_G]]' (the direct global table) was hidden from the WoW environment. It seems to have since been uncovered, and now calling it directly for global access is possible:
	local _G = _G -- a local speeds up access to _G slightly. negligible for infrequent calls.		local _G = _G -- a local speeds up access to [[Dump_G\|_G]] slightly. negligible for infrequent calls.
	local prevval = _G["MyVariable"] ''-- "getglobal()"''		local prevval = _G["MyVariable"] ''-- "getglobal()"''
	_G["MyVariable"] = 1234 ''-- "setglobal()"''		_G["MyVariable"] = 1234 ''-- "setglobal()"''

WoWWiki>NefariousN at 05:40, 16 December 2007

2007-12-16T05:40:45Z

← Older revision		Revision as of 05:40, 16 December 2007
Line 11:		Line 11:

	=== Returns ===		=== Returns ===
	:;The ~~object~~ from the given string, or nil if not found		:;The value from the given string, or nil if not found

	== Details ==		== Details ==
Line 18:		Line 18:
	local curFrame = getglobal("myFrame"..i)		local curFrame = getglobal("myFrame"..i)

	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 (as well as direct access to the table _G as a global), setglobal() and [[API getglobal\|getglobal]]() are somewhat superfluous. You can always do something along the lines of:
	local _G = getfenv()		local _G = getfenv()
	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 global table will be a faster route. Note that for few or infrequent calls the performance gain of this method is negligible (but given the lack of any loss of functionality, recommended).
	:''~~<code>getglobal~~()~~</code> does~~ a ~~little more than <code>~~_G~~[globalName]</code>~~. ~~It also finds <code>~~_G[~~anything~~]~~[globalName]</code> or <code>~~_G[~~anything~~]~~[deeper][globalName]</code> or any deeper hidden child object.~~''
			''Note:'' Accessing the global table through the function getfenv() was common within addons presumably because the global '_G' (the direct global table) was hidden from the WoW environment. It seems to have since been uncovered, and now calling it directly for global access is possible:
			local _G = _G -- a local speeds up access to _G slightly. negligible for infrequent calls.
			local prevval = _G["MyVariable"] ''-- "getglobal()"''
			_G["MyVariable"] = 1234 ''-- "setglobal()"''

WoWWiki>Tekkub: /* Details */

2007-07-18T09:09:26Z

Details

← Older revision		Revision as of 09:09, 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 -->~~
	Get a global variable, from a string.		Get a global variable, from a string.
			local targetGlobal = getglobal("globalName")
	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~
	getglobal("globalName")


	== Parameters ==		== Parameters ==

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

Line 18:		Line 11:

	=== Returns ===		=== Returns ===
	~~<!-- List each return value, together with its type -->~~		:;The object from the given string, or nil if not found
	~~<!-- :isTrue, retVal1, retVal2--> <!-- remove this line if it's just one value -->~~

	:;The object from the given string.

	== Details ==		== Details ==

	This function is used to get an object if you generate the name of the object manually in your script:		This function is used to get an object if you generate the name of the object manually in your script:
			-- i = some_dynamic_number
	i = some_dynamic_number;
	local curFrame = getglobal("myFrame"..i)		local curFrame = getglobal("myFrame"..i)

	~~You can immitate~~ getglobal() ~~by using~~ the ~~following script~~:		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 _G = getfenv()
	_G = getfenv() -- ~~set _G to the global environment once at the beginning of your script~~		local prevval = _G["MyVariable"] ''-- "getglobal()"''
	~~...~~		_G["MyVariable"] = 1234 ''-- "setglobal()"''
	~~myvar =~~ _G[~~globalName~~] -- ~~this is what getglobal~~() ~~does~~		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.
			:''<code>getglobal()</code> does a little more than <code>_G[globalName]</code>. It also finds <code>_G[anything][globalName]</code> or <code>_G[anything][deeper][globalName]</code> or any deeper hidden child object.''
	~~Remark from Airlag~~:

	getglobal() ~~is doing~~ a little more than _G[globalName]

	It ~~allso~~ finds _G[anything][globalName] or _G[anything][deeper][globalName] or any deeper hidden child object.

WoWWiki>Airlag at 17:21, 4 November 2006

2006-11-04T17:21:48Z

← Older revision		Revision as of 17:21, 4 November 2006
Line 35:		Line 35:
	...		...
	myvar = _G[globalName] -- this is what getglobal() does		myvar = _G[globalName] -- this is what getglobal() does

			Remark from Airlag:

			getglobal() is doing a little more than _G[globalName]

			It allso finds _G[anything][globalName] or _G[anything][deeper][globalName] or any deeper hidden child object.

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

2006-09-28T14:19:12Z

← Older revision		Revision as of 14:19, 28 September 2006
Line 29:		Line 29:
	i = some_dynamic_number;		i = some_dynamic_number;
	local curFrame = getglobal("myFrame"..i)		local curFrame = getglobal("myFrame"..i)

			You can immitate getglobal() by using the following script:

			_G = getfenv() -- set _G to the global environment once at the beginning of your script
			...
			myvar = _G[globalName] -- this is what getglobal() does

WoWWiki>Progman: okay?

2006-09-10T09:12:54Z

okay?

New page

{{wowapi}} __NOTOC__


Get a global variable, from a string.


getglobal("globalName")

== Parameters ==

=== Arguments ===

:("globalName")

:;globalName : String - Name of the global you want to get.

=== Returns ===

 

:;The object from the given string.

== Details ==

This function is used to get an object if you generate the name of the object manually in your script:

i = some_dynamic_number;
local curFrame = getglobal("myFrame"..i)