Skip to content

Commit 8e7944a

Browse files
committed
Updated EventEmitter reference
1 parent 3f0ee70 commit 8e7944a

3 files changed

Lines changed: 18 additions & 23 deletions

File tree

src/boot/VisibilityHandler.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
* @fires Phaser.Boot.VisibilityHandler#focus
4949
* @since 3.0.0
5050
*
51-
* @param {Phaser.EventEmitter} eventEmitter - The EventEmitter that will emit the visibility events.
51+
* @param {Phaser.Events.EventEmitter} eventEmitter - The EventEmitter that will emit the visibility events.
5252
*/
5353
var VisibilityHandler = function (eventEmitter)
5454
{

src/events/EventEmitter.js

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ var PluginManager = require('../boot/PluginManager');
1717
* EventEmitter is a Scene Systems plugin compatible version of eventemitter3.
1818
*
1919
* @class EventEmitter
20-
* @extends EventEmitter
2120
* @memberOf Phaser.Events
2221
* @constructor
2322
* @since 3.0.0
@@ -57,14 +56,10 @@ var EventEmitter = new Class({
5756

5857
});
5958

60-
/**
61-
* @namespace EventEmitter
62-
*/
63-
6459
/**
6560
* Return an array listing the events for which the emitter has registered listeners.
6661
*
67-
* @method EventEmitter#eventNames
62+
* @method Phaser.Events.EventEmitter#eventNames
6863
* @since 3.0.0
6964
*
7065
* @return {array}
@@ -73,7 +68,7 @@ var EventEmitter = new Class({
7368
/**
7469
* Return the listeners registered for a given event.
7570
*
76-
* @method EventEmitter#listeners
71+
* @method Phaser.Events.EventEmitter#listeners
7772
* @since 3.0.0
7873
*
7974
* @param {(string|symbol)} event - The event name.
@@ -84,7 +79,7 @@ var EventEmitter = new Class({
8479
/**
8580
* Return the number of listeners listening to a given event.
8681
*
87-
* @method EventEmitter#listenerCount
82+
* @method Phaser.Events.EventEmitter#listenerCount
8883
* @since 3.0.0
8984
*
9085
* @param {(string|symbol)} event - The event name.
@@ -95,7 +90,7 @@ var EventEmitter = new Class({
9590
/**
9691
* Calls each of the listeners registered for a given event.
9792
*
98-
* @method EventEmitter#emit
93+
* @method Phaser.Events.EventEmitter#emit
9994
* @since 3.0.0
10095
*
10196
* @param {(string|symbol)} event - The event name.
@@ -106,79 +101,79 @@ var EventEmitter = new Class({
106101
/**
107102
* Add a listener for a given event.
108103
*
109-
* @method EventEmitter#on
104+
* @method Phaser.Events.EventEmitter#on
110105
* @since 3.0.0
111106
*
112107
* @param {(string|symbol)} event - The event name.
113108
* @param {function} fn - The listener function.
114109
* @param {*} [context=this] - The context to invoke the listener with.
115110
*
116-
* @return {EventEmitter} `this`.
111+
* @return {Phaser.Events.EventEmitter} `this`.
117112
*/
118113

119114
/**
120115
* Add a listener for a given event.
121116
*
122-
* @method EventEmitter#addListener
117+
* @method Phaser.Events.EventEmitter#addListener
123118
* @since 3.0.0
124119
*
125120
* @param {(string|symbol)} event - The event name.
126121
* @param {function} fn - The listener function.
127122
* @param {*} [context=this] - The context to invoke the listener with.
128123
*
129-
* @return {EventEmitter} `this`.
124+
* @return {Phaser.Events.EventEmitter} `this`.
130125
*/
131126

132127
/**
133128
* Add a one-time listener for a given event.
134129
*
135-
* @method EventEmitter#once
130+
* @method Phaser.Events.EventEmitter#once
136131
* @since 3.0.0
137132
*
138133
* @param {(string|symbol)} event - The event name.
139134
* @param {function} fn - The listener function.
140135
* @param {*} [context=this] - The context to invoke the listener with.
141136
*
142-
* @return {EventEmitter} `this`.
137+
* @return {Phaser.Events.EventEmitter} `this`.
143138
*/
144139

145140
/**
146141
* Remove the listeners of a given event.
147142
*
148-
* @method EventEmitter#removeListener
143+
* @method Phaser.Events.EventEmitter#removeListener
149144
* @since 3.0.0
150145
*
151146
* @param {(string|symbol)} event - The event name.
152147
* @param {function} fn - Only remove the listeners that match this function.
153148
* @param {*} context - Only remove the listeners that have this context.
154149
* @param {boolean} once - Only remove one-time listeners.
155150
*
156-
* @return {EventEmitter} `this`.
151+
* @return {Phaser.Events.EventEmitter} `this`.
157152
*/
158153

159154
/**
160155
* Remove the listeners of a given event.
161156
*
162-
* @method EventEmitter#off
157+
* @method Phaser.Events.EventEmitter#off
163158
* @since 3.0.0
164159
*
165160
* @param {(string|symbol)} event - The event name.
166161
* @param {function} fn - Only remove the listeners that match this function.
167162
* @param {*} context - Only remove the listeners that have this context.
168163
* @param {boolean} once - Only remove one-time listeners.
169164
*
170-
* @return {EventEmitter} `this`.
165+
* @return {Phaser.Events.EventEmitter} `this`.
171166
*/
172167

173168
/**
174169
* Remove all listeners, or those of the specified event.
175170
*
176-
* @method EventEmitter#removeAllListeners
171+
* @method Phaser.Events.EventEmitter#removeAllListeners
177172
* @since 3.0.0
178173
*
179174
* @param {(string|symbol)} [event] - The event name.
180175
*
181-
* @return {EventEmitter} `this`.
176+
* @return {Phaser.Events.EventEmitter} `this`.
182177
*/
183178

184179
PluginManager.register('EventEmitter', EventEmitter, 'events');

src/gameobjects/GameObject.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ var EventEmitter = require('eventemitter3');
1717
*
1818
* @class GameObject
1919
* @memberOf Phaser.GameObjects
20-
* @extends EventEmitter
20+
* @extends Phaser.Events.EventEmitter
2121
* @constructor
2222
* @since 3.0.0
2323
*

0 commit comments

Comments
 (0)