Stage
Description
A Stage represents the root of the display tree.
Only objects that are direct or indirect children of the stage will be rendered.
A stage object is created automatically by the Application class. Don't
create a Stage instance manually.
Keyboard Events
In Loom, keyboard events are only dispatched at the stage. Add an event listener directly to the stage to be notified of keyboard events.
Controller Events
In Loom, game controller events are only dispatched at the stage. Add an event listener directly to the stage to be notified of controller events.
Resize Events
When a Loom application is resized, the stage dispatches a ResizeEvent. The
event contains properties containing the updated width and height of game.
See also:
Loom.Events.KeyboardEvent
Loom.Events.GameControllerEvent
Loom.Events.ResizeEvent
API overview
Constructor
Stage
(
width: Number
,
height: Number
,
color: Number
= 0
)
@private
Attributes
Public attributes
| color: Number |
The background color of the stage |
| fingerEnabled: Boolean |
native
Enables touch events for finger-based input devices if true |
| mouseEnabled: Boolean |
native
Enables touch events for mouse input devices if true |
| nativeStageHeight: Number |
read-only
Height of the native display in pixels |
| nativeStageWidth: Number |
read-only
Width of the native display in pixels |
| onBackKey: HardwareKeyDelegate | native |
| onGameControllerAdded: GameControllerAddedDelegate | native |
| onGameControllerRemoved: GameControllerRemovedDelegate | native |
| onKeyDown: KeyDelegate | native |
| onKeyUp: KeyDelegate | native |
| onMenuKey: HardwareKeyDelegate | native |
| onOrientationChange: OrientationChangeDelegate | native |
| onRenderStage: NativeDelegate |
static
native
Called when the stage is about to render |
| onScrollWheelYMoved: ScrollWheelDelegate | native |
| onSizeChange: SizeChangeDelegate | native |
| onTouchBegan: TouchDelegate | native |
| onTouchCancelled: TouchDelegate | native |
| onTouchEnded: TouchDelegate | native |
| onTouchMoved: TouchDelegate | native |
| reportFps: Boolean |
When true, dump the current FPS via trace() every second |
| scaleMode: StageScaleMode |
Set the scaling behavior of the stage as the application is resized |
| stageHeight: Number |
The height of the stage coordinate system |
| stageWidth: Number |
The width of the stage coordinate system |
| tessellationQuality: Number |
The maximum recursion level of tessellation |
| vectorQuality: Number |
The quality of vector rendering |
Protected attributes
Constants
Constants
| VECTOR_QUALITY_ANTIALIAS: Number |
static
|
| VECTOR_QUALITY_NONE: Number |
static
|
| VECTOR_QUALITY_STENCIL_STROKES: Number |
static
Uses the stencil buffer to render strokes |
Functions
Public functions
| advanceTime ( passedTime: Number ): Void | |
| dump (): Void |
Print debug information about the display list hiererchy to the console via trace() |
| firePendingResizeEvent (): Void | native |
| render (): Void | native |
Protected functions
Constructor
Attributes
base: DisplayObject
Inherited from DisplayObject
read-only
The topmost object in the display tree the object is part of.
blendEnabled: Boolean
Inherited from DisplayObject
Enables or disables blending. If set to false, there will be no blending and there may be performance gains.
blendMode: BlendMode
Inherited from DisplayObject
The default value is BlendMode.AUTO
The blend mode determines how the object is blended with the objects underneath.
See also:
loom2d.display.BlendMode
bounds: Rectangle
Inherited from DisplayObject
read-only
The bounds of the object relative to the local coordinates of the parent.
cacheAsBitmap: Boolean
Inherited from DisplayObject
If true, the untransformed contents get cached into a texture at render time.
The contents remain static until you turn off caching or use invalidateBitmapCache
to update the cache manually.
depth: Number
Inherited from DisplayObject
If depthSort is enabled on parent, this will be used to establish draw order. Higher values are drawn closer. Matching values have undefined order.
depthSort: Boolean
Inherited from DisplayObjectContainer
If depth sorting enabled, direct children will use their depth property to establish draw order.
fingerEnabled: Boolean
native
Enables touch events for finger-based input devices if true. Enabled by default on mobile platforms, disabled on desktop.
hasVisibleArea: Boolean
Inherited from DisplayObject
read-only
Indicates if an object occupies any visible area. (Which is the case when its 'alpha', 'scaleX' and 'scaleY' values are not zero, and its 'visible' property is enabled.)
ignoreHitTestAlpha: Boolean
Inherited from DisplayObject
This can be used if you wish to have a DisplayObject with zero alpha still respond to hit tests
mouseEnabled: Boolean
native
Enables touch events for mouse input devices if true. Enabled by default on desktop platforms, disabled on mobile.
name: String
Inherited from DisplayObject
The name of the display object (default: null). Used by 'getChildByName()' of display object containers.
numChildren: Number
Inherited from DisplayObjectContainer
read-only
The number of children of this container.
onBackKey: HardwareKeyDelegate
native
onGameControllerAdded: GameControllerAddedDelegate
native
onGameControllerRemoved: GameControllerRemovedDelegate
native
onKeyDown: KeyDelegate
native
onKeyUp: KeyDelegate
native
onMenuKey: HardwareKeyDelegate
native
onOrientationChange: OrientationChangeDelegate
native
onScrollWheelYMoved: ScrollWheelDelegate
native
onSizeChange: SizeChangeDelegate
native
onTouchBegan: TouchDelegate
native
onTouchCancelled: TouchDelegate
native
onTouchEnded: TouchDelegate
native
onTouchMoved: TouchDelegate
native
parent: DisplayObjectContainer
Inherited from DisplayObject
pivotX: Number
Inherited from DisplayObject
The x coordinate of the object's origin in its own coordinate space (default: 0).
pivotY: Number
Inherited from DisplayObject
The y coordinate of the object's origin in its own coordinate space (default: 0).
reportFps: Boolean
When true, dump the current FPS via trace() every second.
Displaying an FPS counter can be expensive enough to affect performance. This is much cheaper, and thus more reliable, especially in performance sensitive situations.
root: DisplayObject
Inherited from DisplayObject
read-only
The root object the display object is connected to (ie: an instance of the class that was passed to the Starling constructor), or null if the object is not connected to the stage.
rotation: Number
Inherited from DisplayObject
The rotation of the object in radians, (In Loom2D, all angles are measured in radians.)
scale: Number
Inherited from DisplayObject
General scale factor. '1' means no scale, negative values flip the object. Use this when setting scaleX/scaleY explicitly is too verbose.
scaleX: Number
Inherited from DisplayObject
The horizontal scale factor. '1' means no scale, negative values flip the object.
scaleY: Number
Inherited from DisplayObject
The vertical scale factor. '1' means no scale, negative values flip the object.
stage: Stage
Inherited from DisplayObject
read-only
The stage the display object is connected to, or null if it is not connected to the stage.
stageHeight: Number
The height of the stage coordinate system. Change it to scale its contents relative to the application viewport.
stageWidth: Number
The width of the stage coordinate system. Change it to scale its contents relative to the application viewport.
tessellationQuality: Number
The maximum recursion level of tessellation. Bigger values result in greater quality. Valid values are from 1 to 10 while 6 is the default. Values lower than 6 area known to cause visual errors in the rendering.
touchable: Boolean
Inherited from DisplayObject
Indicates if this object (and its children) will receive touch events.
transformationMatrix: Matrix
Inherited from DisplayObject
The transformation matrix of the object relative to its parent.
If you assign a custom transformation matrix, Starling will try to figure out
suitable values for x, y, scaleX, scaleY, and rotation.
However, if the matrix was created in a different way, this might not be possible.
In that case, Starling will apply the matrix, but not update the corresponding
properties.
vectorQuality: Number
The quality of vector rendering.
See also:
Stage.VECTOR_QUALITY_ANTIALIAS
Stage.VECTOR_QUALITY_STENCIL
e.g. if (Stage.vectorQuality & VECTOR_QUALITY_ANTIALIAS) { trace("Vector antialiasing enabled!"); }
visible: Boolean
Inherited from DisplayObject
The visibility of the object, An invisible object will be untouchable.
x: Number
Inherited from DisplayObject
The x coordinate of the object relative to the local coordinates of the parent.
y: Number
Inherited from DisplayObject
The y coordinate of the object relative to the local coordinates of the parent.
Protected attributes
Constants
VECTOR_QUALITY_ANTIALIAS: Number
static
Stage.vectorQuality constant defining the vector antialiasing status.
Vector antialiasing adjusts the geometry to include antialiasing.
VECTOR_QUALITY_STENCIL_STROKES: Number
static
Uses the stencil buffer to render strokes. This provides better quality rendering for overlapping strokes and overlapping shapes. If you aren't relying on specific overlapping behavior, you can omit this flag for better performance.
Functions
addChild
(
child: DisplayObject
,
fireEvents: Boolean
= true
): DisplayObject
Inherited from DisplayObjectContainer
Adds a child to the container. It will be at the frontmost position.
Parameters
| child: DisplayObject | |
| fireEvents: Boolean = true |
addChildAt
(
child: DisplayObject
,
index: Number
,
fireEvents: Boolean
= true
): DisplayObject
Inherited from DisplayObjectContainer
Adds a child to the container at a certain index.
Parameters
| child: DisplayObject | |
| index: Number | |
| fireEvents: Boolean = true |
addEventListener
(
type: String
,
listener: Function
): Void
Inherited from EventDispatcher
Registers an event listener at a certain object.
Parameters
| type: String | |
| listener: Function |
addLMLChild
(
id: String
,
child: Object
): Void
Inherited from DisplayObjectContainer
Add a child to this LML node, identifying it by id.
Parameters
| id: String | |
| child: Object |
broadcastEvent
(
event: Event
): Void
Inherited from DisplayObjectContainer
Dispatches an event on all children (recursively). The event must not bubble.
Parameters
| event: Event |
broadcastEventWith
(
type: String
,
data: Object
= null
): Void
Inherited from DisplayObjectContainer
Dispatches an event with the given parameters on all children (recursively). The method uses an internal pool of event objects to avoid allocations.
Parameters
| type: String | |
| data: Object = null |
center
(): Void
Inherited from DisplayObject
Center the DisplayObject's pivot point using the width and height. This centers this object about its own origin based on its width and height.
contains
(
child: DisplayObject
): Boolean
Inherited from DisplayObjectContainer
Determines if a certain object is a child of the container (recursively).
Parameters
| child: DisplayObject |
dispatchEvent
(
event: Event
): Void
Inherited from EventDispatcher
Dispatches an event to all objects that have registered listeners for its type. If an event with enabled 'bubble' property is dispatched to a display object, it will travel up along the line of parents, until it either hits the root object or someone stops its propagation manually.
Parameters
| event: Event |
dispatchEventWith
(
type: String
,
bubbles: Boolean
= false
,
data: Object
= null
): Void
Inherited from EventDispatcher
Dispatches an event with the given parameters to all objects that have registered listeners for the given type. The method uses an internal pool of event objects to avoid allocations.
Parameters
| type: String | |
| bubbles: Boolean = false | |
| data: Object = null |
dispose
(): Void
Inherited from DisplayObject
Disposes all resources of the display object. GPU buffers are released, event listeners are removed, filters are disposed.
getBounds
(
targetSpace: DisplayObject
,
resultRect: Rectangle
= null
): Rectangle
Inherited from DisplayObject
Returns a rectangle that completely encloses the object as it appears in another coordinate system. If you pass a 'resultRectangle', the result will be stored in this rectangle instead of creating a new object.
Parameters
| targetSpace: DisplayObject | |
| resultRect: Rectangle = null |
getChildAt
(
index: Number
): DisplayObject
Inherited from DisplayObjectContainer
Returns a child object at a certain index.
Parameters
| index: Number |
getChildAtUnsafe
(
index: Number
): DisplayObject
Inherited from DisplayObjectContainer
Returns a child object at a certain index without doing bounds checks. For optimized use in cases where you are 100% about the index validity.
Parameters
| index: Number |
getChildByName
(
name: String
): DisplayObject
Inherited from DisplayObjectContainer
Returns a child object with a certain name (non-recursively).
Parameters
| name: String |
getChildIndex
(
child: DisplayObject
): Number
Inherited from DisplayObjectContainer
Returns the index of a child within the container, or "-1" if it is not found.
Parameters
| child: DisplayObject |
getFullTypeName
(): String
Inherited from Object
native
Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.
Returns
| String | fully qualified type name of the Object. |
getTargetTransformationMatrix
(
targetSpace: DisplayObject
,
resultMatrix: Matrix
): Void
Inherited from DisplayObject
native
Parameters
| targetSpace: DisplayObject | |
| resultMatrix: Matrix |
getType
(): Type
Inherited from Object
native
Gets the Type that describes the Object.
Returns
| Type | The Type that describes the object. |
getTypeName
(): String
Inherited from Object
native
Gets the type name of the Object.
Returns
| String | type name of the Object. |
globalToLocal
(
globalPoint: Point
): Point
Inherited from DisplayObject
Transforms a point from global (stage) coordinates to the local coordinate system.
Parameters
| globalPoint: Point |
hasEventListener
(
type: String
): Boolean
Inherited from EventDispatcher
Returns if there are listeners registered for a certain event type.
Parameters
| type: String |
hitTest
(
localPoint: Point
,
forTouch: Boolean
= false
): DisplayObject
Inherited from DisplayObject
Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails. If "forTouch" is true, untouchable and invisible objects will cause the test to fail.
Parameters
| localPoint: Point | |
| forTouch: Boolean = false |
initializeLMLNode
(
id: String
): Void
Inherited from DisplayObject
Handle LML node initialization.
Parameters
| id: String |
invalidateBitmapCache
(): Void
Inherited from DisplayObject
native
Update the cached texture before the next render.
This function has no effect if cacheAsBitmap is turned off.
localToGlobal
(
localPoint: Point
): Point
Inherited from DisplayObject
Transforms a point from the local coordinate system to global (stage) coordinates.
Parameters
| localPoint: Point |
moveChildLast
(
child: DisplayObject
): Void
Inherited from DisplayObjectContainer
Moves a child to be the last object in the container.
Parameters
| child: DisplayObject |
preinitializeLMLNode
(
id: String
): Void
Inherited from DisplayObject
Pre-initialize the LML node.
Parameters
| id: String |
removeChild
(
child: DisplayObject
,
dispose: Boolean
= false
,
fireEvents: Boolean
= true
): DisplayObject
Inherited from DisplayObjectContainer
Removes a child from the container. If the object is not a child, nothing happens. If requested, the child will be disposed right away.
Parameters
| child: DisplayObject | |
| dispose: Boolean = false | |
| fireEvents: Boolean = true |
removeChildAt
(
index: Number
,
dispose: Boolean
= false
,
fireEvents: Boolean
= true
): DisplayObject
Inherited from DisplayObjectContainer
Removes a child at a certain index. Children above the child will move down. If requested, the child will be disposed right away.
Parameters
| index: Number | |
| dispose: Boolean = false | |
| fireEvents: Boolean = true |
removeChildren
(
beginIndex: Number
= 0
,
endIndex: Number
=
,
dispose: Boolean
= false
): Void
Inherited from DisplayObjectContainer
Removes a range of children from the container (endIndex included). If no arguments are given, all children will be removed.
Parameters
| beginIndex: Number = 0 | |
| endIndex: Number = | |
| dispose: Boolean = false |
removeEventListener
(
type: String
,
listener: Function
): Void
Inherited from EventDispatcher
Removes an event listener from the object.
Parameters
| type: String | |
| listener: Function |
removeEventListeners
(
type: String
= null
): Void
Inherited from EventDispatcher
Removes all event listeners with a certain type, or all of them if type is null. Be careful when removing all event listeners: you never know who else was listening.
Parameters
| type: String = null |
removeFromParent
(
dispose: Boolean
= false
): Void
Inherited from DisplayObject
Removes the object from its parent, if it has one.
Parameters
| dispose: Boolean = false |
removeLMLChildren
(): Void
Inherited from DisplayObjectContainer
Remove (and destroy) all LML children from this node.
setChildIndex
(
child: DisplayObject
,
index: Number
): Void
Inherited from DisplayObjectContainer
Moves a child to a certain index. Children at and after the replaced position move up.
Parameters
| child: DisplayObject | |
| index: Number |
setChildrenUnsafe
(
ordered: Vector.<DisplayObject>
): Void
Inherited from DisplayObjectContainer
Parameters
| ordered: Vector.<DisplayObject> |
sortChildren
(
compareFunction: Function
): Void
Inherited from DisplayObjectContainer
Sorts the children according to a given function (that works just like the sort function of the Vector class).
Parameters
| compareFunction: Function |
swapChildren
(
child1: DisplayObject
,
child2: DisplayObject
): Void
Inherited from DisplayObjectContainer
Swaps the indexes of two children.
Parameters
| child1: DisplayObject | |
| child2: DisplayObject |