Skip to content

Commit

Permalink
Added doc comment to mode() of box2d component
Browse files Browse the repository at this point in the history
  • Loading branch information
Irrelon committed May 30, 2013
1 parent fd8f1fb commit 49d43a6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions engine/components/physics/box2d/IgeBox2dComponent.js
Expand Up @@ -130,6 +130,15 @@ var IgeBox2dComponent = IgeEventingClass.extend({
}
},

/**
* Gets / sets the world interval mode. In mode 0 (zero) the
* box2d simulation is synced to the framerate of the engine's
* renderer. In mode 1 the box2d simulation is stepped at a constant
* speed regardless of the engine's renderer. This must be set *before*
* calling the start() method in order for the setting to take effect.
* @param {Integer} val The mode, either 0 or 1.
* @returns {*}
*/
mode: function (val) {
if (val !== undefined) {
this._mode = val;
Expand Down

0 comments on commit 49d43a6

Please sign in to comment.