-
Notifications
You must be signed in to change notification settings - Fork 491
/
PathManagerPlugin.js
413 lines (335 loc) · 11.8 KB
/
PathManagerPlugin.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
/**
* @author Richard Davey <rich@photonstorm.com>
* @author Pete Baron <pete@photonstorm.com>
* @copyright 2016 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* PathManager controls a list of Paths and a list of PathFollowers.
* It is the central control for the majority of the Pathing API.
*
* @class Phaser.Plugin.PathManager
* @constructor
* @param {Phaser.Game} game - A reference to the current Phaser.Game instance.
* @param {Phaser.PluginManager} parent - The Phaser Plugin Manager which looks after this plugin.
*/
Phaser.Plugin.PathManager = function (game, parent)
{
Phaser.Plugin.call(this, game, parent);
/**
* @property {array} _list - list of paths
* @private
*/
this._list = [];
/**
* @property {array} _followers - list of path followers
* @private
*/
this._followers = [];
this._branchRegistry = {};
};
Phaser.Plugin.PathManager.prototype = Object.create(Phaser.Plugin.prototype);
Phaser.Plugin.PathManager.prototype.constructor = Phaser.Plugin.PathManager;
/**
* create a new Path from JSON data
*
* JSON data format:
* required: "coordinateSystem":, "smoothness":, "loops":, "speed":, "pointList":[ {"x":, "y":}, ... ]
* optional: "branchFrom": { "path":, "point": }, "joinTo": { "path":, "point": }
*/
Phaser.Plugin.PathManager.prototype.createPathsFromJSON = function (jsonKey)
{
var parse = this.game.cache.getJSON(jsonKey);
var path;
var createdPaths = [];
var branchList = [];
parse.paths.forEach(function (config)
{
path = new Phaser.Path(config.coordinateSystem, config.loops);
path.name = config.name;
this.addPoints(path, config.pointList, config.speed);
this._list.push(path);
createdPaths.push(path);
config.pointList.reduce(function (list, pnt, index)
{
if (pnt.branchType === Phaser.Path.BranchTypes.ATTACHED)
{
list.push({
path: path.name,
branchPath: pnt.branchPath,
pointIndex: index,
type: pnt.branchType
});
}
else if (pnt.branchType === Phaser.Path.BranchTypes.JOINED)
{
list.push({
path: pnt.branchPath,
branchPath: path.name,
pointIndex: pnt.branchPointIndex,
type: pnt.branchType
});
}
return list;
}, branchList);
}, this);
branchList.forEach(function (branch)
{
var mainPath = this.findPathByName(branch.path);
var branchPath = this.findPathByName(branch.branchPath);
var mainPathPointIndex = branch.pointIndex;
if (branch.type === Phaser.Path.BranchTypes.ATTACHED)
{
this.attachBranch(branchPath, mainPath, mainPathPointIndex);
}
else if (branch.type === Phaser.Path.BranchTypes.JOINED)
{
this.joinBranch(branchPath, mainPath, mainPathPointIndex, false);
}
}, this);
return createdPaths;
};
Phaser.Plugin.PathManager.prototype.addPath = function (path)
{
// if path has points then addPoints, otherwise don't
// this.addPoints(path, parse.pointList, parse.speed);
this._list.push(path);
return path;
};
// create a branching path and attach the start to an existing path
// when a PathFollower encounters the attachment point, it will be able to switch onto this new branch
//
// @param: count {value, optional}, make this branch counted (it won't be taken until a follower has passed it enough times)
Phaser.Plugin.PathManager.prototype.attachBranch = function (branchPath, mainPath, mainPathPointIndex, count)
{
if (typeof mainPath === 'string')
{
mainPath = this.findPathByName(mainPath);
}
var branchFromPoint = new Phaser.PathPoint();
if (mainPath.getPathPoint(mainPathPointIndex, branchFromPoint))
{
// move the first point of the branchPath to the branchFromPoint location
branchPath.origin = branchFromPoint;
var branchToPoint = branchPath.getPathPointReference(0);
// attach the branch (use point reference so the changes go into the path)
var branchFromPointRef = mainPath.getPathPointReference(mainPathPointIndex);
this._branchAttach(branchFromPointRef, branchPath, 0);
branchFromPointRef.branchType = Phaser.Path.BranchTypes.ATTACHED;
// attach the branch's first point back to where it branched off from (for path reversal)
branchToPoint.branchPath = mainPath;
branchToPoint.branchPointIndex = mainPathPointIndex;
// make sure this branch knows that it's using offset coordinates based on the first path point location
branchPath.coordinateSystem = Phaser.Path.CoordinateSystems.OFFSET;
branchPath.type = Phaser.Path.PathTypes.BRANCH;
// set up counted branches data
if (count !== undefined)
{
branchFromPointRef.data = {
type: Phaser.PathPoint.DATA_COUNTER,
value: count
};
}
if (this._branchRegistry[branchPath.name])
{
this._branchRegistry[branchPath.name].push(branchFromPointRef);
}
else
{
this._branchRegistry[branchPath.name] = [ branchFromPointRef ];
}
}
};
// attach the end of a path to an existing path
// when a PathFollower encounters the attachment point, it will automatically switch onto the attached path
Phaser.Plugin.PathManager.prototype.joinBranch = function (branchPath, mainPath, mainPathPointIndex, addPoint)
{
if (typeof addPoint === 'undefined')
{
addPoint = true;
}
if (typeof mainPath === 'string')
{
mainPath = this.findPathByName(mainPath);
}
var mainPathJoinPoint, branchLastPoint;
mainPathJoinPoint = new Phaser.PathPoint();
mainPath.getPathPoint(mainPathPointIndex, mainPathJoinPoint);
if (mainPathJoinPoint)
{
if (addPoint)
{
var newBranchPoint = new Phaser.PathPoint();
if (branchPath.getPathPoint(0, newBranchPoint))
{
// make sure the newly added last path point is relative to the previously added first path point for the branch path by subtracting it out
branchLastPoint = branchPath.addPathPoint(mainPathJoinPoint.x - newBranchPoint.x, mainPathJoinPoint.y - newBranchPoint.y, mainPathJoinPoint.vx, mainPathJoinPoint.vy, 1.0);
this._branchAttach(branchLastPoint, mainPath, mainPathPointIndex);
}
}
else
{
branchLastPoint = branchPath.getPathPointReference(branchPath.length - 1);
this._branchAttach(branchLastPoint, mainPath, mainPathPointIndex);
}
branchLastPoint.branchType = Phaser.Path.BranchTypes.JOINED;
}
if (this._branchRegistry[branchPath.name])
{
this._branchRegistry[branchPath.name].push(branchLastPoint);
}
else
{
this._branchRegistry[branchPath.name] = [ branchLastPoint ];
}
};
// internal function, set the branching parameters of a PathPoint
Phaser.Plugin.PathManager.prototype._branchAttach = function (attachPoint, branchingPath, branchToPointIndex)
{
attachPoint.branchPath = branchingPath;
attachPoint.branchPointIndex = branchToPointIndex;
};
Phaser.Plugin.PathManager.prototype._branchDetach = function (attachedPoint)
{
attachedPoint.branchPath = null;
attachedPoint.branchPointIndex = null;
};
Phaser.Plugin.PathManager.prototype.removeBranch = function (branch)
{
if (typeof branch === 'string')
{
branch = this.findPathByName(branch);
}
this._branchRegistry[branch.name].forEach(function (point)
{
this._branchDetach(point);
}, this);
this._branchRegistry[branch.name] = null;
this.removePath(this.pathIndex(branch));
};
// @return: the Path object which is at 'index' in the list
Phaser.Plugin.PathManager.prototype.getPath = function (index)
{
return this._list[index];
};
// add a list of points to a Path
Phaser.Plugin.PathManager.prototype.addPoints = function (path, pointList, speed)
{
if (speed === undefined) { speed = 1.0; }
for (var i = 0; i < pointList.length; i++)
{
path.addPathPoint(pointList[i].x, pointList[i].y, pointList[i].vx, pointList[i].vy, speed, pointList[i].data);
}
return path.numPoints();
};
// @return: the Path object matching 'name' in the list
Phaser.Plugin.PathManager.prototype.findPathByName = function (name)
{
for (var i = 0; i < this._list.length; i++)
{
if (this._list[i].name == name)
{
return this._list[i];
}
}
return null;
};
Phaser.Plugin.PathManager.prototype.findPathByPoint = function (point)
{
var l = this._list.length;
for (var i = 0; i < l; i++)
{
if (this._list[i].pointIndex(point) > -1)
{
return this._list[i];
}
}
};
/*
* FOLLOWERS
*
* the following functions control PathFollower objects
*
*/
// create a new PathFollower and add it to the list
// @param: physicsAdjustTime - how quickly does a physics object attempt to get back to the path's virtual particle position (milliseconds), 0 = it's not a physics object
// @return: the new PathFollower object
Phaser.Plugin.PathManager.prototype.addFollower = function (path, follower, speed, rotationOffset, angularOffset, callbackAtEnd, physicsAdjustTime)
{
var f = new Phaser.PathFollower(path, follower, speed, rotationOffset, angularOffset, callbackAtEnd, physicsAdjustTime);
this._followers.push(f);
return f;
};
// update all PathFollower objects in the _followers list
// this will automatically move them along the Paths
// was called updateFollowers
Phaser.Plugin.PathManager.prototype.update = function ()
{
// move this to a plugin var
// var elapsedTime = 1.0;
for (var i = this._followers.length - 1; i >= 0; --i)
{
var f = this._followers[i];
// when a follower's update returns false, kill it
if (!f.update(this.game.time.elpased))
{
// callback for this follower when it dies
if (f.callbackAtEnd)
{
f.callbackAtEnd(f.follower);
}
// destroy the follower
f.destroy();
// remove the follower from the list
this._followers.splice(i, 1);
}
}
};
// remove all PathFollowers on this path without destroying their attached graphic objects
// (eg. a long line of enemies use a path to enter, then switch to AI control on arrival maintaining their relative positions)
Phaser.Plugin.PathManager.prototype.removeAllFollowers = function (path)
{
for (var i = this._followers.length - 1; i >= 0; --i)
{
var f = this._followers[i];
if (f.path == path)
{
// callback for this follower when it dies
if (f.callbackAtEnd)
{
f.callbackAtEnd(f.follower);
}
// destroy the follower
f.destroy();
// remove the follower from the list
this._followers.splice(i, 1);
}
}
};
Phaser.Plugin.PathManager.prototype.pathIndex = function (path)
{
return this._list.indexOf(path);
};
Phaser.Plugin.PathManager.prototype.removePath = function (pathIndex)
{
this.removeAllFollowers(this.getPath(pathIndex));
if (pathIndex < this._list.length)
{
return this._list.splice(pathIndex, 1);
}
else
{
throw new Error('ERROR: Cannot remove non-existent path');
}
};
/*
* DEBUG DRAWING OF ALL PATHS
*/
// draw all paths
Phaser.Plugin.PathManager.prototype.drawPaths = function (graphics)
{
for (var i = 0; i < this._list.length; i++)
{
this._list[i].debug(graphics);
}
};