Garbage collection can be a big deal when writing complex programs in Actionscript. Not removing EventListeners is probably one of the biggest sources of AS holding onto memory it doesn’t need.
There is a very easy way to allow GC to handle your event listener clean-up for you when creating a new event listener – the useWeakReference argument.
Here is some standard code we’ve all done million times when creating a button:
|
1 |
var button:MovieClip = new MovieClip(); |
|
1 |
button.addEventListener(MouseEvent.CLICK, click_handler_function); |
The two arguments are pretty straight forward the first is the event we’re listing for and the second is the function that is called once the event is fired, but there are actually 5 arguments that can be passed to addEventListener() here is the method definition:
|
1 |
<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/flash/events/IEventDispatcher.html#addEventListener%28%29">addEventListener</a>(type:<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/String.html">String</a>, listener:<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/Function.html">Function</a>, useCapture:<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/Boolean.html">Boolean</a> = false, priority:<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/int.html">int</a> = 0, useWeakReference:<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/Boolean.html">Boolean</a> = false):<a href="http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/specialTypes.html#void">void</a> |
the 5th argument (useWeakReference) is false by default but by setting to true, this eventListener will be automatically removed and freed for Garbage Collection when required.
Here is the new eventListener code updated to make use of useWeakReference.
|
1 |
button.addEventListener(MouseEvent.CLICK, click_handler_function,false,0,true); |