diff --git a/src/gameobjects/GameObject.js b/src/gameobjects/GameObject.js index 1e2c2f363..7d38eb31e 100644 --- a/src/gameobjects/GameObject.js +++ b/src/gameobjects/GameObject.js @@ -732,7 +732,7 @@ var GameObject = new Class({ * every game frame. This method is passed two parameters: `delta` and `time`. * * If you wish to run your own logic within `preUpdate` then you should always call - * `preUpdate.super(delta, time)` within it, or it may fail to process required operations, + * `super.preUpdate(delta, time)` within it, or it may fail to process required operations, * such as Sprite animations. * * @method Phaser.GameObjects.GameObject#addToUpdateList diff --git a/src/gameobjects/components/Origin.js b/src/gameobjects/components/Origin.js index 7a4dc0342..152795853 100644 --- a/src/gameobjects/components/Origin.js +++ b/src/gameobjects/components/Origin.js @@ -32,9 +32,11 @@ var Origin = { * The origin maps the relationship between the size and position of the Game Object. * The default value is 0.5, meaning all Game Objects are positioned based on their center. * Setting the value to 0 means the position now relates to the left of the Game Object. + * Set this value with `setOrigin()`. * * @name Phaser.GameObjects.Components.Origin#originX * @type {number} + * @readonly * @default 0.5 * @since 3.0.0 */ @@ -45,9 +47,11 @@ var Origin = { * The origin maps the relationship between the size and position of the Game Object. * The default value is 0.5, meaning all Game Objects are positioned based on their center. * Setting the value to 0 means the position now relates to the top of the Game Object. + * Set this value with `setOrigin()`. * * @name Phaser.GameObjects.Components.Origin#originY * @type {number} + * @readonly * @default 0.5 * @since 3.0.0 */ diff --git a/src/gameobjects/graphics/Graphics.js b/src/gameobjects/graphics/Graphics.js index ef0ffdd3b..e6814556b 100644 --- a/src/gameobjects/graphics/Graphics.js +++ b/src/gameobjects/graphics/Graphics.js @@ -141,9 +141,11 @@ var Graphics = new Class({ /** * The default fill color for shapes rendered by this Graphics object. + * Set this value with `setDefaultStyles()`. * * @name Phaser.GameObjects.Graphics#defaultFillColor * @type {number} + * @readonly * @default -1 * @since 3.0.0 */ @@ -151,9 +153,11 @@ var Graphics = new Class({ /** * The default fill alpha for shapes rendered by this Graphics object. + * Set this value with `setDefaultStyles()`. * * @name Phaser.GameObjects.Graphics#defaultFillAlpha * @type {number} + * @readonly * @default 1 * @since 3.0.0 */ @@ -161,9 +165,11 @@ var Graphics = new Class({ /** * The default stroke width for shapes rendered by this Graphics object. + * Set this value with `setDefaultStyles()`. * * @name Phaser.GameObjects.Graphics#defaultStrokeWidth * @type {number} + * @readonly * @default 1 * @since 3.0.0 */ @@ -171,9 +177,11 @@ var Graphics = new Class({ /** * The default stroke color for shapes rendered by this Graphics object. + * Set this value with `setDefaultStyles()`. * * @name Phaser.GameObjects.Graphics#defaultStrokeColor * @type {number} + * @readonly * @default -1 * @since 3.0.0 */ @@ -181,9 +189,11 @@ var Graphics = new Class({ /** * The default stroke alpha for shapes rendered by this Graphics object. + * Set this value with `setDefaultStyles()`. * * @name Phaser.GameObjects.Graphics#defaultStrokeAlpha * @type {number} + * @readonly * @default 1 * @since 3.0.0 */ diff --git a/src/physics/arcade/components/Enable.js b/src/physics/arcade/components/Enable.js index 2de4f31ee..5d5a6853d 100644 --- a/src/physics/arcade/components/Enable.js +++ b/src/physics/arcade/components/Enable.js @@ -14,15 +14,16 @@ var Enable = { /** * Enables this Game Object's Body. + * If you reset the Body you must also pass `x` and `y`. * * @method Phaser.Physics.Arcade.Components.Enable#enableBody * @since 3.0.0 * - * @param {boolean} reset - Also reset the Body and place it at (x, y). - * @param {number} x - The horizontal position to place the Game Object and Body. - * @param {number} y - The horizontal position to place the Game Object and Body. - * @param {boolean} enableGameObject - Also activate this Game Object. - * @param {boolean} showGameObject - Also show this Game Object. + * @param {boolean} [reset] - Also reset the Body and place the Game Object at (x, y). + * @param {number} [x] - The horizontal position to place the Game Object, if `reset` is true. + * @param {number} [y] - The horizontal position to place the Game Object, if `reset` is true. + * @param {boolean} [enableGameObject] - Also set this Game Object's `active` to true. + * @param {boolean} [showGameObject] - Also set this Game Object's `visible` to true. * * @return {this} This Game Object. * @@ -61,8 +62,8 @@ var Enable = { * @method Phaser.Physics.Arcade.Components.Enable#disableBody * @since 3.0.0 * - * @param {boolean} [disableGameObject=false] - Also deactivate this Game Object. - * @param {boolean} [hideGameObject=false] - Also hide this Game Object. + * @param {boolean} [disableGameObject=false] - Also set this Game Object's `active` to false. + * @param {boolean} [hideGameObject=false] - Also set this Game Object's `visible` to false. * * @return {this} This Game Object. *