Image#play()

play(name, frameRate, loop, killOnComplete) → {Phaser.Animation} Plays an Animation. The animation should have previously been created via animations.add. If the animation is already playing calling this again won't do anything.If you need to reset an already running animation do so directly on the Animation object itself or via AnimationManager.stop. Parameters Name Type Argument Default Description name string The name of the animation to be played, e.g. "fire", "walk", "jump". Must

Image#pendingDestroy

pendingDestroy : boolean A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update.You can set it directly to allow you to flag an object to be destroyed on its next update. This is extremely useful if you wish to destroy an object from within one of its own callbackssuch as with Buttons or other Input events. Inherited From Phaser.Component.Core#pendingDestroy Source code: gameobjects/components/Core.js (Line 259)

Image#overlap()

overlap(displayObject) → {boolean} Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object,which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a getBounds method and result. This check ignores the hitArea property if set and runs a getBounds comparison on both objects to determine the result. Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency.I

Image#offsetY

[readonly] offsetY : number The amount the Game Object is visually offset from its y coordinate.This is the same as height * anchor.y.It will only be > 0 if anchor.y is not equal to zero. Inherited From Phaser.Component.Bounds#offsetY Source code: gameobjects/components/Bounds.js (Line 42)

Image#offsetX

[readonly] offsetX : number The amount the Game Object is visually offset from its x coordinate.This is the same as width * anchor.x.It will only be > 0 if anchor.x is not equal to zero. Inherited From Phaser.Component.Bounds#offsetX Source code: gameobjects/components/Bounds.js (Line 24)

Image#name

name : string A user defined name given to this Game Object.This value isn't ever used internally by Phaser, it is meant as a game level property. Inherited From Phaser.Component.Core#name Source code: gameobjects/components/Core.js (Line 150)

Image#moveUp()

moveUp() → {PIXI.DisplayObject} Moves this Game Object up one place in its parents display list.This call has no effect if the Game Object is already at the top of the display list. If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World,because the World is the root Group from which all Game Objects descend. Returns PIXI.DisplayObject - This instance. Inherited From Phaser.Component.BringToTop#moveUp Source code: game

Image#moveDown()

moveDown() → {PIXI.DisplayObject} Moves this Game Object down one place in its parents display list.This call has no effect if the Game Object is already at the bottom of the display list. If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World,because the World is the root Group from which all Game Objects descend. Returns PIXI.DisplayObject - This instance. Inherited From Phaser.Component.BringToTop#moveDown Source

Image#loadTexture()

loadTexture(key, frame, stopAnimation) Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache. If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the frame or frameName properties instead. You should only use loadTexture if you want to replace the base texture entirely. Calling this method causes a WebGL texture update, so use sparingly or in low-intensi

Image#lifespan

lifespan : number The lifespan allows you to give a Game Object a lifespan in milliseconds. Once the Game Object is 'born' you can set this to a positive value. It is automatically decremented by the millisecond equivalent of game.time.physicsElapsed each frame.When it reaches zero it will call the kill method. Very handy for particles, bullets, collectibles, or any other short-lived entity. Inherited From Phaser.Component.LifeSpan#lifespan Source code: gameobjects/components/LifeSpan.js (