Packageorg.goasap.utils.customadvance
Classpublic class OnConditionTrue
InheritanceOnConditionTrue Inheritance SequenceAdvance Inheritance PlayableBase Inheritance flash.events.EventDispatcher
ImplementsIUpdatable

A custom advance type that triggers when a callback returns true.


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
  pulseInterval : int
[read-only] The pulse on which to call the callback function.
OnConditionTrue
 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
  
OnConditionTrue(callbackThatReturnsBoolean:Function, pulseInterval:Number)
OnConditionTrue
  
pause():Boolean
OnConditionTrue
  
resume():Boolean
OnConditionTrue
 Inherited
skipTo(position:Number):Boolean
SequenceAdvance
  
start():Boolean
OnConditionTrue
  
stop():Boolean
OnConditionTrue
 Inherited
toString():String
Appends the regular toString value with the instance's playableID.
PlayableBase
  
update(currentTime:Number):void
OnConditionTrue
Events
 EventSummaryDefined by
 Inherited
ADVANCE
Subclasses should call the dispatchAdvance method when the sequence should advance to its next step.SequenceAdvance
Property detail
pulseIntervalproperty
pulseInterval:int  [read-only]

The pulse on which to call the callback function. Defaults to GoItem.defaultPulseInterval if not specified.

Implementation
    public function get pulseInterval():int
Constructor detail
OnConditionTrue()constructor
public function OnConditionTrue(callbackThatReturnsBoolean:Function, pulseInterval:Number)

Parameters
callbackThatReturnsBoolean:Function — Any function that returns a Boolean value
 
pulseInterval:Number — The pulse on which to call the callback function, which defaults to GoItem.defaultPulseInterval if not specified.
Method detail
pause()method
public override function pause():Boolean

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

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

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

Returns
Boolean
update()method 
public function update(currentTime:Number):voidParameters
currentTime:Number