Game

Instance Constructors

new Game(width: |[JsNumber, String] = js.native, height: |[JsNumber, String] = js.native, renderer: Int = js.native, parent: |[String, HTMLElement] = js.native, state: State = js.native, transparent: Boolean = js.native, antialias: Boolean = js.native, physicsConfig: RawOptions = js.native)

width
The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.
height
The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.
renderer
Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).
parent
The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
state
The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
transparent
Use a transparent canvas background or not.
antialias
Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
physicsConfig
A physics configuration object to pass to the Physics world on creation.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def add: GameObjectFactory

Reference to the Phaser.GameObjectFactory.
val antialias: Boolean

Draw all image textures anti-aliased or not.
Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def cache: Cache

Reference to the assets cache.
def camera: Camera

A handy reference to world.camera.
var clearBeforeRender: Boolean

Clear the Canvas each frame before rendering the display list.
Clear the Canvas each frame before rendering the display list. You can set this to false to gain some performance if your game always contains a background that completely fills the display.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def config: GameConfigObject

The Phaser.Game configuration object.
def context: CanvasRenderingContext2D

A handy reference to renderer.context (only set for CANVAS games, not WebGL)
def create: Create

The Asset Generator.
def debug: Debug

A set of useful debug utilities.
def device: Device

Contains device information and capabilities.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forceSingleUpdate: Boolean

Should the game loop force a logic update, regardless of the delta timer? Set to true if you know you need this.
Should the game loop force a logic update, regardless of the delta timer? Set to true if you know you need this. You can toggle it on the fly.
def fpsProblemNotifier: Signal

If the game is struggling to maintain the desired FPS, this signal will be dispatched.
If the game is struggling to maintain the desired FPS, this signal will be dispatched. The desired/chosen FPS should probably be closer to the Phaser.Time#suggestedFps value.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val height: |[JsNumber, String]

The height of your game in game pixels.
The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.
def id: Int

Phaser Game ID (for when Pixi supports multiple instances).
def input: Input

Reference to the input manager
def isBooted: Boolean

Whether the game engine is booted, aka available.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
def isRunning: Boolean

Is game running or paused?
def load: Loader

Reference to the assets loader.
def lockRender: Boolean

If false Phaser will automatically render the display list every update.
If false Phaser will automatically render the display list every update. If true the render loop will be skipped. You can toggle this value at run-time to gain exact control over when Phaser renders. This can be useful in certain types of game or application.
Please note that if you don't render the display list then none of the game object transforms will be updated, so use this value carefully.
def make: GameObjectCreator
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val parent: |[String, HTMLElement]

The DOM element into which this games canvas will be injected.
The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
def physics: Physics
val physicsConfig: RawOptions

A physics configuration object to pass to the Physics world on creation.
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val renderer: Int

Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).
def rnd: RandomDataGenerator
val state: State

The default state object.
The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def time: Time
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val transparent: Boolean

Use a transparent canvas background or not.
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val width: |[JsNumber, String]

The width of your game in game pixels.
The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.
def world: World

Related Doc: package phaser

class Game extends Object

Instance Constructors

new Game(width: |[JsNumber, String] = js.native, height: |[JsNumber, String] = js.native, renderer: Int = js.native, parent: |[String, HTMLElement] = js.native, state: State = js.native, transparent: Boolean = js.native, antialias: Boolean = js.native, physicsConfig: RawOptions = js.native)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def add: GameObjectFactory

val antialias: Boolean

final def asInstanceOf[T0]: T0

def cache: Cache

def camera: Camera

var clearBeforeRender: Boolean

def clone(): AnyRef

def config: GameConfigObject

def context: CanvasRenderingContext2D

def create: Create

def debug: Debug

def device: Device

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def forceSingleUpdate: Boolean

def fpsProblemNotifier: Signal

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val height: |[JsNumber, String]

def id: Int

def input: Input

def isBooted: Boolean

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

def isRunning: Boolean

def load: Loader

def lockRender: Boolean

def make: GameObjectCreator

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val parent: |[String, HTMLElement]

def physics: Physics

val physicsConfig: RawOptions

def propertyIsEnumerable(v: String): Boolean

val renderer: Int

def rnd: RandomDataGenerator

val state: State

final def synchronized[T0](arg0: ⇒ T0): T0

def time: Time

def toLocaleString(): String

def toString(): String

val transparent: Boolean

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val width: |[JsNumber, String]

def world: World

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped