Skip to content

Commit 2f1f680

Browse files
committed
Docs fixes.
1 parent 75d7fa1 commit 2f1f680

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

src/core/StateManager.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,62 +67,62 @@ Phaser.StateManager = function (game, pendingState) {
6767
this.current = '';
6868

6969
/**
70-
* @property {function} onInitCallback - This will be called when the state is started (i.e. set as the current active state).
70+
* @property {function} onInitCallback - This is called when the state is set as the active state.
7171
*/
7272
this.onInitCallback = null;
7373

7474
/**
75-
* @property {function} onPreloadCallback - This will be called when init states (loading assets...).
75+
* @property {function} onPreloadCallback - This is called when the state starts to load assets.
7676
*/
7777
this.onPreloadCallback = null;
7878

7979
/**
80-
* @property {function} onCreateCallback - This will be called when create states (setup states...).
80+
* @property {function} onCreateCallback - This is called when the state preload has finished and creation begins.
8181
*/
8282
this.onCreateCallback = null;
8383

8484
/**
85-
* @property {function} onUpdateCallback - This will be called when State is updated, this doesn't happen during load (@see onLoadUpdateCallback).
85+
* @property {function} onUpdateCallback - This is called when the state is updated, every game loop. It doesn't happen during preload (@see onLoadUpdateCallback).
8686
*/
8787
this.onUpdateCallback = null;
8888

8989
/**
90-
* @property {function} onRenderCallback - This will be called when the State is rendered, this doesn't happen during load (see onLoadRenderCallback).
90+
* @property {function} onRenderCallback - This is called post-render. It doesn't happen during preload (see onLoadRenderCallback).
9191
*/
9292
this.onRenderCallback = null;
9393

9494
/**
95-
* @property {function} onPreRenderCallback - This will be called before the State is rendered and before the stage is cleared.
95+
* @property {function} onPreRenderCallback - This is called before the state is rendered and before the stage is cleared.
9696
*/
9797
this.onPreRenderCallback = null;
9898

9999
/**
100-
* @property {function} onLoadUpdateCallback - This will be called when the State is updated but only during the load process.
100+
* @property {function} onLoadUpdateCallback - This is called when the State is updated during the preload phase.
101101
*/
102102
this.onLoadUpdateCallback = null;
103103

104104
/**
105-
* @property {function} onLoadRenderCallback - This will be called when the State is rendered but only during the load process.
105+
* @property {function} onLoadRenderCallback - This is called when the State is rendered during the preload phase.
106106
*/
107107
this.onLoadRenderCallback = null;
108108

109109
/**
110-
* @property {function} onPausedCallback - This will be called once each time the game is paused.
110+
* @property {function} onPausedCallback - This is called when the game is paused.
111111
*/
112112
this.onPausedCallback = null;
113113

114114
/**
115-
* @property {function} onResumedCallback - This will be called once each time the game is resumed from a paused state.
115+
* @property {function} onResumedCallback - This is called when the game is resumed from a paused state.
116116
*/
117117
this.onResumedCallback = null;
118118

119119
/**
120-
* @property {function} onPauseUpdateCallback - This will be called every frame while the game is paused.
120+
* @property {function} onPauseUpdateCallback - This is called every frame while the game is paused.
121121
*/
122122
this.onPauseUpdateCallback = null;
123123

124124
/**
125-
* @property {function} onShutDownCallback - This will be called when the state is shut down (i.e. swapped to another state).
125+
* @property {function} onShutDownCallback - This is called when the state is shut down (i.e. swapped to another state).
126126
*/
127127
this.onShutDownCallback = null;
128128

0 commit comments

Comments
 (0)