-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
Bob.js
435 lines (384 loc) · 11.5 KB
/
Bob.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var Class = require('../../utils/Class');
var Frame = require('../../textures/Frame');
/**
* @classdesc
* A Bob Game Object.
*
* A Bob belongs to a Blitter Game Object. The Blitter is responsible for managing and rendering this object.
*
* A Bob has a position, alpha value and a frame from a texture that it uses to render with. You can also toggle
* the flipped and visible state of the Bob. The Frame the Bob uses to render can be changed dynamically, but it
* must be a Frame within the Texture used by the parent Blitter.
*
* Bob positions are relative to the Blitter parent. So if you move the Blitter parent, all Bob children will
* have their positions impacted by this change as well.
*
* You can manipulate Bob objects directly from your game code, but the creation and destruction of them should be
* handled via the Blitter parent.
*
* @class Bob
* @memberof Phaser.GameObjects
* @constructor
* @since 3.0.0
*
* @param {Phaser.GameObjects.Blitter} blitter - The parent Blitter object is responsible for updating this Bob.
* @param {number} x - The horizontal position of this Game Object in the world, relative to the parent Blitter position.
* @param {number} y - The vertical position of this Game Object in the world, relative to the parent Blitter position.
* @param {(string|number)} frame - The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.
* @param {boolean} visible - Should the Bob render visible or not to start with?
*/
var Bob = new Class({
initialize:
function Bob (blitter, x, y, frame, visible)
{
/**
* The Blitter object that this Bob belongs to.
*
* @name Phaser.GameObjects.Bob#parent
* @type {Phaser.GameObjects.Blitter}
* @since 3.0.0
*/
this.parent = blitter;
/**
* The x position of this Bob, relative to the x position of the Blitter.
*
* @name Phaser.GameObjects.Bob#x
* @type {number}
* @since 3.0.0
*/
this.x = x;
/**
* The y position of this Bob, relative to the y position of the Blitter.
*
* @name Phaser.GameObjects.Bob#y
* @type {number}
* @since 3.0.0
*/
this.y = y;
/**
* The frame that the Bob uses to render with.
* To change the frame use the `Bob.setFrame` method.
*
* @name Phaser.GameObjects.Bob#frame
* @type {Phaser.Textures.Frame}
* @protected
* @since 3.0.0
*/
this.frame = frame;
/**
* A blank object which can be used to store data related to this Bob in.
*
* @name Phaser.GameObjects.Bob#data
* @type {object}
* @default {}
* @since 3.0.0
*/
this.data = {};
/**
* The tint value of this Bob.
*
* @name Phaser.GameObjects.Bob#tint
* @type {number}
* @default 0xffffff
* @since 3.20.0
*/
this.tint = 0xffffff;
/**
* The visible state of this Bob.
*
* @name Phaser.GameObjects.Bob#_visible
* @type {boolean}
* @private
* @since 3.0.0
*/
this._visible = visible;
/**
* The alpha value of this Bob.
*
* @name Phaser.GameObjects.Bob#_alpha
* @type {number}
* @private
* @default 1
* @since 3.0.0
*/
this._alpha = 1;
/**
* The horizontally flipped state of the Bob.
* A Bob that is flipped horizontally will render inversed on the horizontal axis.
* Flipping always takes place from the middle of the texture.
*
* @name Phaser.GameObjects.Bob#flipX
* @type {boolean}
* @since 3.0.0
*/
this.flipX = false;
/**
* The vertically flipped state of the Bob.
* A Bob that is flipped vertically will render inversed on the vertical axis (i.e. upside down)
* Flipping always takes place from the middle of the texture.
*
* @name Phaser.GameObjects.Bob#flipY
* @type {boolean}
* @since 3.0.0
*/
this.flipY = false;
/**
* Private read-only property used to allow Bobs to have physics bodies.
*
* @name Phaser.GameObjects.Bob#hasTransformComponent
* @type {boolean}
* @private
* @readonly
* @since 3.60.0
*/
this.hasTransformComponent = true;
},
/**
* Changes the Texture Frame being used by this Bob.
* The frame must be part of the Texture the parent Blitter is using.
* If no value is given it will use the default frame of the Blitter parent.
*
* @method Phaser.GameObjects.Bob#setFrame
* @since 3.0.0
*
* @param {(string|number|Phaser.Textures.Frame)} [frame] - The frame to be used during rendering.
*
* @return {this} This Bob Game Object.
*/
setFrame: function (frame)
{
if (frame === undefined)
{
this.frame = this.parent.frame;
}
else if (frame instanceof Frame && frame.texture === this.parent.texture)
{
this.frame = frame;
}
else
{
this.frame = this.parent.texture.get(frame);
}
return this;
},
/**
* Resets the horizontal and vertical flipped state of this Bob back to their default un-flipped state.
*
* @method Phaser.GameObjects.Bob#resetFlip
* @since 3.0.0
*
* @return {this} This Bob Game Object.
*/
resetFlip: function ()
{
this.flipX = false;
this.flipY = false;
return this;
},
/**
* Resets this Bob.
*
* Changes the position to the values given, and optionally changes the frame.
*
* Also resets the flipX and flipY values, sets alpha back to 1 and visible to true.
*
* @method Phaser.GameObjects.Bob#reset
* @since 3.0.0
*
* @param {number} x - The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.
* @param {number} y - The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.
* @param {(string|number|Phaser.Textures.Frame)} [frame] - The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.
*
* @return {this} This Bob Game Object.
*/
reset: function (x, y, frame)
{
this.x = x;
this.y = y;
this.flipX = false;
this.flipY = false;
this._alpha = 1;
this._visible = true;
this.parent.dirty = true;
if (frame)
{
this.setFrame(frame);
}
return this;
},
/**
* Changes the position of this Bob to the values given.
*
* @method Phaser.GameObjects.Bob#setPosition
* @since 3.20.0
*
* @param {number} x - The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.
* @param {number} y - The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.
*
* @return {this} This Bob Game Object.
*/
setPosition: function (x, y)
{
this.x = x;
this.y = y;
return this;
},
/**
* Sets the horizontal flipped state of this Bob.
*
* @method Phaser.GameObjects.Bob#setFlipX
* @since 3.0.0
*
* @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.
*
* @return {this} This Bob Game Object.
*/
setFlipX: function (value)
{
this.flipX = value;
return this;
},
/**
* Sets the vertical flipped state of this Bob.
*
* @method Phaser.GameObjects.Bob#setFlipY
* @since 3.0.0
*
* @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.
*
* @return {this} This Bob Game Object.
*/
setFlipY: function (value)
{
this.flipY = value;
return this;
},
/**
* Sets the horizontal and vertical flipped state of this Bob.
*
* @method Phaser.GameObjects.Bob#setFlip
* @since 3.0.0
*
* @param {boolean} x - The horizontal flipped state. `false` for no flip, or `true` to be flipped.
* @param {boolean} y - The horizontal flipped state. `false` for no flip, or `true` to be flipped.
*
* @return {this} This Bob Game Object.
*/
setFlip: function (x, y)
{
this.flipX = x;
this.flipY = y;
return this;
},
/**
* Sets the visibility of this Bob.
*
* An invisible Bob will skip rendering.
*
* @method Phaser.GameObjects.Bob#setVisible
* @since 3.0.0
*
* @param {boolean} value - The visible state of the Game Object.
*
* @return {this} This Bob Game Object.
*/
setVisible: function (value)
{
this.visible = value;
return this;
},
/**
* Set the Alpha level of this Bob. The alpha controls the opacity of the Game Object as it renders.
* Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.
*
* A Bob with alpha 0 will skip rendering.
*
* @method Phaser.GameObjects.Bob#setAlpha
* @since 3.0.0
*
* @param {number} value - The alpha value used for this Bob. Between 0 and 1.
*
* @return {this} This Bob Game Object.
*/
setAlpha: function (value)
{
this.alpha = value;
return this;
},
/**
* Sets the tint of this Bob.
*
* @method Phaser.GameObjects.Bob#setTint
* @since 3.20.0
*
* @param {number} value - The tint value used for this Bob. Between 0 and 0xffffff.
*
* @return {this} This Bob Game Object.
*/
setTint: function (value)
{
this.tint = value;
return this;
},
/**
* Destroys this Bob instance.
* Removes itself from the Blitter and clears the parent, frame and data properties.
*
* @method Phaser.GameObjects.Bob#destroy
* @since 3.0.0
*/
destroy: function ()
{
this.parent.dirty = true;
this.parent.children.remove(this);
this.parent = undefined;
this.frame = undefined;
this.data = undefined;
},
/**
* The visible state of the Bob.
*
* An invisible Bob will skip rendering.
*
* @name Phaser.GameObjects.Bob#visible
* @type {boolean}
* @since 3.0.0
*/
visible: {
get: function ()
{
return this._visible;
},
set: function (value)
{
this.parent.dirty |= (this._visible !== value);
this._visible = value;
}
},
/**
* The alpha value of the Bob, between 0 and 1.
*
* A Bob with alpha 0 will skip rendering.
*
* @name Phaser.GameObjects.Bob#alpha
* @type {number}
* @since 3.0.0
*/
alpha: {
get: function ()
{
return this._alpha;
},
set: function (value)
{
this.parent.dirty |= ((this._alpha > 0) !== (value > 0));
this._alpha = value;
}
}
});
module.exports = Bob;