mirror of
https://github.com/photonstorm/phaser
synced 2024-09-20 14:31:55 +00:00
Doc formatting
This commit is contained in:
parent
1c311a73df
commit
8fc31ed83b
1 changed files with 18 additions and 0 deletions
|
@ -68,16 +68,19 @@ module Phaser {
|
|||
* Local private reference to game.
|
||||
*/
|
||||
private _game: Game;
|
||||
|
||||
/**
|
||||
* Background color of the stage.
|
||||
* @type {string}
|
||||
*/
|
||||
private _bgColor: string;
|
||||
|
||||
/**
|
||||
* This will be displayed when Phaser is started without any default functions or State
|
||||
* @type {BootScreen}
|
||||
*/
|
||||
private _bootScreen;
|
||||
|
||||
/**
|
||||
* This will be displayed whenever the game loses focus or the player switches to another browser tab.
|
||||
* @type {PauseScreen}
|
||||
|
@ -89,6 +92,7 @@ module Phaser {
|
|||
* @type {number}
|
||||
*/
|
||||
public static ORIENTATION_LANDSCAPE: number = 0;
|
||||
|
||||
/**
|
||||
* Screen orientation enum: Portrait.
|
||||
* @type {number}
|
||||
|
@ -100,48 +104,57 @@ module Phaser {
|
|||
* @type {Rectangle}
|
||||
*/
|
||||
public bounds: Rectangle;
|
||||
|
||||
/**
|
||||
* Asperct ratio, thus: width / height.
|
||||
* @type {number}
|
||||
*/
|
||||
public aspectRatio: number;
|
||||
|
||||
/**
|
||||
* Clear the whole stage every frame? (Default to true)
|
||||
* @type {boolean}
|
||||
*/
|
||||
public clear: bool = true;
|
||||
|
||||
/**
|
||||
* Canvas element used by engine.
|
||||
* @type {HTMLCanvasElement}
|
||||
*/
|
||||
public canvas: HTMLCanvasElement;
|
||||
|
||||
/**
|
||||
* Render context of stage's canvas.
|
||||
* @type {CanvasRenderingContext2D}
|
||||
*/
|
||||
public context: CanvasRenderingContext2D;
|
||||
|
||||
/**
|
||||
* Do not use pause screen when game is paused?
|
||||
* (Default to false, aka always use PauseScreen)
|
||||
* @type {boolean}
|
||||
*/
|
||||
public disablePauseScreen: bool = false;
|
||||
|
||||
/**
|
||||
* Do not use boot screen when engine starts?
|
||||
* (Default to false, aka always use BootScreen)
|
||||
* @type {boolean}
|
||||
*/
|
||||
public disableBootScreen: bool = false;
|
||||
|
||||
/**
|
||||
* Offset from this stage to the canvas element.
|
||||
* @type {Point}
|
||||
*/
|
||||
public offset: Point;
|
||||
|
||||
/**
|
||||
* This object manages scaling of the game, see(StageScaleMode).
|
||||
* @type {StageScaleMode}
|
||||
*/
|
||||
public scale: StageScaleMode;
|
||||
|
||||
/**
|
||||
* Which mode will the game be scaled.
|
||||
* Available: StageScaleMode.EXACT_FIT, StageScaleMode.NO_SCALE, StageScaleMode.SHOW_ALL.
|
||||
|
@ -154,16 +167,19 @@ module Phaser {
|
|||
* @type {number}
|
||||
*/
|
||||
public minScaleX: number = null;
|
||||
|
||||
/**
|
||||
* Maximal scale factor of x-axis.
|
||||
* @type {number}
|
||||
*/
|
||||
public maxScaleX: number = null;
|
||||
|
||||
/**
|
||||
* Minimal scale factor of y-axis.
|
||||
* @type {number}
|
||||
*/
|
||||
public minScaleY: number = null;
|
||||
|
||||
/**
|
||||
* Maximal scale factor of y-axis.
|
||||
* @type {number}
|
||||
|
@ -247,11 +263,13 @@ module Phaser {
|
|||
* @type {string}
|
||||
*/
|
||||
public strokeStyle: string;
|
||||
|
||||
/**
|
||||
* Canvas lineWidth.
|
||||
* @type {number}
|
||||
*/
|
||||
public lineWidth: number;
|
||||
|
||||
/**
|
||||
* Canvas fillStyle.
|
||||
* @type {string}
|
||||
|
|
Loading…
Reference in a new issue