WoW:API collectgarbage - Revision history

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

2023-08-15T04:45:20Z

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

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

Bear at 07:23, 19 September 2013

2013-09-19T07:23:35Z

← Older revision		Revision as of 07:23, 19 September 2013
Line 1:		Line 1:
	{{~~wowapi~~}}		{{wowlua}}
	Control the garbage collector and query it for information. As of WoW 2.0, this is the same as the standard collectgarbage() in Lua, but prior to that it was quite different.		Control the garbage collector and query it for information. As of WoW 2.0, this is the same as the standard collectgarbage() in Lua, but prior to that it was quite different.

Line 8:		Line 8:
	:([opt [, arg]])		:([opt [, arg]])

	:;opt: String - This function is a generic interface to the garbage collector. It performs different functions according to its first argument:		:;opt
			:: String - This function is a generic interface to the garbage collector. It performs different functions according to its first argument:

	:: * "stop": stops the garbage collector.		* "stop": stops the garbage collector.
	:: * "restart": restarts the garbage collector.		* "restart": restarts the garbage collector.
	:: * "collect": performs a full garbage-collection cycle. This is the default action if '''opt''' is not specified.		* "collect": performs a full garbage-collection cycle. This is the default action if '''opt''' is not specified.
	:: * "count": returns the total memory in use by Lua (in Kbytes).		* "count": returns the total memory in use by Lua (in Kbytes).
	:: * "step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.		* "step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.
	:: * "setpause": sets arg/100 as the new value for the pause of the collector (see §2.10).		* "setpause": sets arg/100 as the new value for the pause of the collector (see §2.10).
	:: * "setstepmul": sets arg/100 as the new value for the step multiplier of the collector (see §2.10).		* "setstepmul": sets arg/100 as the new value for the step multiplier of the collector (see §2.10).

	== Example ==		== Example ==

WoWWiki>Farmbuyer: Specify default arg action

2009-10-14T05:08:51Z

Specify default arg action

← Older revision		Revision as of 05:08, 14 October 2009
Line 2:		Line 2:
	Control the garbage collector and query it for information. As of WoW 2.0, this is the same as the standard collectgarbage() in Lua, but prior to that it was quite different.		Control the garbage collector and query it for information. As of WoW 2.0, this is the same as the standard collectgarbage() in Lua, but prior to that it was quite different.

	collectgarbage(opt [, arg])		collectgarbage([opt [, arg]])

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:(opt [, arg])		:([opt [, arg]])

	:;opt: String - This function is a generic interface to the garbage collector. It performs different functions according to its first argument:		:;opt: String - This function is a generic interface to the garbage collector. It performs different functions according to its first argument:
Line 12:		Line 12:
	:: * "stop": stops the garbage collector.		:: * "stop": stops the garbage collector.
	:: * "restart": restarts the garbage collector.		:: * "restart": restarts the garbage collector.
	:: * "collect": performs a full garbage-collection cycle.		:: * "collect": performs a full garbage-collection cycle. This is the default action if '''opt''' is not specified.
	:: * "count": returns the total memory in use by Lua (in Kbytes).		:: * "count": returns the total memory in use by Lua (in Kbytes).
	:: * "step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.		:: * "step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.

WoWWiki>Mikk at 15:21, 16 July 2007

2007-07-16T15:21:56Z

← Older revision		Revision as of 15:21, 16 July 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	~~<center>'''collectgarbage''' ''-Documentation by [[user:Aradan\|Aradan]], Update by [[user:CuteMiyu\|CuteMiyu]]-''</center>~~		Control the garbage collector and query it for information. As of WoW 2.0, this is the same as the standard collectgarbage() in Lua, but prior to that it was quite different.

	~~Sets garbage collection limit and calls~~ the garbage collector ~~if the Lua byte counter exceeds this limit~~.

	~~Since~~ WoW 2.0, ~~it change to Lua 5.1.~~ Lua ~~5.1 changed collectgarbage design~~, ~~and you need update your script or AddOn if you used this function~~.

	collectgarbage(opt [, arg])		collectgarbage(opt [, arg])
Line 26:		Line 22:
	collectgarbage("count") -- return kilobytes of memory in use, i.e. 2048 for 2 megabytes		collectgarbage("count") -- return kilobytes of memory in use, i.e. 2048 for 2 megabytes

	~~== Note ==~~

	~~There is a [[Lua]] function with the exact same name but its parameters and behavior is quite different from the WoW API version.~~

	~~----~~
	__NOTOC__		__NOTOC__

WoWWiki>CuteMiyu at 15:58, 27 March 2007

2007-03-27T15:58:08Z

← Older revision		Revision as of 15:58, 27 March 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	<center>'''collectgarbage''' ''-Documentation by [[user:Aradan\|Aradan]]-''</center>		<center>'''collectgarbage''' ''-Documentation by [[user:Aradan\|Aradan]], Update by [[user:CuteMiyu\|CuteMiyu]]-''</center>

	Sets garbage collection limit and calls the garbage collector if the Lua byte counter exceeds this limit.		Sets garbage collection limit and calls the garbage collector if the Lua byte counter exceeds this limit.

	collectgarbage(~~{limit}~~)		Since WoW 2.0, it change to Lua 5.1. Lua 5.1 changed collectgarbage design, and you need update your script or AddOn if you used this function.

			collectgarbage(opt [, arg])

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:(~~{limit}~~)		:(opt [, arg])

	:;~~limit~~ : ~~Number~~ - ~~GC limit (in KiB). If omitted, defaults~~ to ~~zero, forcing~~ garbage ~~collection~~.		:;opt: String - This function is a generic interface to the garbage collector. It performs different functions according to its first argument:

	:~~;limit~~ : "count" - ~~will return~~ the ~~total kilobytes~~ of ~~memory used~~		:: * "stop": stops the garbage collector.
			:: * "restart": restarts the garbage collector.
			:: * "collect": performs a full garbage-collection cycle.
			:: * "count": returns the total memory in use by Lua (in Kbytes).
			:: * "step": performs a garbage-collection step. The step "size" is controlled by arg (larger values mean more steps) in a non-specified way. If you want to control the step size you must experimentally tune the value of arg. Returns true if the step finished a collection cycle.
			:: * "setpause": sets arg/100 as the new value for the pause of the collector (see §2.10).
			:: * "setstepmul": sets arg/100 as the new value for the step multiplier of the collector (see §2.10).

	== Example ==		== Example ==
	collectgarbage() -- Force garbage collection		collectgarbage("collect") -- Force garbage collection
	~~collectgarbage(131072) -- Set GC limit to 128 MiB~~
	collectgarbage("count") -- return kilobytes of memory in use, i.e. 2048 for 2 megabytes		collectgarbage("count") -- return kilobytes of memory in use, i.e. 2048 for 2 megabytes

WoWWiki>Jgoemat: Added "count" as a parameter, found in mod "!!Warmup"

2006-12-09T01:56:02Z

Added "count" as a parameter, found in mod "!!Warmup"

← Older revision		Revision as of 01:56, 9 December 2006
Line 11:		Line 11:

	:;limit : Number - GC limit (in KiB). If omitted, defaults to zero, forcing garbage collection.		:;limit : Number - GC limit (in KiB). If omitted, defaults to zero, forcing garbage collection.

			:;limit : "count" - will return the total kilobytes of memory used

	== Example ==		== Example ==
	collectgarbage() -- Force garbage collection		collectgarbage() -- Force garbage collection
	collectgarbage(131072) -- Set GC limit to 128 MiB		collectgarbage(131072) -- Set GC limit to 128 MiB
			collectgarbage("count") -- return kilobytes of memory in use, i.e. 2048 for 2 megabytes

	== Note ==		== Note ==

WoWWiki>Watchout: wowapi template added

2006-08-17T09:51:01Z

wowapi template added

← Older revision		Revision as of 09:51, 17 August 2006
Line 1:		Line 1:
			{{wowapi}}
	<center>'''collectgarbage''' ''-Documentation by [[user:Aradan\|Aradan]]-''</center>		<center>'''collectgarbage''' ''-Documentation by [[user:Aradan\|Aradan]]-''</center>

Line 21:		Line 22:
	----		----
	__NOTOC__		__NOTOC__
	~~{{Template:WoW API}}~~

WoWWiki>Mikk: markup ftw

2006-05-24T13:25:47Z

markup ftw

← Older revision		Revision as of 13:25, 24 May 2006
Line 14:		Line 14:
	collectgarbage() -- Force garbage collection		collectgarbage() -- Force garbage collection
	collectgarbage(131072) -- Set GC limit to 128 MiB		collectgarbage(131072) -- Set GC limit to 128 MiB

			== Note ==

			There is a [[Lua]] function with the exact same name but its parameters and behavior is quite different from the WoW API version.

	----		----
	__NOTOC__		__NOTOC__
	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>WoWWiki-Aradan at 17:23, 10 May 2006

2006-05-10T17:23:35Z

New page

<center>'''collectgarbage''' ''-Documentation by [[user:Aradan|Aradan]]-''</center>

Sets garbage collection limit and calls the garbage collector if the Lua byte counter exceeds this limit.

collectgarbage({limit})

== Parameters ==
=== Arguments ===
:({limit})

:;limit : Number - GC limit (in KiB). If omitted, defaults to zero, forcing garbage collection.

== Example ==
collectgarbage() -- Force garbage collection
collectgarbage(131072) -- Set GC limit to 128 MiB

----
__NOTOC__
{{Template:WoW API}}