Packageorg.goasap.utils.customadvance
Classpublic class OnEventComplete
InheritanceOnEventComplete Inheritance SequenceAdvance Inheritance PlayableBase Inheritance flash.events.EventDispatcher

A custom advance type that triggers when any event is dispatched by any IEventDispatcher host.

If the event requires filtering or custom handling, you can optionally set up a custom handler that accepts the event object as an input and returns true if all conditions are met for advancing the sequence.


Public Properties
 PropertyDefined by
 InheritedplayableID : *
An arbitrary id value for the convenient identification of any instance, automatically set to an instance count by this class.
PlayableBase
 Inheritedstate : String
Returns a PlayStates constant.
PlayableBase
Protected Properties
 PropertyDefined by
 Inherited_playRetainer : Dictionary
[static] Memory-management: playable items that do not add themselves to GoEngine should use this property to store references to themselves during play.
PlayableBase
Public Methods
 MethodDefined by
  
OnEventComplete(dispatcher:IEventDispatcher, type:String, customHanderThatReturnsBoolean:Function = null)
OnEventComplete
 Inherited
pause():Boolean
SequenceAdvance
 Inherited
resume():Boolean
SequenceAdvance
 Inherited
skipTo(position:Number):Boolean
SequenceAdvance
  
start():Boolean
OnEventComplete
  
stop():Boolean
OnEventComplete
 Inherited
toString():String
Appends the regular toString value with the instance's playableID.
PlayableBase
Events
 EventSummaryDefined by
 Inherited
ADVANCE
Subclasses should call the dispatchAdvance method when the sequence should advance to its next step.SequenceAdvance
Constructor detail
OnEventComplete()constructor
public function OnEventComplete(dispatcher:IEventDispatcher, type:String, customHanderThatReturnsBoolean:Function = null)

Parameters
dispatcher:IEventDispatcher — Any object that dispatches the event.
 
type:String — The event type to listen for
 
customHanderThatReturnsBoolean:Function (default = null) — Optionally you may specify a custom event handler which should accept an event input and return true once all conditions are met.
Method detail
start()method
public override function start():Boolean

Returns
Boolean
stop()method 
public override function stop():Boolean

Returns
Boolean