2013-10-25 15:54:40 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Source: gameobjects/Sprite.js< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.html" > Phaser< / a >
< / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
< li >
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
< li >
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
< li >
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
< li >
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
< li >
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Color.html" > Color< / a >
< / li >
< li >
< a href = "Phaser.Device.html" > Device< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.DOMSprite.html" > DOMSprite< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
< / li >
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2013-10-25 16:30:37 +00:00
< li >
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
< li >
< a href = "Phaser.StageScaleMode.html" > StageScaleMode< / a >
< / li >
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
2014-02-08 07:24:22 +00:00
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "global.html#canUseNewCanvasBlendModes" > canUseNewCanvasBlendModes< / a >
< / li >
< li >
< a href = "global.html#getNextPowerOfTwo" > getNextPowerOfTwo< / a >
< / li >
< li >
< a href = "global.html#hex2rgb" > hex2rgb< / a >
< / li >
< li >
< a href = "global.html#hitTest" > hitTest< / a >
< / li >
< li >
< a href = "global.html#rgb2hex" > rgb2hex< / a >
< / li >
< / ul >
< / li >
2013-10-25 15:54:40 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span12" >
< div id = "main" >
< h1 class = "page-title" > Source: gameobjects/Sprite.js< / h1 >
< section >
< article >
< pre class = "sunlight-highlight-javascript linenums" > /**
* @author Richard Davey < rich@photonstorm.com>
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
2013-11-28 15:57:09 +00:00
* @class Phaser.Sprite
*
* @classdesc Create a new `Sprite` object. Sprites are the lifeblood of your game, used for nearly everything visual.
*
2013-10-25 15:54:40 +00:00
* At its most basic a Sprite consists of a set of coordinates and a texture that is rendered to the canvas.
* They also contain additional properties allowing for physics motion (via Sprite.body), input handling (via Sprite.input),
* events (via Sprite.events), animation (via Sprite.animations), camera culling and more. Please see the Examples for use cases.
*
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {number} x - The x coordinate (in world space) to position the Sprite at.
* @param {number} y - The y coordinate (in world space) to position the Sprite at.
2013-11-28 15:57:09 +00:00
* @param {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
2013-10-25 15:54:40 +00:00
* @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
*/
Phaser.Sprite = function (game, x, y, key, frame) {
x = x || 0;
y = y || 0;
key = key || null;
frame = frame || null;
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Game} game - A reference to the currently running Game.
*/
this.game = game;
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {boolean} exists - If exists = false then the Sprite isn't updated by the core game loop or physics subsystem at all.
* @default
*/
2013-10-25 15:54:40 +00:00
this.exists = true;
/**
2013-11-28 15:57:09 +00:00
* @property {string} name - The user defined name given to this Sprite.
* @default
*/
2013-10-25 15:54:40 +00:00
this.name = '';
/**
2013-11-28 15:57:09 +00:00
* @property {number} type - The const type of this object.
* @readonly
*/
2013-10-25 15:54:40 +00:00
this.type = Phaser.SPRITE;
/**
2013-11-28 15:57:09 +00:00
* @property {Phaser.Events} events - The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.
2013-10-25 15:54:40 +00:00
*/
this.events = new Phaser.Events(this);
/**
* @property {Phaser.AnimationManager} animations - This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)
*/
this.animations = new Phaser.AnimationManager(this);
/**
2013-11-28 15:57:09 +00:00
* @property {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
2013-10-25 15:54:40 +00:00
*/
this.key = key;
/**
2014-02-08 07:24:22 +00:00
* @property {number} _frame - Internal cache var.
* @private
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
this._frame = 0;
2013-10-25 15:54:40 +00:00
2013-11-01 18:16:52 +00:00
/**
2014-02-08 07:24:22 +00:00
* @property {string} _frameName - Internal cache var.
* @private
2013-11-01 18:16:52 +00:00
*/
2014-02-08 07:24:22 +00:00
this._frameName = '';
2013-11-01 18:16:52 +00:00
2014-02-08 07:24:22 +00:00
PIXI.Sprite.call(this, PIXI.TextureCache['__default']);
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
this.loadTexture(key, frame);
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
this.position.set(x, y);
2013-10-25 15:54:40 +00:00
2013-11-01 18:16:52 +00:00
/**
* @property {Phaser.Point} world - The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.
*/
this.world = new Phaser.Point(x, y);
2013-10-25 15:54:40 +00:00
/**
* Should this Sprite be automatically culled if out of range of the camera?
* A culled sprite has its renderable property set to 'false'.
2014-02-08 07:24:22 +00:00
* Be advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.
2013-10-25 15:54:40 +00:00
*
* @property {boolean} autoCull - A flag indicating if the Sprite should be automatically camera culled or not.
* @default
*/
this.autoCull = false;
/**
2014-02-08 07:24:22 +00:00
* A Sprite that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera.
* Note that if this Image is a child of a display object that has changed its position then the offset will be calculated from that.
* @property {boolean} fixedToCamera - Fixes this Sprite to the Camera.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-08 07:24:22 +00:00
this.fixedToCamera = false;
2013-10-25 15:54:40 +00:00
/**
2014-02-08 07:24:22 +00:00
* @property {Phaser.InputHandler|null} input - The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.
2013-11-28 15:57:09 +00:00
*/
2014-02-08 07:24:22 +00:00
this.input = null;
2013-10-25 15:54:40 +00:00
/**
* @property {Phaser.Physics.Arcade.Body} body - By default Sprites have a Phaser.Physics Body attached to them. You can operate physics actions via this property, or null it to skip all physics updates.
*/
this.body = new Phaser.Physics.Arcade.Body(this);
/**
* @property {number} health - Health value. Used in combination with damage() to allow for quick killing of Sprites.
2013-11-28 15:57:09 +00:00
*/
2013-10-25 15:54:40 +00:00
this.health = 1;
/**
2014-02-08 07:24:22 +00:00
* If you would like the Sprite to have a lifespan once 'born' you can set this to a positive value. Handy for particles, bullets, etc.
* The lifespan is decremented by game.time.elapsed each update, once it reaches zero the kill() function is called.
* @property {number} lifespan - The lifespan of the Sprite (in ms) before it will be killed.
2013-10-25 15:54:40 +00:00
* @default
*/
2014-02-08 07:24:22 +00:00
this.lifespan = 0;
2013-10-25 15:54:40 +00:00
/**
* @property {boolean} outOfBoundsKill - If true the Sprite is killed as soon as Sprite.inWorld is false.
* @default
*/
this.outOfBoundsKill = false;
2014-02-05 06:29:17 +00:00
/**
* @property {boolean} debug - Handy flag to use with Game.enableStep
* @default
*/
this.debug = false;
2014-02-08 07:24:22 +00:00
/**
* @property {boolean} _outOfBoundsFired - Internal flag.
* @private
*/
this._outOfBoundsFired = false;
2013-11-01 18:16:52 +00:00
2014-02-05 06:29:17 +00:00
/**
2014-02-08 07:24:22 +00:00
* @property {array} _cache - A small cache for previous step values. 0 = x, 1 = y, 2 = rotation, 3 = renderID, 4 = fresh? (0 = no, 1 = yes)
* @private
2014-02-05 06:29:17 +00:00
*/
2014-02-08 07:24:22 +00:00
this._cache = [0, 0, 0, 0, 1];
2014-02-05 06:29:17 +00:00
2013-10-25 15:54:40 +00:00
};
Phaser.Sprite.prototype = Object.create(PIXI.Sprite.prototype);
Phaser.Sprite.prototype.constructor = Phaser.Sprite;
/**
2014-02-08 07:24:22 +00:00
* Automatically called by World.preUpdate.
2013-10-25 15:54:40 +00:00
*
* @method Phaser.Sprite#preUpdate
* @memberof Phaser.Sprite
*/
Phaser.Sprite.prototype.preUpdate = function() {
2014-02-08 07:24:22 +00:00
if (this._cache[4] === 1)
2014-02-05 06:29:17 +00:00
{
2014-02-08 07:24:22 +00:00
console.log('sprite cache fresh');
this.world.setTo(this.parent.position.x + this.position.x, this.parent.position.y + this.position.y);
2014-02-05 06:29:17 +00:00
this.worldTransform[2] = this.world.x;
this.worldTransform[5] = this.world.y;
2014-02-08 07:24:22 +00:00
// this._cache[0] = this.world.x;
// this._cache[1] = this.world.y;
// this._cache[2] = this.rotation;
this._cache[4] = 0;
2014-02-05 06:29:17 +00:00
if (this.body)
{
this.body.x = (this.world.x - (this.anchor.x * this.width)) + this.body.offset.x;
this.body.y = (this.world.y - (this.anchor.y * this.height)) + this.body.offset.y;
this.body.preX = this.body.x;
this.body.preY = this.body.y;
}
return;
}
2014-02-08 07:24:22 +00:00
this._cache[0] = this.world.x;
this._cache[1] = this.world.y;
this._cache[2] = this.rotation;
if (!this.exists || !this.parent.exists)
2013-10-25 15:54:40 +00:00
{
this.renderOrderID = -1;
2013-11-28 15:57:09 +00:00
return false;
2013-10-25 15:54:40 +00:00
}
if (this.lifespan > 0)
{
this.lifespan -= this.game.time.elapsed;
if (this.lifespan < = 0)
{
this.kill();
2013-11-28 15:57:09 +00:00
return false;
2013-10-25 15:54:40 +00:00
}
}
2014-02-08 07:24:22 +00:00
if (this.autoCull)
2013-11-01 18:16:52 +00:00
{
2014-02-08 07:24:22 +00:00
// Won't get rendered but will still get its transform updated
this.renderable = this.game.world.camera.screenView.intersects(this.getBounds());
2013-11-01 18:16:52 +00:00
}
this.world.setTo(this.game.camera.x + this.worldTransform[2], this.game.camera.y + this.worldTransform[5]);
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
if (this.visible)
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this._cache[3] = this.game.world.currentRenderOrderID++;
2013-10-25 15:54:40 +00:00
}
2014-02-08 07:24:22 +00:00
this.animations.update();
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
if (!this.inWorld & & Phaser.Rectangle.intersects(this.getBounds(), this.game.world.bounds, this.inWorldThreshold))
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
// It's back again, reset the OOB check
this._outOfBoundsFired = false;
2013-10-25 15:54:40 +00:00
}
else
{
// Sprite WAS in the screen, has it now left?
2014-02-08 07:24:22 +00:00
this.inWorld = Phaser.Rectangle.intersects(this.getBounds(), this.game.world.bounds, this.inWorldThreshold);
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
if (this.inWorld === false)
2013-10-25 15:54:40 +00:00
{
this.events.onOutOfBounds.dispatch(this);
this._outOfBoundsFired = true;
if (this.outOfBoundsKill)
{
this.kill();
}
}
}
2014-02-08 07:24:22 +00:00
this._cache.cameraVisible = Phaser.Rectangle.intersects(this.game.world.camera.screenView, this.getBounds(), 0);
2013-11-01 18:16:52 +00:00
if (this.autoCull)
{
// Won't get rendered but will still get its transform updated
this.renderable = this._cache.cameraVisible;
}
2014-02-08 07:24:22 +00:00
if (this.body)
{
this.body.preUpdate();
}
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
return true;
2013-10-25 15:54:40 +00:00
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Internal function called by the World postUpdate cycle.
*
* @method Phaser.Sprite#postUpdate
* @memberof Phaser.Sprite
*/
Phaser.Sprite.prototype.postUpdate = function() {
2013-11-28 15:57:09 +00:00
if (this.key instanceof Phaser.BitmapData & & this.key._dirty)
{
this.key.render();
}
2013-10-25 15:54:40 +00:00
if (this.exists)
{
if (this.body)
{
this.body.postUpdate();
}
if (this.fixedToCamera)
{
2014-02-08 07:24:22 +00:00
// this.position.x = this.game.camera.view.x + this.x;
// this.position.y = this.game.camera.view.y + this.y;
2013-10-25 15:54:40 +00:00
}
}
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Changes the Texture the Sprite is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.
* This causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.
*
* @method Phaser.Sprite#loadTexture
* @memberof Phaser.Sprite
2013-11-28 15:57:09 +00:00
* @param {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
2013-10-25 15:54:40 +00:00
* @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
*/
Phaser.Sprite.prototype.loadTexture = function (key, frame) {
2014-02-08 07:24:22 +00:00
frame = frame || 0;
2013-10-25 15:54:40 +00:00
if (key instanceof Phaser.RenderTexture)
{
2014-02-08 07:24:22 +00:00
this.key = key.key;
this.setTexture(key);
2013-10-25 15:54:40 +00:00
}
2013-11-28 15:57:09 +00:00
else if (key instanceof Phaser.BitmapData)
{
2014-02-08 07:24:22 +00:00
this.key = key.key;
2013-11-28 15:57:09 +00:00
this.setTexture(key.texture);
}
2013-10-25 15:54:40 +00:00
else if (key instanceof PIXI.Texture)
{
2014-02-08 07:24:22 +00:00
this.key = key;
this.setTexture(key);
2013-10-25 15:54:40 +00:00
}
else
{
2014-02-08 07:24:22 +00:00
if (key === null || typeof key === 'undefined')
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this.key = '__default';
this.setTexture(PIXI.TextureCache[this.key]);
}
else if (typeof key === 'string' & & !this.game.cache.checkImageKey(key))
{
this.key = '__missing';
this.setTexture(PIXI.TextureCache[this.key]);
2013-10-25 15:54:40 +00:00
}
if (this.game.cache.isSpriteSheet(key))
{
2014-02-08 07:24:22 +00:00
this.key = key;
// var frameData = this.game.cache.getFrameData(key);
2013-10-25 15:54:40 +00:00
this.animations.loadFrameData(this.game.cache.getFrameData(key));
2014-02-08 07:24:22 +00:00
if (typeof frame === 'string')
{
this.frameName = frame;
}
else
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this.frame = frame;
2013-10-25 15:54:40 +00:00
}
}
else
{
2014-02-08 07:24:22 +00:00
this.key = key;
2013-10-25 15:54:40 +00:00
this.setTexture(PIXI.TextureCache[key]);
}
}
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
2014-02-08 07:24:22 +00:00
* Crop allows you to crop the texture used to display this Image.
* Cropping takes place from the top-left of the Image and can be modified in real-time by providing an updated rectangle object.
*
* @method Phaser.Sprite#crop
2013-10-25 15:54:40 +00:00
* @memberof Phaser.Sprite
2014-02-08 07:24:22 +00:00
* @param {Phaser.Rectangle} rect - The Rectangle to crop the Image to. Pass null or no parameters to clear a previously set crop rectangle.
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
Phaser.Sprite.prototype.crop = function(rect) {
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
if (typeof rect === 'undefined' || rect === null)
2014-02-05 06:29:17 +00:00
{
2014-02-08 07:24:22 +00:00
// Clear any crop that may be set
if (this.texture.hasOwnProperty('sourceWidth'))
{
this.texture.setFrame(new Phaser.Rectangle(0, 0, this.texture.sourceWidth, this.texture.sourceHeight));
}
2014-02-05 06:29:17 +00:00
}
else
{
2014-02-08 07:24:22 +00:00
// Do we need to clone the PIXI.Texture object?
if (this.texture instanceof PIXI.Texture)
{
// Yup, let's rock it ...
var local = {};
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
Phaser.Utils.extend(true, local, this.texture);
local.sourceWidth = local.width;
local.sourceHeight = local.height;
local.frame = rect;
local.width = rect.width;
local.height = rect.height;
this.texture = local;
this.texture.updateFrame = true;
PIXI.Texture.frameUpdates.push(this.texture);
}
else
{
this.texture.setFrame(rect);
}
}
2013-10-25 15:54:40 +00:00
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Brings a 'dead' Sprite back to life, optionally giving it the health value specified.
* A resurrected Sprite has its alive, exists and visible properties all set to true.
* It will dispatch the onRevived event, you can listen to Sprite.events.onRevived for the signal.
*
* @method Phaser.Sprite#revive
* @memberof Phaser.Sprite
* @param {number} [health=1] - The health to give the Sprite.
* @return (Phaser.Sprite) This instance.
*/
Phaser.Sprite.prototype.revive = function(health) {
if (typeof health === 'undefined') { health = 1; }
this.alive = true;
this.exists = true;
this.visible = true;
this.health = health;
if (this.events)
{
this.events.onRevived.dispatch(this);
}
return this;
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Kills a Sprite. A killed Sprite has its alive, exists and visible properties all set to false.
* It will dispatch the onKilled event, you can listen to Sprite.events.onKilled for the signal.
* Note that killing a Sprite is a way for you to quickly recycle it in a Sprite pool, it doesn't free it up from memory.
* If you don't need this Sprite any more you should call Sprite.destroy instead.
*
* @method Phaser.Sprite#kill
* @memberof Phaser.Sprite
* @return (Phaser.Sprite) This instance.
*/
Phaser.Sprite.prototype.kill = function() {
this.alive = false;
this.exists = false;
this.visible = false;
if (this.events)
{
this.events.onKilled.dispatch(this);
}
return this;
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Destroys the Sprite. This removes it from its parent group, destroys the input, event and animation handlers if present
* and nulls its reference to game, freeing it up for garbage collection.
*
* @method Phaser.Sprite#destroy
* @memberof Phaser.Sprite
*/
Phaser.Sprite.prototype.destroy = function() {
2014-02-05 06:29:17 +00:00
if (this.filters)
{
this.filters = null;
}
2014-02-08 07:24:22 +00:00
if (this.parent)
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this.parent.remove(this);
2013-10-25 15:54:40 +00:00
}
2014-02-08 07:24:22 +00:00
if (this.events)
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this.events.destroy();
2013-10-25 15:54:40 +00:00
}
2014-02-08 07:24:22 +00:00
if (this.input)
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this.input.destroy();
2013-10-25 15:54:40 +00:00
}
if (this.animations)
{
this.animations.destroy();
}
2014-02-05 06:29:17 +00:00
if (this.body)
{
this.body.destroy();
}
2013-10-25 15:54:40 +00:00
this.alive = false;
this.exists = false;
this.visible = false;
this.game = null;
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Damages the Sprite, this removes the given amount from the Sprites health property.
* If health is then taken below zero Sprite.kill is called.
*
* @method Phaser.Sprite#damage
* @memberof Phaser.Sprite
* @param {number} amount - The amount to subtract from the Sprite.health value.
* @return (Phaser.Sprite) This instance.
*/
Phaser.Sprite.prototype.damage = function(amount) {
if (this.alive)
{
this.health -= amount;
if (this.health < 0)
{
this.kill();
}
}
return this;
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Resets the Sprite. This places the Sprite at the given x/y world coordinates and then
* sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state and health values.
* If the Sprite has a physics body that too is reset.
*
* @method Phaser.Sprite#reset
* @memberof Phaser.Sprite
* @param {number} x - The x coordinate (in world space) to position the Sprite at.
* @param {number} y - The y coordinate (in world space) to position the Sprite at.
* @param {number} [health=1] - The health to give the Sprite.
* @return (Phaser.Sprite) This instance.
*/
Phaser.Sprite.prototype.reset = function(x, y, health) {
if (typeof health === 'undefined') { health = 1; }
2014-02-05 06:29:17 +00:00
this.world.setTo(x, y);
2014-02-08 07:24:22 +00:00
this.position.x = x;
this.position.y = y;
2013-10-25 15:54:40 +00:00
this.alive = true;
this.exists = true;
this.visible = true;
this.renderable = true;
this._outOfBoundsFired = false;
this.health = health;
if (this.body)
{
2014-02-05 06:29:17 +00:00
this.body.reset(false);
2013-10-25 15:54:40 +00:00
}
return this;
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Brings the Sprite to the top of the display list it is a child of. Sprites that are members of a Phaser.Group are only
* bought to the top of that Group, not the entire display list.
*
* @method Phaser.Sprite#bringToTop
* @memberof Phaser.Sprite
* @return (Phaser.Sprite) This instance.
*/
2014-02-08 07:24:22 +00:00
Phaser.Sprite.prototype.bringToTop = function(child) {
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
if (typeof child === 'undefined')
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
if (this.parent)
{
this.parent.bringToTop(this);
}
2013-10-25 15:54:40 +00:00
}
else
{
2014-02-08 07:24:22 +00:00
2013-10-25 15:54:40 +00:00
}
return this;
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
/**
* Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()
* If the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.
*
* @method Phaser.Sprite#play
* @memberof Phaser.Sprite
* @param {string} name - The name of the animation to be played, e.g. "fire", "walk", "jump".
* @param {number} [frameRate=null] - The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
* @param {boolean} [loop=false] - Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
* @param {boolean} [killOnComplete=false] - If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.
* @return {Phaser.Animation} A reference to playing Animation instance.
*/
Phaser.Sprite.prototype.play = function (name, frameRate, loop, killOnComplete) {
if (this.animations)
{
return this.animations.play(name, frameRate, loop, killOnComplete);
}
2013-11-01 18:16:52 +00:00
};
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
/**
2014-02-08 07:24:22 +00:00
* Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
* Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
* If you wish to work in radians instead of degrees use the property Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.
*
* @name Phaser.Sprite#angle
* @property {number} angle - The angle of this Image in degrees.
2014-02-05 06:29:17 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "angle", {
2014-02-05 06:29:17 +00:00
get: function() {
2014-02-08 07:24:22 +00:00
return Phaser.Math.wrapAngle(Phaser.Math.radToDeg(this.rotation));
},
set: function(value) {
this.rotation = Phaser.Math.degToRad(Phaser.Math.wrapAngle(value));
2014-02-05 06:29:17 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* Returns the delta x value. The difference between world.x now and in the previous step.
*
* @name Phaser.Sprite#deltaX
* @property {number} deltaX - The delta value. Positive if the motion was to the right, negative if to the left.
2014-02-05 06:29:17 +00:00
* @readonly
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "deltaX", {
2014-02-05 06:29:17 +00:00
get: function() {
2014-02-08 07:24:22 +00:00
return this.world.x - this._cache[0];
2014-02-05 06:29:17 +00:00
}
});
2013-10-25 15:54:40 +00:00
/**
2014-02-08 07:24:22 +00:00
* Returns the delta y value. The difference between world.y now and in the previous step.
*
* @name Phaser.Sprite#deltaY
* @property {number} deltaY - The delta value. Positive if the motion was downwards, negative if upwards.
* @readonly
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "deltaY", {
2013-10-25 15:54:40 +00:00
get: function() {
2014-02-08 07:24:22 +00:00
return this.world.y - this._cache[1];
2013-10-25 15:54:40 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* Returns the delta z value. The difference between rotation now and in the previous step.
*
* @name Phaser.Sprite#deltaZ
* @property {number} deltaZ - The delta value.
* @readonly
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "deltaZ", {
get: function() {
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
return this.rotation - this._cache[2];
2013-10-25 15:54:40 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* Checks if the Image bounds are within the game world, otherwise false if fully outside of it.
*
* @name Phaser.Sprite#inWorld
* @property {boolean} inWorld - True if the Image bounds is within the game world, even if only partially. Otherwise false if fully outside of it.
* @readonly
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "inWorld", {
get: function() {
return this.game.world.bounds.intersects(this.getBounds());
2013-10-25 15:54:40 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* Checks if the Image bounds are within the game camera, otherwise false if fully outside of it.
*
2013-10-25 15:54:40 +00:00
* @name Phaser.Sprite#inCamera
2014-02-08 07:24:22 +00:00
* @property {boolean} inCamera - True if the Image bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.
2013-10-25 15:54:40 +00:00
* @readonly
*/
Object.defineProperty(Phaser.Sprite.prototype, "inCamera", {
2014-02-08 07:24:22 +00:00
get: function() {
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
return this.game.world.camera.screenView.intersects(this.getBounds());
2014-02-05 06:29:17 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* @name Phaser.Sprite#frame
* @property {number} frame - Gets or sets the current frame index and updates the Texture Cache for display.
2014-02-05 06:29:17 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "frame", {
2014-02-05 06:29:17 +00:00
get: function () {
2014-02-08 07:24:22 +00:00
return this.animations.frame;
},
set: function (value) {
this.animations.frame = value;
2014-02-05 06:29:17 +00:00
}
});
2013-10-25 15:54:40 +00:00
/**
2014-02-08 07:24:22 +00:00
* @name Phaser.Sprite#frameName
* @property {string} frameName - Gets or sets the current frame name and updates the Texture Cache for display.
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "frameName", {
2013-10-25 15:54:40 +00:00
2014-02-08 07:24:22 +00:00
get: function () {
return this.animations.frameName;
2013-10-25 15:54:40 +00:00
},
2014-02-08 07:24:22 +00:00
set: function (value) {
this.animations.frameName = value;
2013-10-25 15:54:40 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* @name Phaser.Sprite#renderOrderID
* @property {number} renderOrderID - The render order ID, reset every frame.
* @readonly
2013-10-25 15:54:40 +00:00
*/
2014-02-08 07:24:22 +00:00
Object.defineProperty(Phaser.Sprite.prototype, "renderOrderID", {
2013-10-25 15:54:40 +00:00
get: function() {
2014-02-08 07:24:22 +00:00
return this._cache[3];
2013-10-25 15:54:40 +00:00
}
});
/**
2014-02-08 07:24:22 +00:00
* By default an Image won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is
* activated for this object and it will then start to process click/touch events and more.
2013-10-25 15:54:40 +00:00
*
* @name Phaser.Sprite#inputEnabled
2014-02-08 07:24:22 +00:00
* @property {boolean} inputEnabled - Set to true to allow this object to receive input events.
2013-10-25 15:54:40 +00:00
*/
Object.defineProperty(Phaser.Sprite.prototype, "inputEnabled", {
get: function () {
2014-02-08 07:24:22 +00:00
return (this.input & & this.input.enabled);
2013-10-25 15:54:40 +00:00
},
set: function (value) {
if (value)
{
2014-02-08 07:24:22 +00:00
if (this.input === null)
2013-10-25 15:54:40 +00:00
{
2014-02-08 07:24:22 +00:00
this.input = new Phaser.InputHandler(this);
2013-10-25 15:54:40 +00:00
this.input.start();
}
}
else
{
2014-02-08 07:24:22 +00:00
if (this.input & & this.input.enabled)
2013-10-25 15:54:40 +00:00
{
this.input.stop();
}
}
}
});
< / pre >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-02-08 07:24:22 +00:00
on Sat Feb 08 2014 07:19:40 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-25 15:54:40 +00:00
< / span >
< / footer >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >
