ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
fl.motion 

MotionEvent  - AS3 Flash

Packagefl.motion
Classpublic class MotionEvent
InheritanceMotionEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The MotionEvent class represents events that are broadcast by the fl.motion.Animator class. Use these events with an event listener to initiate custom functions. For example, if you have an Animator instance named abox_animator, Flash Player executes the following trace statement when the animation is complete:
 import fl.motion.MotionEvent;
 abox_animator.addEventListener(MotionEvent.MOTION_END,afterMotion);
 function afterMotion(e:MotionEvent) {
    trace("animation complete!");
 }
 

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
MotionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
MotionEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  MOTION_END : String = "motionEnd"
[static] Indicates that the motion has stopped, whether by an explicit call to Animator.stop() or Animator.end(), or by reaching the end of the Motion instance.
MotionEvent
  MOTION_START : String = "motionStart"
[static] Indicates that the Motion instance has started playing.
MotionEvent
  MOTION_UPDATE : String = "motionUpdate"
[static] Indicates that the Motion instance has changed and the screen has been updated.
MotionEvent
  TIME_CHANGE : String = "timeChange"
[static] Indicates that the Animator instance's time value has changed, but the screen has not yet been updated (Flash Player has not dispatched the motionUpdate event).
MotionEvent
Constructor Detail

MotionEvent

()Constructor
public function MotionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
Constant Detail

MOTION_END

Constant
public static const MOTION_END:String = "motionEnd"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Indicates that the motion has stopped, whether by an explicit call to Animator.stop() or Animator.end(), or by reaching the end of the Motion instance.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.

Related API Elements

MOTION_START

Constant 
public static const MOTION_START:String = "motionStart"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Indicates that the Motion instance has started playing.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.

Related API Elements

MOTION_UPDATE

Constant 
public static const MOTION_UPDATE:String = "motionUpdate"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Indicates that the Motion instance has changed and the screen has been updated.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.

Related API Elements

TIME_CHANGE

Constant 
public static const TIME_CHANGE:String = "timeChange"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Indicates that the Animator instance's time value has changed, but the screen has not yet been updated (Flash Player has not dispatched the motionUpdate event).

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.

Related API Elements