| Package | weavejs.api.core |
| Interface | public interface ICallbackCollection extends ILinkableObject |
| Implementors | CallbackCollection, LinkableDynamicObject, LinkableVariable |
| Property | Defined By | ||
|---|---|---|---|
| callbacksAreDelayed : Boolean [read-only]
While this is true, it means the delay count is greater than zero and the effects of
triggerCallbacks() are delayed until resumeCallbacks() is called to reduce the delay count. | ICallbackCollection | ||
| triggerCounter : uint [read-only]
This counter gets incremented at the time that callbacks are triggered, before they are actually called. | ICallbackCollection | ||
| Method | Defined By | ||
|---|---|---|---|
addDisposeCallback(relevantContext:Object, callback:Function, allowDelay:Boolean = false):void
This will add a callback that will only be called once, when this callback collection is disposed. | ICallbackCollection | ||
addGroupedCallback(relevantContext:Object, groupedCallback:Function, triggerCallbackNow:Boolean = false, delayWhileBusy:Boolean = true):void
Adds a callback that will only be called during a scheduled time each frame. | ICallbackCollection | ||
addImmediateCallback(relevantContext:Object, callback:Function, runCallbackNow:Boolean = false, alwaysCallLast:Boolean = false):void
This adds the given function as a callback. | ICallbackCollection | ||
delayCallbacks():void
This will delay the effects of triggerCallbacks() until a matching call is made to resumeCallbacks(). | ICallbackCollection | ||
removeCallback(relevantContext:Object, callback:Function):void
This function will remove a callback that was previously added. | ICallbackCollection | ||
resumeCallbacks():void
This should be called after delayCallbacks() to resume the callbacks. | ICallbackCollection | ||
triggerCallbacks():void
This will increase the triggerCounter, run immediate callbacks, and trigger grouped callbacks to be called later. | ICallbackCollection | ||
| callbacksAreDelayed | property |
callbacksAreDelayed:Boolean [read-only] While this is true, it means the delay count is greater than zero and the effects of triggerCallbacks() are delayed until resumeCallbacks() is called to reduce the delay count.
public function get callbacksAreDelayed():BooleanSee also
| triggerCounter | property |
triggerCounter:uint [read-only] This counter gets incremented at the time that callbacks are triggered, before they are actually called. It is necessary in some situations to check this counter to determine if cached data should be used.
public function get triggerCounter():uintSee also
| addDisposeCallback | () | method |
public function addDisposeCallback(relevantContext:Object, callback:Function, allowDelay:Boolean = false):voidThis will add a callback that will only be called once, when this callback collection is disposed.
Parameters
relevantContext:Object — If this is not null, then the callback will be removed when the relevantContext object is disposed via SessionManager.dispose(). This parameter is typically a 'this' pointer.
| |
callback:Function — The function to call when this callback collection is disposed.
| |
allowDelay:Boolean (default = false) |
| addGroupedCallback | () | method |
public function addGroupedCallback(relevantContext:Object, groupedCallback:Function, triggerCallbackNow:Boolean = false, delayWhileBusy:Boolean = true):voidAdds a callback that will only be called during a scheduled time each frame. Grouped callbacks use a central trigger list, meaning that if multiple ICallbackCollections trigger the same grouped callback before the scheduled time, it will behave as if it were only triggered once. For this reason, grouped callback functions cannot have any parameters. Adding a grouped callback to a ICallbackCollection will undo any previous effects of addImmediateCallback() or addDisposeCallback() made to the same ICallbackCollection. The callback function will not be called recursively as a result of it triggering callbacks recursively.
Parameters
relevantContext:Object — The 'this' argument for the callback. The callback will be removed when the relevantContext object is disposed via Weave.dispose().
| |
groupedCallback:Function — The callback function that will only be allowed to run during a scheduled time each frame. It must not require any parameters.
| |
triggerCallbackNow:Boolean (default = false) | |
delayWhileBusy:Boolean (default = true) |
| addImmediateCallback | () | method |
public function addImmediateCallback(relevantContext:Object, callback:Function, runCallbackNow:Boolean = false, alwaysCallLast:Boolean = false):voidThis adds the given function as a callback. The function must not require any parameters. The callback function will not be called recursively as a result of it triggering callbacks recursively.
Parameters
relevantContext:Object — The 'this' argument for the callback. The callback will be removed when the relevantContext object is disposed via Weave.dispose().
| |
callback:Function — The function to call when callbacks are triggered.
| |
runCallbackNow:Boolean (default = false) | |
alwaysCallLast:Boolean (default = false) |
| delayCallbacks | () | method |
public function delayCallbacks():voidThis will delay the effects of triggerCallbacks() until a matching call is made to resumeCallbacks(). Pairs of calls to delayCallbacks() and resumeCallbacks() can be nested.
See also
| removeCallback | () | method |
public function removeCallback(relevantContext:Object, callback:Function):voidThis function will remove a callback that was previously added.
Parameters
relevantContext:Object — The relevantContext parameter that was given when the callback was added.
| |
callback:Function — The function to remove from the list of callbacks.
|
| resumeCallbacks | () | method |
public function resumeCallbacks():voidThis should be called after delayCallbacks() to resume the callbacks. If delayCallbacks() is called multiple times, resumeCallbacks() must be called the same number of times in order to resume the callbacks.
See also
| triggerCallbacks | () | method |
public function triggerCallbacks():voidThis will increase the triggerCounter, run immediate callbacks, and trigger grouped callbacks to be called later. If delayCallbacks() was called, the callbacks will not be called immediately.
See also