GODPAPER | All Packages | All Classes | Index | Frames No Frames |
EnterFrameEvent

Package | starling.events
Class | public class EnterFrameEvent
Inheritance | EnterFrameEvent Event Object

An EnterFrameEvent is triggered once per frame and is dispatched to all objects in the display tree. It contains information about the time that has passed since the last frame. That way, you can easily make animations that are independent of the frame rate, taking the passed time into account.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates if event will bubble. | Event
|  | currentTarget : EventDispatcher [read-only] The object the event is currently bubbling at. | Event
|  | data : Object [read-only] Arbitrary data that is attached to the event. | Event
|  | passedTime : Number [read-only] The time that has passed since the last frame (in seconds). | EnterFrameEvent
|  | target : EventDispatcher [read-only] The object that dispatched the event. | Event
|  | type : String [read-only] A string that identifies the event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | EnterFrameEvent(type:String, passedTime:Number, bubbles:Boolean = false) Creates an enter frame event with the passed time. | EnterFrameEvent
|  | stopImmediatePropagation():void Prevents any other listeners from receiving the event. | Event
|  | stopPropagation():void Prevents listeners at the next bubble stage from receiving the event. | Event
|  | toString():String Returns a description of the event, containing type and bubble information. | Event

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ADDED : String = added [static] Event type for a display object that is added to a parent. | Event
|  | ADDED_TO_STAGE : String = addedToStage [static] Event type for a display object that is added to the stage | Event
|  | CANCEL : String = cancel [static] An event type to be utilized in custom events. | Event
|  | CHANGE : String = change [static] An event type to be utilized in custom events. | Event
|  | CLOSE : String = close [static] An event type to be utilized in custom events. | Event
|  | COMPLETE : String = complete [static] Event type that may be used whenever something finishes. | Event
|  | CONTEXT3D_CREATE : String = context3DCreate [static] Event type for a (re)created stage3D rendering context. | Event
|  | ENTER_FRAME : String = enterFrame [static] Event type for a display object that is entering a new frame. | EnterFrameEvent
|  | FLATTEN : String = flatten [static] Event type for a display object that is being flattened. | Event
|  | OPEN : String = open [static] An event type to be utilized in custom events. | Event
|  | REMOVED : String = removed [static] Event type for a display object that is removed from its parent. | Event
|  | REMOVED_FROM_STAGE : String = removedFromStage [static] Event type for a display object that is removed from the stage. | Event
|  | REMOVE_FROM_JUGGLER : String = removeFromJuggler [static] Event type for an animated object that requests to be removed from the juggler. | Event
|  | RESIZE : String = resize [static] Event type for a resized Flash Player. | Event
|  | ROOT_CREATED : String = rootCreated [static] Event type that indicates that the root DisplayObject has been created. | Event
|  | SCROLL : String = scroll [static] An event type to be utilized in custom events. | Event
|  | SELECT : String = select [static] An event type to be utilized in custom events. | Event
|  | TEXTURES_RESTORED : String = texturesRestored [static] Event type that is dispatched by the AssetManager after a context loss. | Event
|  | TRIGGERED : String = triggered [static] Event type for a triggered button. | Event

Property Detail

passedTime | property

`passedTime:Number` [read-only]

The time that has passed since the last frame (in seconds).

Implementation
`public function get passedTime():Number`
Constructor Detail

EnterFrameEvent | () | Constructor

`public function EnterFrameEvent(type:String, passedTime:Number, bubbles:Boolean = false)`

Creates an enter frame event with the passed time.

Parameters

| `type:String`
| `passedTime:Number`
| `bubbles:Boolean` (default = `false`)``

Constant Detail

ENTER_FRAME | Constant

`public static const ENTER_FRAME:String = enterFrame`

Event type for a display object that is entering a new frame.

Thu Jan 16 2014, 01:11 PM +08:00