class Scene

assetCache : AssetCache

Scene-scoped asset cache. These assets will be destroyed when the scene ends.

batch : DrawCommandBatch

bgAlpha : Float

Background opacity. If less than 1, Scenes behind this Scene in the stack will be rendered underneath.

bgColor : Null<Color>

Background color of this Scene. If null, will use HXP.stage.color.

camera : Camera

Point used to determine drawing offset in the render loop.

read only count : Int

How many Entities are in the Scene.

read only farthest : Entity

The Entity that will be rendered first by the Scene.

read only first : Entity

The first Entity in the Scene.

height : Null<Int>

read only layerFarthest : Int

The layer that will be rendered first by the Scene.

read only layerNearest : Int

The layer that will be rendered last by the Scene.

read only layers : Int

How many Entity layers the Scene has.

read only mouseX : Int

X position of the mouse in the Scene.

read only mouseY : Int

Y position of the mouse in the scene.

read only nearest : Entity

The Entity that will be rendered last by the scene.

onInputPressed : Signals

Invoked when input is received while this Scene is active.

onInputReleased : Signals

Invoked when input is received while this Scene is active.

onResize : Signal0

Invoked after this Scene is resized.

postRender : Signal0

Invoked after rendering this Scene completes.

postUpdate : Signal0

Invoked after this Scene's update cycle.

preRender : Signal0

Invoked before rendering begins for this Scene each frame.

preUpdate : Signal0

Invoked before this Scene's update cycle begins each frame.

shaders : Null<Array<SceneShader>>

Array of shaders which will be used to process the final result of rendering this scene. GL targets (desktop, mobile, HTML5) only.

trackDrawCalls : Bool

Whether or not to track draw calls for this scene

read only uniqueTypes : Int

How many different types have been added to the Scene.

visible : Bool

If the render() loop is performed.

width : Null<Int>

x : Int

y : Int

add<E> (e : E) : E

Adds the Entity to the Scene at the end of the frame.

addGraphic (graphic : Graphic, layer : Int = 0, x : Float = 0, y : Float = 0) : Entity

Adds an Entity to the Scene with the Graphic object.

addList<E> (list : Iterable<E>) : Void

Adds multiple Entities to the scene.

addMask (mask : Mask, type : String, x : Int = 0, y : Int = 0) : Entity

Adds an Entity to the Scene with the Mask object.

begin () : Void

Override this; called when Scene is switch to, and set to the currently active scene.

bringForward (e : Entity) : Bool

Shifts the Entity one place towards the front of its contained layer.

bringToFront (e : Entity) : Bool

Brings the Entity to the front of its contained layer.

classCount (c : String) : Int

Returns the amount of Entities of the Class are in the Scene.

classFirst<E> (c : Class<E>) : E

The first Entity of the Class.

clearRecycled<E> (classType : Class<E>) : Void

Clears stored reycled Entities of the Class type.

clearRecycledAll () : Void

Clears stored recycled Entities of all Class types.

collideCircleInto<E> (type : String, circleX : Float, circleY : Float, radius : Float, into : Array<E>) : Void

Populates an array with all Entities that collide with the circle. This function does not empty the array, that responsibility is left to the user.

collideLine (type : String, fromX : Int, fromY : Int, toX : Int, toY : Int, precision : Int = 1, ?p : Vector2) : Entity

Returns the first Entity found that collides with the line.

collidePoint (type : String, pX : Float, pY : Float) : Entity

Returns the first Entity found that collides with the position.

collidePointInto<E> (type : String, pX : Float, pY : Float, into : Array<E>, cameraAdjust : Bool = false) : Void

Populates an array with all Entities that collide with the position. This function does not empty the array, that responsibility is left to the user.

collideRect (type : String, rX : Float, rY : Float, rWidth : Float, rHeight : Float) : Entity

Returns the first Entity that collides with the rectangular area.

collideRectInto<E> (type : String, rX : Float, rY : Float, rWidth : Float, rHeight : Float, into : Array<E>) : Void

Populates an array with all Entities that collide with the rectangle. This function does not empty the array, that responsibility is left to the user.

create<E> (classType : Class<E>, addToScene : Bool = true, constructorsArgs : Array<Dynamic>) : E

Returns a new Entity, or a stored recycled Entity if one exists.

Note: The constructor is only called when creating a new entity, when using a recycled one the constructor (with constructorsArgs) isn't called. Instead use a function to initialize your entities.

end () : Void

Override this; called when Scene is changed, and the active scene is no longer this.

entitiesForType (type : String) : List<Entity>

A list of Entity objects of the type.

focusGained () : Void

Override this, called when game gains focus

focusLost () : Void

Override this, called when game loses focus

getAll<E> (into : Array<E>) : Void

Pushes all Entities in the Scene into the array. This function does not empty the array, that responsibility is left to the user.

getClass<T, E> (c : Class<T>, into : Array<E>) : Void

Pushes all Entities in the Scene of the Class into the Array or Vector. This function does not empty the array, that responsibility is left to the user.

getInstance (name : String) : Null<Entity>

Returns the Entity with the instance name, or null if none exists

getLayer<E> (layer : Int, into : Array<E>) : Void

Pushes all Entities in the Scene on the layer into the Array or Vector. This function does not empty the array, that responsibility is left to the user.

getTexture (id : String) : Texture

getType<E> (type : String, into : Array<E>) : Void

Pushes all Entities in the Scene of the type into the Array or Vector. This function does not empty the array, that responsibility is left to the user.

isAtBack (e : Entity) : Bool

If the Entity as at the back of its layer.

isAtFront (e : Entity) : Bool

If the Entity as at the front of its layer.

layerCount (layer : Int) : Int

Returns the amount of Entities are on the layer in the Scene.

layerFirst (layer : Int) : Entity

The first Entity on the Layer.

layerLast (layer : Int) : Entity

The last Entity on the Layer.

layerVisible (layer : Int) : Bool

Checks if a layer is visible or not

nearestToClass<T> (type : String, e : Entity, classType : Class<T>, useHitboxes : Bool = false) : Entity

Finds the Entity nearest to another.

nearestToEntity (type : String, e : Entity, useHitboxes : Bool = false) : Entity

Finds the Entity nearest to another.

nearestToPoint (type : String, x : Float, y : Float, useHitboxes : Bool = false) : Entity

Finds the Entity nearest to the position.

nearestToRect (type : String, x : Float, y : Float, width : Float, height : Float) : Entity

Finds the Entity nearest to the rectangle.

recycle<E> (e : E) : E

Removes the Entity from the Scene at the end of the frame and recycles it. The recycled Entity can then be fetched again by calling the create() function.

remove<E> (e : E) : E

Removes the Entity from the Scene at the end of the frame.

removeAll () : Void

Removes all Entities from the Scene at the end of the frame.

removeList<E> (list : Iterable<E>) : Void

Removes multiple Entities from the scene.

render () : Void

Performed by the game loop, renders all contained Entities. If you override this to give your Scene render code, remember to call super.render() or your Entities will not be rendered.

sendBackward (e : Entity) : Bool

Shifts the Entity one place towards the back of its contained layer.

sendToBack (e : Entity) : Bool

Sends the Entity to the back of its contained layer.

showLayer (layer : Int, show : Bool = true) : Void

Toggles the visibility of a layer

typeCount (type : String) : Int

Returns the amount of Entities of the type are in the Scene.

update () : Void

Performed by the game loop, updates all contained Entities. If you override this to give your Scene update code, remember to call super.update() or your Entities will not be updated.

updateLists (shouldAdd : Bool = true) : Void

Updates the add/remove lists at the end of the frame.