Skip to content

Commit bc87630

Browse files
photonstormphotonstorm
committed
Added jsdocs.
1 parent cbb0f23 commit bc87630

2 files changed

Lines changed: 213 additions & 2 deletions

File tree

‎src/scene/const.js‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,94 @@
11

22
module.exports = {
33

4+
/**
5+
* Scene state.
6+
*
7+
* @name Phaser.Scenes.PENDING
8+
* @type {integer}
9+
* @since 3.0.0
10+
*/
411
PENDING: 0,
12+
13+
/**
14+
* Scene state.
15+
*
16+
* @name Phaser.Scenes.INIT
17+
* @type {integer}
18+
* @since 3.0.0
19+
*/
520
INIT: 1,
21+
22+
/**
23+
* Scene state.
24+
*
25+
* @name Phaser.Scenes.START
26+
* @type {integer}
27+
* @since 3.0.0
28+
*/
629
START: 2,
30+
31+
/**
32+
* Scene state.
33+
*
34+
* @name Phaser.Scenes.LOADING
35+
* @type {integer}
36+
* @since 3.0.0
37+
*/
738
LOADING: 3,
39+
40+
/**
41+
* Scene state.
42+
*
43+
* @name Phaser.Scenes.CREATING
44+
* @type {integer}
45+
* @since 3.0.0
46+
*/
847
CREATING: 4,
48+
49+
/**
50+
* Scene state.
51+
*
52+
* @name Phaser.Scenes.RUNNING
53+
* @type {integer}
54+
* @since 3.0.0
55+
*/
956
RUNNING: 5,
57+
58+
/**
59+
* Scene state.
60+
*
61+
* @name Phaser.Scenes.PAUSED
62+
* @type {integer}
63+
* @since 3.0.0
64+
*/
1065
PAUSED: 6,
66+
67+
/**
68+
* Scene state.
69+
*
70+
* @name Phaser.Scenes.SLEEPING
71+
* @type {integer}
72+
* @since 3.0.0
73+
*/
1174
SLEEPING: 7,
75+
76+
/**
77+
* Scene state.
78+
*
79+
* @name Phaser.Scenes.SHUTDOWN
80+
* @type {integer}
81+
* @since 3.0.0
82+
*/
1283
SHUTDOWN: 8,
84+
85+
/**
86+
* Scene state.
87+
*
88+
* @name Phaser.Scenes.DESTROYED
89+
* @type {integer}
90+
* @since 3.0.0
91+
*/
1392
DESTROYED: 9
1493

1594
};

‎src/tweens/tween/const.js‎

Lines changed: 134 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,158 @@
11
var TWEEN_CONST = {
22

3-
// TweenData:
4-
3+
/**
4+
* TweenData state.
5+
*
6+
* @name Phaser.Tweens.CREATED
7+
* @type {integer}
8+
* @since 3.0.0
9+
*/
510
CREATED: 0,
11+
12+
/**
13+
* TweenData state.
14+
*
15+
* @name Phaser.Tweens.INIT
16+
* @type {integer}
17+
* @since 3.0.0
18+
*/
619
INIT: 1,
20+
21+
/**
22+
* TweenData state.
23+
*
24+
* @name Phaser.Tweens.OFFSET_DELAY
25+
* @type {integer}
26+
* @since 3.0.0
27+
*/
728
DELAY: 2,
29+
30+
/**
31+
* TweenData state.
32+
*
33+
* @name Phaser.Tweens.OFFSET_DELAY
34+
* @type {integer}
35+
* @since 3.0.0
36+
*/
837
OFFSET_DELAY: 3,
38+
39+
/**
40+
* TweenData state.
41+
*
42+
* @name Phaser.Tweens.PLAYING_FORWARD
43+
* @type {integer}
44+
* @since 3.0.0
45+
*/
946
PENDING_RENDER: 4,
47+
48+
/**
49+
* TweenData state.
50+
*
51+
* @name Phaser.Tweens.PLAYING_FORWARD
52+
* @type {integer}
53+
* @since 3.0.0
54+
*/
1055
PLAYING_FORWARD: 5,
56+
57+
/**
58+
* TweenData state.
59+
*
60+
* @name Phaser.Tweens.PLAYING_BACKWARD
61+
* @type {integer}
62+
* @since 3.0.0
63+
*/
1164
PLAYING_BACKWARD: 6,
65+
66+
/**
67+
* TweenData state.
68+
*
69+
* @name Phaser.Tweens.HOLD_DELAY
70+
* @type {integer}
71+
* @since 3.0.0
72+
*/
1273
HOLD_DELAY: 7,
74+
75+
/**
76+
* TweenData state.
77+
*
78+
* @name Phaser.Tweens.REPEAT_DELAY
79+
* @type {integer}
80+
* @since 3.0.0
81+
*/
1382
REPEAT_DELAY: 8,
83+
84+
/**
85+
* TweenData state.
86+
*
87+
* @name Phaser.Tweens.COMPLETE
88+
* @type {integer}
89+
* @since 3.0.0
90+
*/
1491
COMPLETE: 9,
1592

1693
// Tween specific (starts from 20 to cleanly allow extra TweenData consts in the future)
1794

95+
/**
96+
* Tween state.
97+
*
98+
* @name Phaser.Tweens.PENDING_ADD
99+
* @type {integer}
100+
* @since 3.0.0
101+
*/
18102
PENDING_ADD: 20,
103+
104+
/**
105+
* Tween state.
106+
*
107+
* @name Phaser.Tweens.LOOP_DELAY
108+
* @type {integer}
109+
* @since 3.0.0
110+
*/
19111
PAUSED: 21,
112+
113+
/**
114+
* Tween state.
115+
*
116+
* @name Phaser.Tweens.LOOP_DELAY
117+
* @type {integer}
118+
* @since 3.0.0
119+
*/
20120
LOOP_DELAY: 22,
121+
122+
/**
123+
* Tween state.
124+
*
125+
* @name Phaser.Tweens.ACTIVE
126+
* @type {integer}
127+
* @since 3.0.0
128+
*/
21129
ACTIVE: 23,
130+
131+
/**
132+
* Tween state.
133+
*
134+
* @name Phaser.Tweens.COMPLETE_DELAY
135+
* @type {integer}
136+
* @since 3.0.0
137+
*/
22138
COMPLETE_DELAY: 24,
139+
140+
/**
141+
* Tween state.
142+
*
143+
* @name Phaser.Tweens.PENDING_REMOVE
144+
* @type {integer}
145+
* @since 3.0.0
146+
*/
23147
PENDING_REMOVE: 25,
148+
149+
/**
150+
* Tween state.
151+
*
152+
* @name Phaser.Tweens.REMOVED
153+
* @type {integer}
154+
* @since 3.0.0
155+
*/
24156
REMOVED: 26
25157

26158
};

0 commit comments

Comments
 (0)