on(mouseEvent:Object) { // your statements here }

Specifies the mouse event or keypress that triggers an action.

Parameters

mouseEvent:Object - A mouseEvent is a trigger called an event . When the event occurs, the statements following it within curly braces ({ }) execute. Any of the following values can be specified for the mouseEvent parameter:

• press The mouse button is pressed while the pointer is over the button.
• release The mouse button is released while the pointer is over the button.
• releaseOutside While the pointer is over the button, the mouse button is pressed, rolled outside the button area, and released. Both the press and the dragOut events always precede a releaseOutside event.
  Note: This event is supported in Flash Lite only if System.capabilities.hasMouse is true or System.capabilities.hasStylus is true.
• rollOut The pointer rolls outside the button area.
  Note: This event is supported in Flash Lite only if System.capabilities.hasMouse is true or System.capabilities.hasStylus is true.
• rollOver The mouse pointer rolls over the button.
• dragOut While the pointer is over the button, the mouse button is pressed and then rolls outside the button area.
• dragOver While the pointer is over the button, the mouse button has been pressed, then rolled outside the button, and then rolled back over the button.
• keyPress "<key> " The specified keyboard key is pressed. For the key portion of the parameter, specify a key constant, as shown in the code hinting in the Actions Panel. You can use this parameter to intercept a key press, that is, to override any built-in behavior for the specified key. The button can be anywhere in your application, on or off the Stage. One limitation of this technique is that you can't apply the on() handler at runtime; you must do it at authoring time. Make sure that you select Control > Disable Keyboard Shortcuts, or certain keys with built-in behavior won't be overridden when you test the application using Control > Test Movie.

For a list of key constants, see the Key class.

Example

In the following script, the startDrag() function executes when the mouse is pressed, and the conditional script is executed when the mouse is released and the object is dropped:

on (press) {
 startDrag(this);
}
on (release) {
 trace("X:"+this._x);
 trace("Y:"+this._y);
 stopDrag();
}

See also

onClipEvent handler, Key