mirror of
https://github.com/photonstorm/phaser
synced 2024-11-27 07:01:20 +00:00
1352 lines
37 KiB
HTML
1352 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Phaser Source: gameobjects/TileSprite.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 class="class-depth-0">
|
|
<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 class="class-depth-1">
|
|
<a href="Phaser.Animation.html">Animation</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.AnimationManager.html">AnimationManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.AnimationParser.html">AnimationParser</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.ArrayList.html">ArrayList</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.BitmapData.html">BitmapData</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.BitmapText.html">BitmapText</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Button.html">Button</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Cache.html">Cache</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Camera.html">Camera</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Canvas.html">Canvas</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Color.html">Color</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Device.html">Device</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Easing.html">Easing</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Back.html">Back</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Bounce.html">Bounce</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Circular.html">Circular</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Cubic.html">Cubic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Elastic.html">Elastic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Exponential.html">Exponential</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Linear.html">Linear</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Quartic.html">Quartic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Quintic.html">Quintic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Ellipse.html">Ellipse</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Events.html">Events</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Filter.html">Filter</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Frame.html">Frame</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.FrameData.html">FrameData</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Game.html">Game</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Gamepad.html">Gamepad</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.GamepadButton.html">GamepadButton</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Graphics.html">Graphics</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Group.html">Group</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Image.html">Image</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Input.html">Input</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.InputHandler.html">InputHandler</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Key.html">Key</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Keyboard.html">Keyboard</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Line.html">Line</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.LinkedList.html">LinkedList</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Loader.html">Loader</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.LoaderParser.html">LoaderParser</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Math.html">Math</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Mouse.html">Mouse</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.MSPointer.html">MSPointer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Net.html">Net</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Particle.html">Particle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Particles.html">Particles</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Physics.html">Physics</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Physics.Arcade.html">Arcade</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Physics.Ninja.html">Ninja</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Physics.P2.html">P2</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.Material.html">Material</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Plugin.html">Plugin</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.PluginManager.html">PluginManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Point.html">Point</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Pointer.html">Pointer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Polygon.html">Polygon</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.QuadTree.html">QuadTree</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Rectangle.html">Rectangle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RenderTexture.html">RenderTexture</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RetroFont.html">RetroFont</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.ScaleManager.html">ScaleManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Signal.html">Signal</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SignalBinding.html">SignalBinding</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SinglePad.html">SinglePad</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Sound.html">Sound</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SoundManager.html">SoundManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Sprite.html">Sprite</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Stage.html">Stage</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.State.html">State</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.StateManager.html">StateManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Text.html">Text</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tile.html">Tile</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tilemap.html">Tilemap</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TilemapParser.html">TilemapParser</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tileset.html">Tileset</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TileSprite.html">TileSprite</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Time.html">Time</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Timer.html">Timer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TimerEvent.html">TimerEvent</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Touch.html">Touch</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tween.html">Tween</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TweenManager.html">TweenManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Utils.html">Utils</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Utils.Debug.html">Debug</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.World.html">World</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: gameobjects/TileSprite.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="sunlight-highlight-javascript linenums">/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2014 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.
|
|
* Please note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.
|
|
*
|
|
* @class Phaser.TileSprite
|
|
* @constructor
|
|
* @param {Phaser.Game} game - A reference to the currently running game.
|
|
* @param {number} x - The x coordinate (in world space) to position the TileSprite at.
|
|
* @param {number} y - The y coordinate (in world space) to position the TileSprite at.
|
|
* @param {number} width - The width of the TileSprite.
|
|
* @param {number} height - The height of the TileSprite.
|
|
* @param {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
|
|
* @param {string|number} frame - If this TileSprite 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.TileSprite = function (game, x, y, width, height, key, frame) {
|
|
|
|
x = x || 0;
|
|
y = y || 0;
|
|
width = width || 256;
|
|
height = height || 256;
|
|
key = key || null;
|
|
frame = frame || null;
|
|
|
|
/**
|
|
* @property {Phaser.Game} game - A reference to the currently running Game.
|
|
*/
|
|
this.game = game;
|
|
|
|
/**
|
|
* @property {string} name - The user defined name given to this Sprite.
|
|
* @default
|
|
*/
|
|
this.name = '';
|
|
|
|
/**
|
|
* @property {number} type - The const type of this object.
|
|
* @readonly
|
|
*/
|
|
this.type = Phaser.TILESPRITE;
|
|
|
|
/**
|
|
* @property {number} z - The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.
|
|
*/
|
|
this.z = 0;
|
|
|
|
/**
|
|
* @property {Phaser.Events} events - The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
this.key = key;
|
|
|
|
/**
|
|
* @property {number} _frame - Internal cache var.
|
|
* @private
|
|
*/
|
|
this._frame = 0;
|
|
|
|
/**
|
|
* @property {string} _frameName - Internal cache var.
|
|
* @private
|
|
*/
|
|
this._frameName = '';
|
|
|
|
/**
|
|
* @property {Phaser.Point} _scroll - Internal cache var.
|
|
* @private
|
|
*/
|
|
this._scroll = new Phaser.Point();
|
|
|
|
PIXI.TilingSprite.call(this, PIXI.TextureCache['__default'], width, height);
|
|
|
|
this.loadTexture(key, frame);
|
|
|
|
this.position.set(x, y);
|
|
|
|
/**
|
|
* @property {Phaser.InputHandler|null} input - The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.
|
|
*/
|
|
this.input = null;
|
|
|
|
/**
|
|
* @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);
|
|
|
|
/**
|
|
* Should this Sprite be automatically culled if out of range of the camera?
|
|
* A culled sprite has its renderable property set to 'false'.
|
|
* 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.
|
|
*
|
|
* @property {boolean} autoCull - A flag indicating if the Sprite should be automatically camera culled or not.
|
|
* @default
|
|
*/
|
|
this.autoCull = false;
|
|
|
|
/**
|
|
* If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds
|
|
* and optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its
|
|
* bounds every frame to support it, and not all games need it. Enable it by setting the value to true.
|
|
* @property {boolean} checkWorldBounds
|
|
* @default
|
|
*/
|
|
this.checkWorldBounds = false;
|
|
|
|
/**
|
|
* @property {Phaser.Point} cameraOffset - If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.
|
|
*/
|
|
this.cameraOffset = new Phaser.Point();
|
|
|
|
/**
|
|
* By default Sprites won't add themselves to any physics system and their physics body will be `null`.
|
|
* To enable them for physics you need to call `game.physics.enable(sprite, system)` where `sprite` is this object
|
|
* and `system` is the Physics system you want to use to manage this body. Once enabled you can access all physics related properties via `Sprite.body`.
|
|
*
|
|
* Important: Enabling a Sprite for P2 or Ninja physics will automatically set `Sprite.anchor` to 0.5 so the physics body is centered on the Sprite.
|
|
* If you need a different result then adjust or re-create the Body shape offsets manually, and/or reset the anchor after enabling physics.
|
|
*
|
|
* @property {Phaser.Physics.Arcade.Body|Phaser.Physics.P2.Body|Phaser.Physics.Ninja.Body|null} body
|
|
* @default
|
|
*/
|
|
this.body = null;
|
|
|
|
/**
|
|
* A small internal cache:
|
|
* 0 = previous position.x
|
|
* 1 = previous position.y
|
|
* 2 = previous rotation
|
|
* 3 = renderID
|
|
* 4 = fresh? (0 = no, 1 = yes)
|
|
* 5 = outOfBoundsFired (0 = no, 1 = yes)
|
|
* 6 = exists (0 = no, 1 = yes)
|
|
* 7 = fixed to camera (0 = no, 1 = yes)
|
|
* 8 = destroy phase? (0 = no, 1 = yes)
|
|
* @property {Array} _cache
|
|
* @private
|
|
*/
|
|
this._cache = [ 0, 0, 0, 0, 1, 0, 1, 0, 0 ];
|
|
|
|
};
|
|
|
|
Phaser.TileSprite.prototype = Object.create(PIXI.TilingSprite.prototype);
|
|
Phaser.TileSprite.prototype.constructor = Phaser.TileSprite;
|
|
|
|
/**
|
|
* Automatically called by World.preUpdate.
|
|
*
|
|
* @method Phaser.TileSprite#preUpdate
|
|
* @memberof Phaser.TileSprite
|
|
*/
|
|
Phaser.TileSprite.prototype.preUpdate = function() {
|
|
|
|
if (this._cache[4] === 1 && this.exists)
|
|
{
|
|
this.world.setTo(this.parent.position.x + this.position.x, this.parent.position.y + this.position.y);
|
|
this.worldTransform.tx = this.world.x;
|
|
this.worldTransform.ty = this.world.y;
|
|
this._cache[0] = this.world.x;
|
|
this._cache[1] = this.world.y;
|
|
this._cache[2] = this.rotation;
|
|
|
|
if (this.body)
|
|
{
|
|
this.body.preUpdate();
|
|
}
|
|
|
|
this._cache[4] = 0;
|
|
|
|
return false;
|
|
}
|
|
|
|
this._cache[0] = this.world.x;
|
|
this._cache[1] = this.world.y;
|
|
this._cache[2] = this.rotation;
|
|
|
|
if (!this.exists || !this.parent.exists)
|
|
{
|
|
// Reset the renderOrderID
|
|
this._cache[3] = -1;
|
|
return false;
|
|
}
|
|
|
|
// Cache the bounds if we need it
|
|
if (this.autoCull || this.checkWorldBounds)
|
|
{
|
|
this._bounds.copyFrom(this.getBounds());
|
|
}
|
|
|
|
if (this.autoCull)
|
|
{
|
|
// Won't get rendered but will still get its transform updated
|
|
this.renderable = this.game.world.camera.screenView.intersects(this._bounds);
|
|
}
|
|
|
|
if (this.checkWorldBounds)
|
|
{
|
|
// The Sprite is already out of the world bounds, so let's check to see if it has come back again
|
|
if (this._cache[5] === 1 && this.game.world.bounds.intersects(this._bounds))
|
|
{
|
|
this._cache[5] = 0;
|
|
this.events.onEnterBounds.dispatch(this);
|
|
}
|
|
else if (this._cache[5] === 0 && !this.game.world.bounds.intersects(this._bounds))
|
|
{
|
|
// The Sprite WAS in the screen, but has now left.
|
|
this._cache[5] = 1;
|
|
this.events.onOutOfBounds.dispatch(this);
|
|
}
|
|
}
|
|
|
|
this.world.setTo(this.game.camera.x + this.worldTransform.tx, this.game.camera.y + this.worldTransform.ty);
|
|
|
|
if (this.visible)
|
|
{
|
|
this._cache[3] = this.game.stage.currentRenderOrderID++;
|
|
}
|
|
|
|
this.animations.update();
|
|
|
|
if (this._scroll.x !== 0)
|
|
{
|
|
this.tilePosition.x += this._scroll.x * this.game.time.physicsElapsed;
|
|
}
|
|
|
|
if (this._scroll.y !== 0)
|
|
{
|
|
this.tilePosition.y += this._scroll.y * this.game.time.physicsElapsed;
|
|
}
|
|
|
|
if (this.body)
|
|
{
|
|
this.body.preUpdate();
|
|
}
|
|
|
|
// Update any Children
|
|
for (var i = 0, len = this.children.length; i < len; i++)
|
|
{
|
|
this.children[i].preUpdate();
|
|
}
|
|
|
|
return true;
|
|
|
|
};
|
|
|
|
/**
|
|
* Override and use this function in your own custom objects to handle any update requirements you may have.
|
|
*
|
|
* @method Phaser.TileSprite#update
|
|
* @memberof Phaser.TileSprite
|
|
*/
|
|
Phaser.TileSprite.prototype.update = function() {
|
|
|
|
};
|
|
|
|
/**
|
|
* Internal function called by the World postUpdate cycle.
|
|
*
|
|
* @method Phaser.TileSprite#postUpdate
|
|
* @memberof Phaser.TileSprite
|
|
*/
|
|
Phaser.TileSprite.prototype.postUpdate = function() {
|
|
|
|
if (this.exists && this.body)
|
|
{
|
|
this.body.postUpdate();
|
|
}
|
|
|
|
// Fixed to Camera?
|
|
if (this._cache[7] === 1)
|
|
{
|
|
this.position.x = this.game.camera.view.x + this.cameraOffset.x;
|
|
this.position.y = this.game.camera.view.y + this.cameraOffset.y;
|
|
}
|
|
|
|
// Update any Children
|
|
for (var i = 0, len = this.children.length; i < len; i++)
|
|
{
|
|
this.children[i].postUpdate();
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* Sets this TileSprite to automatically scroll in the given direction until stopped via TileSprite.stopScroll().
|
|
* The scroll speed is specified in pixels per second.
|
|
* A negative x value will scroll to the left. A positive x value will scroll to the right.
|
|
* A negative y value will scroll up. A positive y value will scroll down.
|
|
*
|
|
* @method Phaser.TileSprite#autoScroll
|
|
* @memberof Phaser.TileSprite
|
|
*/
|
|
Phaser.TileSprite.prototype.autoScroll = function(x, y) {
|
|
|
|
this._scroll.set(x, y);
|
|
|
|
};
|
|
|
|
/**
|
|
* Stops an automatically scrolling TileSprite.
|
|
*
|
|
* @method Phaser.TileSprite#stopScroll
|
|
* @memberof Phaser.TileSprite
|
|
*/
|
|
Phaser.TileSprite.prototype.stopScroll = function() {
|
|
|
|
this._scroll.set(0, 0);
|
|
|
|
};
|
|
|
|
/**
|
|
* Changes the Texture the TileSprite 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.TileSprite#loadTexture
|
|
* @memberof Phaser.TileSprite
|
|
* @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.
|
|
* @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.TileSprite.prototype.loadTexture = function (key, frame) {
|
|
|
|
frame = frame || 0;
|
|
|
|
if (key instanceof Phaser.RenderTexture)
|
|
{
|
|
this.key = key.key;
|
|
this.setTexture(key);
|
|
return;
|
|
}
|
|
else if (key instanceof Phaser.BitmapData)
|
|
{
|
|
this.key = key;
|
|
this.setTexture(key.texture);
|
|
return;
|
|
}
|
|
else if (key instanceof PIXI.Texture)
|
|
{
|
|
this.key = key;
|
|
this.setTexture(key);
|
|
return;
|
|
}
|
|
else
|
|
{
|
|
if (key === null || typeof key === 'undefined')
|
|
{
|
|
this.key = '__default';
|
|
this.setTexture(PIXI.TextureCache[this.key]);
|
|
return;
|
|
}
|
|
else if (typeof key === 'string' && !this.game.cache.checkImageKey(key))
|
|
{
|
|
this.key = '__missing';
|
|
this.setTexture(PIXI.TextureCache[this.key]);
|
|
return;
|
|
}
|
|
|
|
if (this.game.cache.isSpriteSheet(key))
|
|
{
|
|
this.key = key;
|
|
|
|
// var frameData = this.game.cache.getFrameData(key);
|
|
this.animations.loadFrameData(this.game.cache.getFrameData(key));
|
|
|
|
if (typeof frame === 'string')
|
|
{
|
|
this.frameName = frame;
|
|
}
|
|
else
|
|
{
|
|
this.frame = frame;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
this.key = key;
|
|
this.setTexture(PIXI.TextureCache[key]);
|
|
return;
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* Destroys the TileSprite. This removes it from its parent group, destroys the event and animation handlers if present
|
|
* and nulls its reference to game, freeing it up for garbage collection.
|
|
*
|
|
* @method Phaser.TileSprite#destroy
|
|
* @memberof Phaser.TileSprite
|
|
* @param {boolean} [destroyChildren=true] - Should every child of this object have its destroy method called?
|
|
*/
|
|
Phaser.TileSprite.prototype.destroy = function(destroyChildren) {
|
|
|
|
if (this.game === null || this.destroyPhase) { return; }
|
|
|
|
if (typeof destroyChildren === 'undefined') { destroyChildren = true; }
|
|
|
|
this._cache[8] = 1;
|
|
|
|
if (this.filters)
|
|
{
|
|
this.filters = null;
|
|
}
|
|
|
|
if (this.parent)
|
|
{
|
|
if (this.parent instanceof Phaser.Group)
|
|
{
|
|
this.parent.remove(this);
|
|
}
|
|
else
|
|
{
|
|
this.parent.removeChild(this);
|
|
}
|
|
}
|
|
|
|
this.animations.destroy();
|
|
|
|
this.events.destroy();
|
|
|
|
var i = this.children.length;
|
|
|
|
if (destroyChildren)
|
|
{
|
|
while (i--)
|
|
{
|
|
this.children[i].destroy(destroyChildren);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
while (i--)
|
|
{
|
|
this.removeChild(this.children[i]);
|
|
}
|
|
}
|
|
|
|
this.exists = false;
|
|
this.visible = false;
|
|
|
|
this.filters = null;
|
|
this.mask = null;
|
|
this.game = null;
|
|
|
|
this._cache[8] = 0;
|
|
|
|
};
|
|
|
|
/**
|
|
* 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.TileSprite#play
|
|
* @memberof Phaser.TileSprite
|
|
* @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.TileSprite.prototype.play = function (name, frameRate, loop, killOnComplete) {
|
|
|
|
return this.animations.play(name, frameRate, loop, killOnComplete);
|
|
|
|
};
|
|
|
|
/**
|
|
* Resets the TileSprite. This places the TileSprite at the given x/y world coordinates, resets the tilePosition and then
|
|
* sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state.
|
|
* If the TileSprite has a physics body that too is reset.
|
|
*
|
|
* @method Phaser.TileSprite#reset
|
|
* @memberof Phaser.TileSprite
|
|
* @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.
|
|
* @return (Phaser.TileSprite) This instance.
|
|
*/
|
|
Phaser.TileSprite.prototype.reset = function(x, y) {
|
|
|
|
this.world.setTo(x, y);
|
|
this.position.x = x;
|
|
this.position.y = y;
|
|
this.alive = true;
|
|
this.exists = true;
|
|
this.visible = true;
|
|
this.renderable = true;
|
|
this._outOfBoundsFired = false;
|
|
|
|
this.tilePosition.x = 0;
|
|
this.tilePosition.y = 0;
|
|
|
|
if (this.body)
|
|
{
|
|
this.body.reset(x, y, false, false);
|
|
}
|
|
|
|
this._cache[4] = 1;
|
|
|
|
return this;
|
|
|
|
};
|
|
|
|
/**
|
|
* 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.TileSprite#angle
|
|
* @property {number} angle - The angle of this Sprite in degrees.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "angle", {
|
|
|
|
get: function() {
|
|
|
|
return Phaser.Math.wrapAngle(Phaser.Math.radToDeg(this.rotation));
|
|
|
|
},
|
|
|
|
set: function(value) {
|
|
|
|
this.rotation = Phaser.Math.degToRad(Phaser.Math.wrapAngle(value));
|
|
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* @name Phaser.TileSprite#frame
|
|
* @property {number} frame - Gets or sets the current frame index and updates the Texture Cache for display.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "frame", {
|
|
|
|
get: function () {
|
|
return this.animations.frame;
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
if (value !== this.animations.frame)
|
|
{
|
|
this.animations.frame = value;
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* @name Phaser.TileSprite#frameName
|
|
* @property {string} frameName - Gets or sets the current frame name and updates the Texture Cache for display.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "frameName", {
|
|
|
|
get: function () {
|
|
return this.animations.frameName;
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
if (value !== this.animations.frameName)
|
|
{
|
|
this.animations.frameName = value;
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* An TileSprite that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in TileSprite.cameraOffset.
|
|
* Note that the cameraOffset values are in addition to any parent in the display list.
|
|
* So if this TileSprite was in a Group that has x: 200, then this will be added to the cameraOffset.x
|
|
*
|
|
* @name Phaser.TileSprite#fixedToCamera
|
|
* @property {boolean} fixedToCamera - Set to true to fix this TileSprite to the Camera at its current world coordinates.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "fixedToCamera", {
|
|
|
|
get: function () {
|
|
|
|
return !!this._cache[7];
|
|
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
if (value)
|
|
{
|
|
this._cache[7] = 1;
|
|
this.cameraOffset.set(this.x, this.y);
|
|
}
|
|
else
|
|
{
|
|
this._cache[7] = 0;
|
|
}
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* TileSprite.exists controls if the core game loop and physics update this TileSprite or not.
|
|
* When you set TileSprite.exists to false it will remove its Body from the physics world (if it has one) and also set TileSprite.visible to false.
|
|
* Setting TileSprite.exists to true will re-add the Body to the physics world (if it has a body) and set TileSprite.visible to true.
|
|
*
|
|
* @name Phaser.TileSprite#exists
|
|
* @property {boolean} exists - If the TileSprite is processed by the core game update and physics.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "exists", {
|
|
|
|
get: function () {
|
|
|
|
return !!this._cache[6];
|
|
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
if (value)
|
|
{
|
|
// exists = true
|
|
this._cache[6] = 1;
|
|
|
|
if (this.body && this.body.type === Phaser.Physics.P2JS)
|
|
{
|
|
this.body.addToWorld();
|
|
}
|
|
|
|
this.visible = true;
|
|
}
|
|
else
|
|
{
|
|
// exists = false
|
|
this._cache[6] = 0;
|
|
|
|
if (this.body && this.body.type === Phaser.Physics.P2JS)
|
|
{
|
|
this.body.safeRemove = true;
|
|
}
|
|
|
|
this.visible = false;
|
|
|
|
}
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* By default a TileSprite 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.
|
|
*
|
|
* @name Phaser.TileSprite#inputEnabled
|
|
* @property {boolean} inputEnabled - Set to true to allow this object to receive input events.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "inputEnabled", {
|
|
|
|
get: function () {
|
|
|
|
return (this.input && this.input.enabled);
|
|
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
if (value)
|
|
{
|
|
if (this.input === null)
|
|
{
|
|
this.input = new Phaser.InputHandler(this);
|
|
this.input.start();
|
|
}
|
|
else if (this.input && !this.input.enabled)
|
|
{
|
|
this.input.start();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (this.input && this.input.enabled)
|
|
{
|
|
this.input.stop();
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* The position of the TileSprite on the x axis relative to the local coordinates of the parent.
|
|
*
|
|
* @name Phaser.TileSprite#x
|
|
* @property {number} x - The position of the TileSprite on the x axis relative to the local coordinates of the parent.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "x", {
|
|
|
|
get: function () {
|
|
|
|
return this.position.x;
|
|
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
this.position.x = value;
|
|
|
|
if (this.body && this.body.type === Phaser.Physics.ARCADE && this.body.phase === 2)
|
|
{
|
|
this.body._reset = 1;
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* The position of the TileSprite on the y axis relative to the local coordinates of the parent.
|
|
*
|
|
* @name Phaser.TileSprite#y
|
|
* @property {number} y - The position of the TileSprite on the y axis relative to the local coordinates of the parent.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "y", {
|
|
|
|
get: function () {
|
|
|
|
return this.position.y;
|
|
|
|
},
|
|
|
|
set: function (value) {
|
|
|
|
this.position.y = value;
|
|
|
|
if (this.body && this.body.type === Phaser.Physics.ARCADE && this.body.phase === 2)
|
|
{
|
|
this.body._reset = 1;
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
/**
|
|
* @name Phaser.TileSprite#destroyPhase
|
|
* @property {boolean} destroyPhase - True if this object is currently being destroyed.
|
|
*/
|
|
Object.defineProperty(Phaser.TileSprite.prototype, "destroyPhase", {
|
|
|
|
get: function () {
|
|
|
|
return !!this._cache[8];
|
|
|
|
}
|
|
|
|
});
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
Phaser Copyright © 2012-2014 Photon Storm Ltd.
|
|
</span>
|
|
<br />
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
|
|
on Tue Apr 29 2014 14:51:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</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( {
|
|
anchorName : function(i, heading, prefix) {
|
|
return $(heading).attr("id") || ( prefix + i );
|
|
},
|
|
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>
|