Added jsdocs.

This commit is contained in:
Richard Davey 2018-02-09 18:03:39 +00:00
parent cbb0f236f5
commit bc87630d61
2 changed files with 213 additions and 2 deletions

View file

@ -1,15 +1,94 @@
module.exports = {
/**
* Scene state.
*
* @name Phaser.Scenes.PENDING
* @type {integer}
* @since 3.0.0
*/
PENDING: 0,
/**
* Scene state.
*
* @name Phaser.Scenes.INIT
* @type {integer}
* @since 3.0.0
*/
INIT: 1,
/**
* Scene state.
*
* @name Phaser.Scenes.START
* @type {integer}
* @since 3.0.0
*/
START: 2,
/**
* Scene state.
*
* @name Phaser.Scenes.LOADING
* @type {integer}
* @since 3.0.0
*/
LOADING: 3,
/**
* Scene state.
*
* @name Phaser.Scenes.CREATING
* @type {integer}
* @since 3.0.0
*/
CREATING: 4,
/**
* Scene state.
*
* @name Phaser.Scenes.RUNNING
* @type {integer}
* @since 3.0.0
*/
RUNNING: 5,
/**
* Scene state.
*
* @name Phaser.Scenes.PAUSED
* @type {integer}
* @since 3.0.0
*/
PAUSED: 6,
/**
* Scene state.
*
* @name Phaser.Scenes.SLEEPING
* @type {integer}
* @since 3.0.0
*/
SLEEPING: 7,
/**
* Scene state.
*
* @name Phaser.Scenes.SHUTDOWN
* @type {integer}
* @since 3.0.0
*/
SHUTDOWN: 8,
/**
* Scene state.
*
* @name Phaser.Scenes.DESTROYED
* @type {integer}
* @since 3.0.0
*/
DESTROYED: 9
};

View file

@ -1,26 +1,158 @@
var TWEEN_CONST = {
// TweenData:
/**
* TweenData state.
*
* @name Phaser.Tweens.CREATED
* @type {integer}
* @since 3.0.0
*/
CREATED: 0,
/**
* TweenData state.
*
* @name Phaser.Tweens.INIT
* @type {integer}
* @since 3.0.0
*/
INIT: 1,
/**
* TweenData state.
*
* @name Phaser.Tweens.OFFSET_DELAY
* @type {integer}
* @since 3.0.0
*/
DELAY: 2,
/**
* TweenData state.
*
* @name Phaser.Tweens.OFFSET_DELAY
* @type {integer}
* @since 3.0.0
*/
OFFSET_DELAY: 3,
/**
* TweenData state.
*
* @name Phaser.Tweens.PLAYING_FORWARD
* @type {integer}
* @since 3.0.0
*/
PENDING_RENDER: 4,
/**
* TweenData state.
*
* @name Phaser.Tweens.PLAYING_FORWARD
* @type {integer}
* @since 3.0.0
*/
PLAYING_FORWARD: 5,
/**
* TweenData state.
*
* @name Phaser.Tweens.PLAYING_BACKWARD
* @type {integer}
* @since 3.0.0
*/
PLAYING_BACKWARD: 6,
/**
* TweenData state.
*
* @name Phaser.Tweens.HOLD_DELAY
* @type {integer}
* @since 3.0.0
*/
HOLD_DELAY: 7,
/**
* TweenData state.
*
* @name Phaser.Tweens.REPEAT_DELAY
* @type {integer}
* @since 3.0.0
*/
REPEAT_DELAY: 8,
/**
* TweenData state.
*
* @name Phaser.Tweens.COMPLETE
* @type {integer}
* @since 3.0.0
*/
COMPLETE: 9,
// Tween specific (starts from 20 to cleanly allow extra TweenData consts in the future)
/**
* Tween state.
*
* @name Phaser.Tweens.PENDING_ADD
* @type {integer}
* @since 3.0.0
*/
PENDING_ADD: 20,
/**
* Tween state.
*
* @name Phaser.Tweens.LOOP_DELAY
* @type {integer}
* @since 3.0.0
*/
PAUSED: 21,
/**
* Tween state.
*
* @name Phaser.Tweens.LOOP_DELAY
* @type {integer}
* @since 3.0.0
*/
LOOP_DELAY: 22,
/**
* Tween state.
*
* @name Phaser.Tweens.ACTIVE
* @type {integer}
* @since 3.0.0
*/
ACTIVE: 23,
/**
* Tween state.
*
* @name Phaser.Tweens.COMPLETE_DELAY
* @type {integer}
* @since 3.0.0
*/
COMPLETE_DELAY: 24,
/**
* Tween state.
*
* @name Phaser.Tweens.PENDING_REMOVE
* @type {integer}
* @since 3.0.0
*/
PENDING_REMOVE: 25,
/**
* Tween state.
*
* @name Phaser.Tweens.REMOVED
* @type {integer}
* @since 3.0.0
*/
REMOVED: 26
};