Skip to content

Commit d5fd3e2

Browse files
committed
Renamed namespace
1 parent ce75947 commit d5fd3e2

5 files changed

Lines changed: 41 additions & 41 deletions

File tree

src/physics/matter-js/Factory.js

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ var Factory = new Class({
7171
* @param {number} height - [description]
7272
* @param {object} options - [description]
7373
*
74-
* @return {Matter.Body} A Matter JS Body.
74+
* @return {MatterJS.Body} A Matter JS Body.
7575
*/
7676
rectangle: function (x, y, width, height, options)
7777
{
@@ -95,7 +95,7 @@ var Factory = new Class({
9595
* @param {number} slope - [description]
9696
* @param {object} options - [description]
9797
*
98-
* @return {Matter.Body} A Matter JS Body.
98+
* @return {MatterJS.Body} A Matter JS Body.
9999
*/
100100
trapezoid: function (x, y, width, height, slope, options)
101101
{
@@ -118,7 +118,7 @@ var Factory = new Class({
118118
* @param {object} options - [description]
119119
* @param {number} maxSides - [description]
120120
*
121-
* @return {Matter.Body} A Matter JS Body.
121+
* @return {MatterJS.Body} A Matter JS Body.
122122
*/
123123
circle: function (x, y, radius, options, maxSides)
124124
{
@@ -141,7 +141,7 @@ var Factory = new Class({
141141
* @param {number} radius - [description]
142142
* @param {object} options - [description]
143143
*
144-
* @return {Matter.Body} A Matter JS Body.
144+
* @return {MatterJS.Body} A Matter JS Body.
145145
*/
146146
polygon: function (x, y, sides, radius, options)
147147
{
@@ -166,7 +166,7 @@ var Factory = new Class({
166166
* @param {boolean} removeCollinear - [description]
167167
* @param {number} minimumArea - [description]
168168
*
169-
* @return {Matter.Body} A Matter JS Body.
169+
* @return {MatterJS.Body} A Matter JS Body.
170170
*/
171171
fromVertices: function (x, y, vertexSets, options, flagInternal, removeCollinear, minimumArea)
172172
{
@@ -194,7 +194,7 @@ var Factory = new Class({
194194
* @param {number} [rowGap=0] - The distance between each row.
195195
* @param {object} [options] - [description]
196196
*
197-
* @return {Matter.Composite} A Matter JS Composite Stack.
197+
* @return {MatterJS.Composite} A Matter JS Composite Stack.
198198
*/
199199
imageStack: function (key, frame, x, y, columns, rows, columnGap, rowGap, options)
200200
{
@@ -236,7 +236,7 @@ var Factory = new Class({
236236
* @param {number} rowGap - The distance between each row.
237237
* @param {function} callback - The callback that creates the stack.
238238
*
239-
* @return {Matter.Composite} A new composite containing objects created in the callback.
239+
* @return {MatterJS.Composite} A new composite containing objects created in the callback.
240240
*/
241241
stack: function (x, y, columns, rows, columnGap, rowGap, callback)
242242
{
@@ -262,7 +262,7 @@ var Factory = new Class({
262262
* @param {number} rowGap - The distance between each row.
263263
* @param {function} callback - [description]
264264
*
265-
* @return {Matter.Composite} A Matter JS Composite pyramid.
265+
* @return {MatterJS.Composite} A Matter JS Composite pyramid.
266266
*/
267267
pyramid: function (x, y, columns, rows, columnGap, rowGap, callback)
268268
{
@@ -279,14 +279,14 @@ var Factory = new Class({
279279
* @method Phaser.Physics.Matter.Factory#chain
280280
* @since 3.0.0
281281
*
282-
* @param {Matter.Composite} composite - [description]
282+
* @param {MatterJS.Composite} composite - [description]
283283
* @param {number} xOffsetA - [description]
284284
* @param {number} yOffsetA - [description]
285285
* @param {number} xOffsetB - [description]
286286
* @param {number} yOffsetB - [description]
287287
* @param {object} options - [description]
288288
*
289-
* @return {Matter.Composite} A new composite containing objects chained together with constraints.
289+
* @return {MatterJS.Composite} A new composite containing objects chained together with constraints.
290290
*/
291291
chain: function (composite, xOffsetA, yOffsetA, xOffsetB, yOffsetB, options)
292292
{
@@ -299,13 +299,13 @@ var Factory = new Class({
299299
* @method Phaser.Physics.Matter.Factory#mesh
300300
* @since 3.0.0
301301
*
302-
* @param {Matter.Composite} composite - [description]
302+
* @param {MatterJS.Composite} composite - [description]
303303
* @param {number} columns - [description]
304304
* @param {number} rows - [description]
305305
* @param {boolean} crossBrace - [description]
306306
* @param {object} options - [description]
307307
*
308-
* @return {Matter.Composite} The composite containing objects meshed together with constraints.
308+
* @return {MatterJS.Composite} The composite containing objects meshed together with constraints.
309309
*/
310310
mesh: function (composite, columns, rows, crossBrace, options)
311311
{
@@ -324,7 +324,7 @@ var Factory = new Class({
324324
* @param {number} size - [description]
325325
* @param {number} length - [description]
326326
*
327-
* @return {Matter.Composite} A new composite newtonsCradle body.
327+
* @return {MatterJS.Composite} A new composite newtonsCradle body.
328328
*/
329329
newtonsCradle: function (x, y, number, size, length)
330330
{
@@ -347,7 +347,7 @@ var Factory = new Class({
347347
* @param {number} height - [description]
348348
* @param {number} wheelSize - [description]
349349
*
350-
* @return {Matter.Composite} A new composite car body.
350+
* @return {MatterJS.Composite} A new composite car body.
351351
*/
352352
car: function (x, y, width, height, wheelSize)
353353
{
@@ -375,7 +375,7 @@ var Factory = new Class({
375375
* @param {object} particleOptions - [description]
376376
* @param {object} constraintOptions - [description]
377377
*
378-
* @return {Matter.Composite} A new composite simple soft body.
378+
* @return {MatterJS.Composite} A new composite simple soft body.
379379
*/
380380
softBody: function (x, y, columns, rows, columnGap, rowGap, crossBrace, particleRadius, particleOptions, constraintOptions)
381381
{
@@ -392,13 +392,13 @@ var Factory = new Class({
392392
* @method Phaser.Physics.Matter.Factory#joint
393393
* @since 3.0.0
394394
*
395-
* @param {Matter.Body} bodyA - [description]
396-
* @param {Matter.Body} bodyB - [description]
395+
* @param {MatterJS.Body} bodyA - [description]
396+
* @param {MatterJS.Body} bodyB - [description]
397397
* @param {number} length - [description]
398398
* @param {number} [stiffness=1] - [description]
399399
* @param {object} [options={}] - [description]
400400
*
401-
* @return {Matter.Constraint} A Matter JS Constraint.
401+
* @return {MatterJS.Constraint} A Matter JS Constraint.
402402
*/
403403
joint: function (bodyA, bodyB, length, stiffness, options)
404404
{
@@ -411,13 +411,13 @@ var Factory = new Class({
411411
* @method Phaser.Physics.Matter.Factory#spring
412412
* @since 3.0.0
413413
*
414-
* @param {Matter.Body} bodyA - [description]
415-
* @param {Matter.Body} bodyB - [description]
414+
* @param {MatterJS.Body} bodyA - [description]
415+
* @param {MatterJS.Body} bodyB - [description]
416416
* @param {number} length - [description]
417417
* @param {number} [stiffness=1] - [description]
418418
* @param {object} [options={}] - [description]
419419
*
420-
* @return {Matter.Constraint} A Matter JS Constraint.
420+
* @return {MatterJS.Constraint} A Matter JS Constraint.
421421
*/
422422
spring: function (bodyA, bodyB, length, stiffness, options)
423423
{
@@ -430,13 +430,13 @@ var Factory = new Class({
430430
* @method Phaser.Physics.Matter.Factory#constraint
431431
* @since 3.0.0
432432
*
433-
* @param {Matter.Body} bodyA - [description]
434-
* @param {Matter.Body} bodyB - [description]
433+
* @param {MatterJS.Body} bodyA - [description]
434+
* @param {MatterJS.Body} bodyB - [description]
435435
* @param {number} length - [description]
436436
* @param {number} [stiffness=1] - [description]
437437
* @param {object} [options={}] - [description]
438438
*
439-
* @return {Matter.Constraint} A Matter JS Constraint.
439+
* @return {MatterJS.Constraint} A Matter JS Constraint.
440440
*/
441441
constraint: function (bodyA, bodyB, length, stiffness, options)
442442
{
@@ -461,12 +461,12 @@ var Factory = new Class({
461461
* @method Phaser.Physics.Matter.Factory#worldConstraint
462462
* @since 3.0.0
463463
*
464-
* @param {Matter.Body} bodyB - [description]
464+
* @param {MatterJS.Body} bodyB - [description]
465465
* @param {number} length - [description]
466466
* @param {number} [stiffness=1] - [description]
467467
* @param {object} [options={}] - [description]
468468
*
469-
* @return {Matter.Constraint} A Matter JS Constraint.
469+
* @return {MatterJS.Constraint} A Matter JS Constraint.
470470
*/
471471
worldConstraint: function (bodyB, length, stiffness, options)
472472
{
@@ -492,7 +492,7 @@ var Factory = new Class({
492492
*
493493
* @param {object} options - [description]
494494
*
495-
* @return {Matter.Constraint} A Matter JS Constraint.
495+
* @return {MatterJS.Constraint} A Matter JS Constraint.
496496
*/
497497
mouseSpring: function (options)
498498
{
@@ -507,7 +507,7 @@ var Factory = new Class({
507507
*
508508
* @param {object} options - [description]
509509
*
510-
* @return {Matter.Constraint} A Matter JS Constraint.
510+
* @return {MatterJS.Constraint} A Matter JS Constraint.
511511
*/
512512
pointerConstraint: function (options)
513513
{

src/physics/matter-js/PointerConstraint.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ var PointerConstraint = new Class({
165165
* @method Phaser.Physics.Matter.PointerConstraint#getBodyPart
166166
* @since 3.0.0
167167
*
168-
* @param {Matter.Body} body - [description]
168+
* @param {MatterJS.Body} body - [description]
169169
* @param {Phaser.Math.Vector2} position - [description]
170170
*
171171
* @return {boolean} [description]

src/physics/matter-js/World.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ var World = new Class({
5454
* [description]
5555
*
5656
* @name Phaser.Physics.Matter.World#engine
57-
* @type {Matter.Engine}
57+
* @type {MatterJS.Engine}
5858
* @since 3.0.0
5959
*/
6060
this.engine = Engine.create(config);
@@ -63,7 +63,7 @@ var World = new Class({
6363
* A `World` composite object that will contain all simulated bodies and constraints.
6464
*
6565
* @name Phaser.Physics.Matter.World#localWorld
66-
* @type {Matter.World}
66+
* @type {MatterJS.World}
6767
* @since 3.0.0
6868
*/
6969
this.localWorld = this.engine.world;
@@ -457,7 +457,7 @@ var World = new Class({
457457
* @param {number} height - [description]
458458
* @param {object} options - [description]
459459
*
460-
* @return {Matter.Body} [description]
460+
* @return {MatterJS.Body} [description]
461461
*/
462462
create: function (x, y, width, height, options)
463463
{
@@ -511,7 +511,7 @@ var World = new Class({
511511
* @method Phaser.Physics.Matter.World#removeConstraint
512512
* @since 3.0.0
513513
*
514-
* @param {Matter.Constraint} constraint - [description]
514+
* @param {MatterJS.Constraint} constraint - [description]
515515
* @param {boolean} deep - [description]
516516
*
517517
* @return {Phaser.Physics.Matter.World} This Matter World object.

src/physics/matter-js/components/SetBody.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ var SetBody = {
9292
* @method Phaser.Physics.Matter.Components.SetBody#setExistingBody
9393
* @since 3.0.0
9494
*
95-
* @param {Matter.Body} body - [description]
95+
* @param {MatterJS.Body} body - [description]
9696
* @param {boolean} [addToWorld=true] - [description]
9797
*
9898
* @return {Phaser.GameObjects.GameObject} This Game Object.

src/physics/matter-js/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module.exports = {
2222
};
2323

2424
/**
25-
* @module Matter
25+
* @namespace MatterJS
2626
*/
2727

2828
/**
@@ -31,7 +31,7 @@ module.exports = {
3131
* A `Matter.Body` is a rigid body that can be simulated by a `Matter.Engine`.
3232
* Factories for commonly used body configurations (such as rectangles, circles and other polygons) can be found in the module `Matter.Bodies`.
3333
*
34-
* @class Matter.Body
34+
* @class MatterJS.Body
3535
*/
3636

3737
/**
@@ -41,7 +41,7 @@ module.exports = {
4141
* It is important to use the functions in this module to modify composites, rather than directly modifying their properties.
4242
* Note that the `Matter.World` object is also a type of `Matter.Composite` and as such all composite methods here can also operate on a `Matter.World`.
4343
*
44-
* @class Matter.Composite
44+
* @class MatterJS.Composite
4545
*/
4646

4747
/**
@@ -52,8 +52,8 @@ module.exports = {
5252
* It is important to use the functions in the `Matter.Composite` module to modify the world composite, rather than directly modifying its properties.
5353
* There are also a few methods here that alias those in `Matter.Composite` for easier readability.
5454
*
55-
* @class Matter.World
56-
* @extends Matter.Composite
55+
* @class MatterJS.World
56+
* @extends MatterJS.Composite
5757
*/
5858

5959
/**
@@ -62,13 +62,13 @@ module.exports = {
6262
* Constraints are used for specifying that a fixed distance must be maintained between two bodies (or a body and a fixed world-space position).
6363
* The stiffness of constraints can be modified to create springs or elastic.
6464
*
65-
* @class Matter.Constraint
65+
* @class MatterJS.Constraint
6666
*/
6767

6868
/**
6969
* @classdesc
7070
* The `Matter.Engine` module contains methods for creating and manipulating engines.
7171
* An engine is a controller that manages updating the simulation of the world.
7272
*
73-
* @class Matter.Engine
73+
* @class MatterJS.Engine
7474
*/

0 commit comments

Comments
 (0)