Improve docs

Improve docs of Supportable and Twoway with examples of realistic, custom land and jump behavior.
craftyjs · Apr 7, 2015 · 5793f07 · 5793f07
1 parent 54cc31d
commit 5793f07
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/src/controls/controls.js b/src/controls/controls.js
@@ -1300,11 +1300,15 @@ Crafty.c("Twoway", {
      * @example
      * ~~~
      * var player = Crafty.e("2D, Twoway");
+     * player.hasDoubleJumpPowerUp = true; // allow player to double jump by granting him a powerup
      * player.bind("CheckJumping", function(ground) {
-     *    if (!ground && player.hasDoubleJumpPowerUp) { // custom behaviour
-     *       player.hasDoubleJumpPowerUp = false;
-     *       player.canJump = true;
-     *    }
+     *     if (!ground && player.hasDoubleJumpPowerUp) { // allow player to double jump by using up his double jump powerup
+     *         player.canJump = true;
+     *         player.hasDoubleJumpPowerUp = false;
+     *     }
+     * });
+     * player.bind("LandedOnGround", function(ground) {
+     *     player.hasDoubleJumpPowerUp = true; // give player new double jump powerup upon landing
      * });
      * ~~~
      */

diff --git a/src/spatial/2d.js b/src/spatial/2d.js
@@ -951,8 +951,9 @@ Crafty.c("Supportable", {
      * ~~~
      * var player = Crafty.e("2D, Gravity");
      * player.bind("CheckLanding", function(ground) {
-     *     if (player.isAirplane) // custom behaviour
+     *     if (player.y + player.h > ground.y + player.vy) { // forbid landing, if player's feet are not above ground
      *         player.canLand = false;
+     *     }
      * });
      * ~~~
      */