class HXP

static read only VERSION : String

The HaxePunk version. Format: Major.Minor.Patch

static app : App

static assignedFrameRate : Float

The framerate assigned to the stage.

static bounds : Rectangle

A rectangle representing the size of the screen.

static read only camera : Camera

Point used to determine drawing offset in the render loop.

static read only choose : Dynamic

The choose function randomly chooses and returns one of the provided values.

static cursor : Cursor

static defaultFont : String

The default font file to use, by default: font/monofonto.ttf.

static elapsed : Float

Game time elapsed since the last frame. For fixed framerate, this will be a constant 1/framerate.

static engine : Engine

The Engine instance.

static fixed : Bool

If the game is running at a fixed framerate.

static focused : Bool

Whether the game has focus or not

static frameRate : Float

The framerate assigned to the stage.

static fullscreen : Bool

Toggles between windowed and fullscreen modes

static read only halfHeight : Float

Half the screen height.

static read only halfWidth : Float

Half the screen width.

static height : Int

Height of the game.

static needsResize : Bool

True if the scale of the screen has changed.

static orientations : Array<Int>

Defines the allowed orientations

static pan : Float

Global panning factor for all sounds, a value from -1 to 1. Panning only applies to mono sounds. It is ignored on stereo.

static rate : Float

Timescale applied to HXP.elapsed.

static renderingScene : Scene

If we're currently rendering, this is the Scene being rendered now.

static scene : Scene

The currently active Scene object. When you set this, the Scene is flagged to switch, but won't actually do so until the end of the current frame.

static screen : Screen

The Screen object, use to transform or offset the Screen.

static write only time : Float

static tweener : Tweener

Global tweener for tweening between multiple scenes

static volume : Float

Global volume factor for all sounds, a value from 0 to 1.

static width : Int

Width of the game.

static windowHeight : Int

Height of the window.

static windowWidth : Int

Width of the window.

static alarm (delay : Float, complete : Void ->Void, , type : TweenType, tweener : Tweener) : Alarm

Schedules a callback for the future. Shorthand for creating an Alarm tween, starting it and adding it to a Tweener.

static clear<T> (array : Array<T>) : Void

Empties an array of its' contents

static frames (from : Int, to : Int, skip : Int = 0) : Array<Int>

Gets an array of frame indices.

static indexOf<T> (arr : Array<T>, v : T) : Int

Optimized version of Lambda.indexOf for Array on dynamic platforms (Lambda.indexOf is less performant on those targets).

static insertSortedKey<T> (list : Array<T>, key : T, compare : T ->T ->Int, ) : Void

Binary insertion sort

static next<T> (current : T, options : Array<T>, loop : Bool = true) : T

Returns the next item after current in the list of options.

static prev<T> (current : T, options : Array<T>, loop : Bool = true) : T

Returns the item previous to the current in the list of options.

static resetCamera () : Void

Resets the camera position.

static resize (width : Int, height : Int) : Void

Resize the screen.

static setCamera (x : Float = 0, y : Float = 0) : Void

Sets the camera position.

static shuffle<T> (a : Array<T>) : Void

Shuffles the elements in the array.

static swap<T> (current : T, a : T, b : T) : T

Swaps the current item between a and b. Useful for quick state/string/value swapping.

static timeFlag () : Float

Sets a time flag.

static tween (object : Dynamic, values : Dynamic, duration : Float, ?options : Dynamic) : MultiVarTween

Tweens numeric public properties of an Object. Shorthand for creating a MultiVarTween tween, starting it and adding it to a Tweener.