Skip to content

Commit 4185e66

Browse files
committed
Docs: banish StaticBody touching properties
Fixes phaserjs#5381
1 parent 0d23aea commit 4185e66

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

src/physics/arcade/StaticBody.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,8 @@ var StaticBody = new Class({
372372
this.checkCollision = { none: false, up: true, down: true, left: true, right: true };
373373

374374
/**
375-
* Whether this StaticBody has ever collided with another body and in which direction.
375+
* This property is kept for compatibility with Dynamic Bodies.
376+
* Avoid using it.
376377
*
377378
* @name Phaser.Physics.Arcade.StaticBody#touching
378379
* @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}
@@ -381,7 +382,9 @@ var StaticBody = new Class({
381382
this.touching = { none: true, up: false, down: false, left: false, right: false };
382383

383384
/**
384-
* Whether this StaticBody was colliding with another body during the last step or any previous step, and in which direction.
385+
* This property is kept for compatibility with Dynamic Bodies.
386+
* Avoid using it.
387+
* The values are always false for a Static Body.
385388
*
386389
* @name Phaser.Physics.Arcade.StaticBody#wasTouching
387390
* @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}
@@ -390,7 +393,8 @@ var StaticBody = new Class({
390393
this.wasTouching = { none: true, up: false, down: false, left: false, right: false };
391394

392395
/**
393-
* Whether this StaticBody has ever collided with a tile or the world boundary.
396+
* This property is kept for compatibility with Dynamic Bodies.
397+
* Avoid using it.
394398
*
395399
* @name Phaser.Physics.Arcade.StaticBody#blocked
396400
* @type {Phaser.Types.Physics.Arcade.ArcadeBodyCollision}

0 commit comments

Comments
 (0)