phaser/docs/TilemapLayer.js.html

1434 lines
36 KiB
HTML
Raw Normal View History

2013-11-28 15:57:09 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Source: tilemap/TilemapLayer.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>
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li>
<a href="Phaser.BitmapFont.html">BitmapFont</a>
</li>
2013-11-28 15:57:09 +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>
<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.Ellipse.html">Ellipse</a>
</li>
2013-11-28 15:57:09 +00:00
<li>
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
<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.GameObjectCreator.html">GameObjectCreator</a>
</li>
2013-11-28 15:57:09 +00:00
<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-11-28 15:57:09 +00:00
<li>
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li>
<a href="Phaser.Group.html">Group</a>
</li>
<li>
<a href="Phaser.Image.html">Image</a>
</li>
2013-11-28 15:57:09 +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-11-28 15:57:09 +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>
<li>
<a href="Phaser.Physics.Body.html">Body</a>
</li>
<li>
<a href="Phaser.Physics.CollisionGroup.html">CollisionGroup</a>
</li>
<li>
<a href="Phaser.Physics.ContactMaterial.html">ContactMaterial</a>
</li>
<li>
<a href="Phaser.Physics.InversePointProxy.html">InversePointProxy</a>
</li>
<li>
<a href="Phaser.Physics.Material.html">Material</a>
</li>
<li>
<a href="Phaser.Physics.PointProxy.html">PointProxy</a>
</li>
<li>
<a href="Phaser.Physics.Spring.html">Spring</a>
</li>
<li>
<a href="Phaser.Physics.World.html">World</a>
</li>
2013-11-28 15:57:09 +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>
<li>
<a href="Phaser.Polygon.html">Polygon</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-11-28 15:57:09 +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.SpriteBatch.html">SpriteBatch</a>
</li>
2013-11-28 15:57:09 +00:00
<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>
<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>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li>
<a href="Phaser.Time.html">Time</a>
</li>
<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-11-28 15:57:09 +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>
<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#getBounds">getBounds</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-11-28 15:57:09 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: tilemap/TilemapLayer.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
2013-11-28 15:57:09 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* A Tilemap Layer is a set of map data combined with a Tileset in order to render that data to the game.
*
* @class Phaser.TilemapLayer
* @constructor
* @param {Phaser.Game} game - Game reference to the currently running game.
* @param {Phaser.Tilemap} tilemap - The tilemap to which this layer belongs.
2014-02-05 06:29:17 +00:00
* @param {number} index - The layer index within the map that this TilemapLayer represents.
* @param {number} width - Width of the renderable area of the layer.
* @param {number} height - Height of the renderable area of the layer.
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.TilemapLayer = function (game, tilemap, index, width, height) {
2013-11-28 15:57:09 +00:00
/**
* @property {Phaser.Game} game - A reference to the currently running Game.
*/
this.game = game;
2014-02-05 06:29:17 +00:00
/**
* @property {Phaser.Tilemap} map - The Tilemap to which this layer is bound.
*/
this.map = tilemap;
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {number} index - The index of this layer within the Tilemap.
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.index = index;
/**
* @property {object} layer - The layer object within the Tilemap that this layer represents.
*/
this.layer = tilemap.layers[index];
/**
* @property {HTMLCanvasElement} canvas - The canvas to which this TilemapLayer draws.
*/
this.canvas = Phaser.Canvas.create(width, height);
2013-11-28 15:57:09 +00:00
/**
* @property {CanvasRenderingContext2D} context - The 2d context of the canvas.
*/
this.context = this.canvas.getContext('2d');
/**
* @property {PIXI.BaseTexture} baseTexture - Required Pixi var.
*/
this.baseTexture = new PIXI.BaseTexture(this.canvas);
/**
* @property {PIXI.Texture} texture - Required Pixi var.
*/
this.texture = new PIXI.Texture(this.baseTexture);
/**
* @property {Phaser.Frame} textureFrame - Dimensions of the renderable area.
*/
2014-02-05 06:29:17 +00:00
this.textureFrame = new Phaser.Frame(0, 0, 0, width, height, 'tilemapLayer', game.rnd.uuid());
Phaser.Sprite.call(this, this.game, 0, 0, this.texture, this.textureFrame);
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
/**
* @property {string} name - The name of the layer.
*/
this.name = '';
2013-11-28 15:57:09 +00:00
/**
* @property {number} type - The const type of this object.
* @default
*/
this.type = Phaser.TILEMAPLAYER;
/**
2014-02-05 06:29:17 +00:00
* An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
* @property {boolean} fixedToCamera - Fixes this object to the Camera.
2013-11-28 15:57:09 +00:00
* @default
*/
this.fixedToCamera = true;
/**
2014-02-05 06:29:17 +00:00
* @property {Phaser.Point} cameraOffset - If this object is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.cameraOffset = new Phaser.Point(0, 0);
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {string} tileColor - If no tileset is given the tiles will be rendered as rectangles in this color. Provide in hex or rgb/rgba string format.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.tileColor = 'rgb(255, 255, 255)';
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {boolean} debug - If set to true the collideable tile edges path will be rendered. Only works when game is running in Phaser.CANVAS mode.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.debug = false;
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {number} debugAlpha - If debug is true then the tileset is rendered with this alpha level, to make the tile edges clearer.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.debugAlpha = 0.5;
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {string} debugColor - If debug is true this is the color used to outline the edges of collidable tiles. Provide in hex or rgb/rgba string format.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.debugColor = 'rgba(0, 255, 0, 1)';
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {boolean} debugFill - If true the debug tiles are filled with debugFillColor AND stroked around.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.debugFill = false;
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {string} debugFillColor - If debugFill is true this is the color used to fill the tiles. Provide in hex or rgb/rgba string format.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.debugFillColor = 'rgba(0, 255, 0, 0.2)';
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {string} debugCallbackColor - If debug is true this is the color used to outline the edges of tiles that have collision callbacks. Provide in hex or rgb/rgba string format.
* @default
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.debugCallbackColor = 'rgba(255, 0, 0, 1)';
2013-11-28 15:57:09 +00:00
/**
2014-02-05 06:29:17 +00:00
* @property {number} scrollFactorX - speed at which this layer scrolls
* horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls
* half as quickly as the 'normal' camera-locked layers do)
* @default 1
2013-11-28 15:57:09 +00:00
*/
2014-02-05 06:29:17 +00:00
this.scrollFactorX = 1;
/**
* @property {number} scrollFactorY - speed at which this layer scrolls
* vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls
* half as quickly as the 'normal' camera-locked layers do)
* @default 1
*/
this.scrollFactorY = 1;
/**
* @property {boolean} dirty - Flag controlling when to re-render the layer.
*/
this.dirty = true;
/**
* @property {number} _cw - Local collision var.
* @private
*/
this._cw = tilemap.tileWidth;
/**
* @property {number} _ch - Local collision var.
* @private
*/
this._ch = tilemap.tileHeight;
2013-11-28 15:57:09 +00:00
/**
* @property {number} _ga - Local render loop var to help avoid gc spikes.
* @private
*/
this._ga = 1;
/**
* @property {number} _dx - Local render loop var to help avoid gc spikes.
* @private
*/
this._dx = 0;
/**
* @property {number} _dy - Local render loop var to help avoid gc spikes.
* @private
*/
this._dy = 0;
/**
* @property {number} _dw - Local render loop var to help avoid gc spikes.
* @private
*/
this._dw = 0;
/**
* @property {number} _dh - Local render loop var to help avoid gc spikes.
* @private
*/
this._dh = 0;
/**
* @property {number} _tx - Local render loop var to help avoid gc spikes.
* @private
*/
this._tx = 0;
/**
* @property {number} _ty - Local render loop var to help avoid gc spikes.
* @private
*/
this._ty = 0;
/**
* @property {number} _tw - Local render loop var to help avoid gc spikes.
* @private
*/
this._tw = 0;
/**
* @property {number} _th - Local render loop var to help avoid gc spikes.
* @private
*/
this._th = 0;
/**
* @property {number} _tl - Local render loop var to help avoid gc spikes.
* @private
*/
this._tl = 0;
/**
* @property {number} _maxX - Local render loop var to help avoid gc spikes.
* @private
*/
this._maxX = 0;
/**
* @property {number} _maxY - Local render loop var to help avoid gc spikes.
* @private
*/
this._maxY = 0;
/**
* @property {number} _startX - Local render loop var to help avoid gc spikes.
* @private
*/
this._startX = 0;
/**
* @property {number} _startY - Local render loop var to help avoid gc spikes.
* @private
*/
this._startY = 0;
/**
* @property {array} _results - Local render loop var to help avoid gc spikes.
* @private
*/
this._results = [];
/**
* @property {number} _x - Private var.
* @private
*/
this._x = 0;
/**
* @property {number} _y - Private var.
* @private
*/
this._y = 0;
/**
* @property {number} _prevX - Private var.
* @private
*/
this._prevX = 0;
/**
* @property {number} _prevY - Private var.
* @private
*/
this._prevY = 0;
2014-02-05 06:29:17 +00:00
this.updateMax();
2013-11-28 15:57:09 +00:00
};
Phaser.TilemapLayer.prototype = Object.create(Phaser.Sprite.prototype);
Phaser.TilemapLayer.prototype = Phaser.Utils.extend(true, Phaser.TilemapLayer.prototype, Phaser.Sprite.prototype, PIXI.Sprite.prototype);
Phaser.TilemapLayer.prototype.constructor = Phaser.TilemapLayer;
/**
2014-02-05 06:29:17 +00:00
* Automatically called by World.postUpdate. Handles cache updates.
2013-11-28 15:57:09 +00:00
*
2014-02-05 06:29:17 +00:00
* @method Phaser.TilemapLayer#postUpdate
2013-11-28 15:57:09 +00:00
* @memberof Phaser.TilemapLayer
*/
2014-02-05 06:29:17 +00:00
Phaser.TilemapLayer.prototype.postUpdate = function () {
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
Phaser.Sprite.prototype.postUpdate.call(this);
// Stops you being able to auto-scroll the camera if it's not following a sprite
2013-11-28 15:57:09 +00:00
this.scrollX = this.game.camera.x * this.scrollFactorX;
this.scrollY = this.game.camera.y * this.scrollFactorY;
this.render();
}
/**
* Sets the world size to match the size of this layer.
*
* @method Phaser.TilemapLayer#resizeWorld
* @memberof Phaser.TilemapLayer
*/
Phaser.TilemapLayer.prototype.resizeWorld = function () {
2014-02-05 06:29:17 +00:00
this.game.world.setBounds(0, 0, this.layer.widthInPixels, this.layer.heightInPixels);
2013-11-28 15:57:09 +00:00
}
/**
2014-02-05 06:29:17 +00:00
* Take an x coordinate that doesn't account for scrollFactorX and 'fix' it
2013-11-28 15:57:09 +00:00
* into a scrolled local space. Used primarily internally
* @method Phaser.TilemapLayer#_fixX
* @memberof Phaser.TilemapLayer
* @private
* @param {number} x - x coordinate in camera space
* @return {number} x coordinate in scrollFactor-adjusted dimensions
*/
Phaser.TilemapLayer.prototype._fixX = function(x) {
2014-02-05 06:29:17 +00:00
if (x &lt; 0)
{
x = 0;
}
2013-11-28 15:57:09 +00:00
if (this.scrollFactorX === 1)
{
return x;
}
2014-02-05 06:29:17 +00:00
return this._x + (x - (this._x / this.scrollFactorX));
2013-11-28 15:57:09 +00:00
}
/**
2014-02-05 06:29:17 +00:00
* Take an x coordinate that _does_ account for scrollFactorX and 'unfix' it
2013-11-28 15:57:09 +00:00
* back to camera space. Used primarily internally
* @method Phaser.TilemapLayer#_unfixX
* @memberof Phaser.TilemapLayer
* @private
* @param {number} x - x coordinate in scrollFactor-adjusted dimensions
* @return {number} x coordinate in camera space
*/
Phaser.TilemapLayer.prototype._unfixX = function(x) {
if (this.scrollFactorX === 1)
{
return x;
}
2014-02-05 06:29:17 +00:00
return (this._x / this.scrollFactorX) + (x - this._x);
2013-11-28 15:57:09 +00:00
}
/**
* Take a y coordinate that doesn't account for scrollFactorY and 'fix' it
* into a scrolled local space. Used primarily internally
* @method Phaser.TilemapLayer#_fixY
* @memberof Phaser.TilemapLayer
* @private
* @param {number} y - y coordinate in camera space
* @return {number} y coordinate in scrollFactor-adjusted dimensions
*/
Phaser.TilemapLayer.prototype._fixY = function(y) {
2014-02-05 06:29:17 +00:00
if (y &lt; 0)
{
y = 0;
}
2013-11-28 15:57:09 +00:00
if (this.scrollFactorY === 1)
{
return y;
}
2014-02-05 06:29:17 +00:00
return this._y + (y - (this._y / this.scrollFactorY));
2013-11-28 15:57:09 +00:00
}
/**
* Take a y coordinate that _does_ account for scrollFactorY and 'unfix' it
* back to camera space. Used primarily internally
* @method Phaser.TilemapLayer#_unfixY
* @memberof Phaser.TilemapLayer
* @private
* @param {number} y - y coordinate in scrollFactor-adjusted dimensions
* @return {number} y coordinate in camera space
*/
Phaser.TilemapLayer.prototype._unfixY = function(y) {
if (this.scrollFactorY === 1)
{
return y;
}
2014-02-05 06:29:17 +00:00
return (this._y / this.scrollFactorY) + (y - this._y);
2013-11-28 15:57:09 +00:00
}
/**
* Convert a pixel value to a tile coordinate.
* @method Phaser.TilemapLayer#getTileX
* @memberof Phaser.TilemapLayer
* @param {number} x - X position of the point in target tile.
* @return {Phaser.Tile} The tile with specific properties.
*/
Phaser.TilemapLayer.prototype.getTileX = function (x) {
2014-02-05 06:29:17 +00:00
// var tileWidth = this.tileWidth * this.scale.x;
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
return this.game.math.snapToFloor(this._fixX(x), this.map.tileWidth) / this.map.tileWidth;
2013-11-28 15:57:09 +00:00
}
/**
* Convert a pixel value to a tile coordinate.
* @method Phaser.TilemapLayer#getTileY
* @memberof Phaser.TilemapLayer
* @param {number} y - Y position of the point in target tile.
* @return {Phaser.Tile} The tile with specific properties.
*/
Phaser.TilemapLayer.prototype.getTileY = function (y) {
2014-02-05 06:29:17 +00:00
// var tileHeight = this.tileHeight * this.scale.y;
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
return this.game.math.snapToFloor(this._fixY(y), this.map.tileHeight) / this.map.tileHeight;
2013-11-28 15:57:09 +00:00
}
/**
* Convert a pixel value to a tile coordinate.
* @method Phaser.TilemapLayer#getTileXY
* @memberof Phaser.TilemapLayer
* @param {number} x - X position of the point in target tile.
* @param {number} y - Y position of the point in target tile.
2014-02-05 06:29:17 +00:00
* @param {Phaser.Point|object} point - The Point object to set the x and y values on.
* @return {Phaser.Point|object} A Point object with its x and y properties set.
2013-11-28 15:57:09 +00:00
*/
Phaser.TilemapLayer.prototype.getTileXY = function (x, y, point) {
point.x = this.getTileX(x);
point.y = this.getTileY(y);
return point;
}
/**
2014-02-05 06:29:17 +00:00
* Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.
2013-11-28 15:57:09 +00:00
* @method Phaser.TilemapLayer#getTiles
* @memberof Phaser.TilemapLayer
2014-02-05 06:29:17 +00:00
* @param {number} x - X position of the top left corner.
* @param {number} y - Y position of the top left corner.
* @param {number} width - Width of the area to get.
* @param {number} height - Height of the area to get.
* @param {boolean} [collides=false] - If true only return tiles that collide on one or more faces.
2013-11-28 15:57:09 +00:00
* @return {array} Array with tiles informations (each contains x, y, and the tile).
*/
Phaser.TilemapLayer.prototype.getTiles = function (x, y, width, height, collides) {
// Should we only get tiles that have at least one of their collision flags set? (true = yes, false = no just get them all)
if (typeof collides === 'undefined') { collides = false; }
// adjust the x,y coordinates for scrollFactor
2014-02-05 06:29:17 +00:00
x = this._fixX(x);
y = this._fixY(y);
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
if (width > this.layer.widthInPixels)
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
width = this.layer.widthInPixels;
2013-11-28 15:57:09 +00:00
}
2014-02-05 06:29:17 +00:00
if (height > this.layer.heightInPixels)
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
height = this.layer.heightInPixels;
2013-11-28 15:57:09 +00:00
}
// Convert the pixel values into tile coordinates
2014-02-05 06:29:17 +00:00
this._tx = this.game.math.snapToFloor(x, this._cw) / this._cw;
this._ty = this.game.math.snapToFloor(y, this._ch) / this._ch;
this._tw = (this.game.math.snapToCeil(width, this._cw) + this._cw) / this._cw;
this._th = (this.game.math.snapToCeil(height, this._ch) + this._ch) / this._ch;
2013-11-28 15:57:09 +00:00
// This should apply the layer x/y here
2014-02-05 06:29:17 +00:00
this._results.length = 0;
2013-11-28 15:57:09 +00:00
for (var wy = this._ty; wy &lt; this._ty + this._th; wy++)
{
for (var wx = this._tx; wx &lt; this._tx + this._tw; wx++)
{
if (this.layer.data[wy] && this.layer.data[wy][wx])
{
2014-02-05 06:29:17 +00:00
if (collides === false || (collides && this.layer.data[wy][wx].canCollide))
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
// Convert tile coordinates back to camera space for return
var _wx = this._unfixX(wx * this._cw) / this._cw;
var _wy = this._unfixY(wy * this._ch) / this._ch;
this._results.push({
x: _wx * this._cw,
y: _wy * this._ch,
right: (_wx * this._cw) + this._cw,
bottom: (_wy * this._ch) + this._ch,
tile: this.layer.data[wy][wx],
layer: this.layer.data[wy][wx].layer
});
2013-11-28 15:57:09 +00:00
}
}
}
}
return this._results;
}
/**
* Internal function to update maximum values.
* @method Phaser.TilemapLayer#updateMax
* @memberof Phaser.TilemapLayer
*/
Phaser.TilemapLayer.prototype.updateMax = function () {
2014-02-05 06:29:17 +00:00
this._maxX = this.game.math.ceil(this.canvas.width / this.map.tileWidth) + 1;
this._maxY = this.game.math.ceil(this.canvas.height / this.map.tileHeight) + 1;
2013-11-28 15:57:09 +00:00
if (this.layer)
{
if (this._maxX > this.layer.width)
{
this._maxX = this.layer.width;
}
if (this._maxY > this.layer.height)
{
this._maxY = this.layer.height;
}
}
this.dirty = true;
}
/**
* Renders the tiles to the layer canvas and pushes to the display.
* @method Phaser.TilemapLayer#render
* @memberof Phaser.TilemapLayer
*/
Phaser.TilemapLayer.prototype.render = function () {
2014-02-05 06:29:17 +00:00
if (this.layer.dirty)
2013-11-28 15:57:09 +00:00
{
this.dirty = true;
}
2014-02-05 06:29:17 +00:00
if (!this.dirty || !this.visible)
2013-11-28 15:57:09 +00:00
{
return;
}
this._prevX = this._dx;
this._prevY = this._dy;
2014-02-05 06:29:17 +00:00
this._dx = -(this._x - (this._startX * this.map.tileWidth));
this._dy = -(this._y - (this._startY * this.map.tileHeight));
2013-11-28 15:57:09 +00:00
this._tx = this._dx;
this._ty = this._dy;
this.context.clearRect(0, 0, this.canvas.width, this.canvas.height);
2014-02-05 06:29:17 +00:00
this.context.fillStyle = this.tileColor;
var tile;
var set;
var ox = 0;
var oy = 0;
if (this.debug)
{
this.context.globalAlpha = this.debugAlpha;
}
for (var y = this._startY, lenY = this._startY + this._maxY; y &lt; lenY; y++)
2013-11-28 15:57:09 +00:00
{
this._column = this.layer.data[y];
2014-02-05 06:29:17 +00:00
for (var x = this._startX, lenX = this._startX + this._maxX; x &lt; lenX; x++)
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
if (this._column[x])
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
tile = this._column[x];
if (this.map.tiles[tile.index])
{
set = this.map.tilesets[this.map.tiles[tile.index][2]]
if (set.image)
{
if (this.debug === false && tile.alpha !== this.context.globalAlpha)
{
this.context.globalAlpha = tile.alpha;
}
if (set.tileWidth !== this.map.tileWidth || set.tileHeight !== this.map.tileHeight)
{
// TODO: Smaller sized tile check
this.context.drawImage(
this.map.tilesets[this.map.tiles[tile.index][2]].image,
this.map.tiles[tile.index][0],
this.map.tiles[tile.index][1],
set.tileWidth,
set.tileHeight,
Math.floor(this._tx),
Math.floor(this._ty) - (set.tileHeight - this.map.tileHeight),
set.tileWidth,
set.tileHeight
);
}
else
{
this.context.drawImage(
this.map.tilesets[this.map.tiles[tile.index][2]].image,
this.map.tiles[tile.index][0],
this.map.tiles[tile.index][1],
this.map.tileWidth,
this.map.tileHeight,
Math.floor(this._tx),
Math.floor(this._ty),
this.map.tileWidth,
this.map.tileHeight
);
}
if (tile.debug)
{
this.context.fillStyle = 'rgba(0, 255, 0, 0.4)';
this.context.fillRect(Math.floor(this._tx), Math.floor(this._ty), this.map.tileWidth, this.map.tileHeight);
}
}
else
{
this.context.fillRect(Math.floor(this._tx), Math.floor(this._ty), this.map.tileWidth, this.map.tileHeight);
}
}
2013-11-28 15:57:09 +00:00
}
2014-02-05 06:29:17 +00:00
this._tx += this.map.tileWidth;
2013-11-28 15:57:09 +00:00
}
this._tx = this._dx;
2014-02-05 06:29:17 +00:00
this._ty += this.map.tileHeight;
}
if (this.debug)
{
this.context.globalAlpha = 1;
this.renderDebug();
2013-11-28 15:57:09 +00:00
}
// Only needed if running in WebGL, otherwise this array will never get cleared down I don't think!
2014-02-05 06:29:17 +00:00
if (this.game.renderType === Phaser.WEBGL)
2013-11-28 15:57:09 +00:00
{
PIXI.texturesToUpdate.push(this.baseTexture);
}
this.dirty = false;
2014-02-05 06:29:17 +00:00
this.layer.dirty = false;
2013-11-28 15:57:09 +00:00
return true;
}
/**
2014-02-05 06:29:17 +00:00
* Renders a collision debug overlay on-top of the canvas. Called automatically by render when debug = true.
* @method Phaser.TilemapLayer#renderDebug
2013-11-28 15:57:09 +00:00
* @memberof Phaser.TilemapLayer
*/
2014-02-05 06:29:17 +00:00
Phaser.TilemapLayer.prototype.renderDebug = function () {
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
this._tx = this._dx;
this._ty = this._dy;
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
this.context.strokeStyle = this.debugColor;
this.context.fillStyle = this.debugFillColor;
for (var y = this._startY, lenY = this._startY + this._maxY; y &lt; lenY; y++)
{
this._column = this.layer.data[y];
for (var x = this._startX, lenX = this._startX + this._maxX; x &lt; lenX; x++)
{
var tile = this._column[x];
if (tile && (tile.faceTop || tile.faceBottom || tile.faceLeft || tile.faceRight))
{
this._tx = Math.floor(this._tx);
if (this.debugFill)
{
this.context.fillRect(this._tx, this._ty, this._cw, this._ch);
}
this.context.beginPath();
if (tile.faceTop)
{
this.context.moveTo(this._tx, this._ty);
this.context.lineTo(this._tx + this._cw, this._ty);
}
if (tile.faceBottom)
{
this.context.moveTo(this._tx, this._ty + this._ch);
this.context.lineTo(this._tx + this._cw, this._ty + this._ch);
}
if (tile.faceLeft)
{
this.context.moveTo(this._tx, this._ty);
this.context.lineTo(this._tx, this._ty + this._ch);
}
if (tile.faceRight)
{
this.context.moveTo(this._tx + this._cw, this._ty);
this.context.lineTo(this._tx + this._cw, this._ty + this._ch);
}
this.context.stroke();
}
// Collision callback
if (tile && (tile.collisionCallback || tile.layer.callbacks[tile.index]))
{
this.context.fillStyle = this.debugCallbackColor;
this.context.fillRect(this._tx, this._ty, this._cw, this._ch);
this.context.fillStyle = this.debugFillColor;
}
this._tx += this.map.tileWidth;
}
this._tx = this._dx;
this._ty += this.map.tileHeight;
}
2013-11-28 15:57:09 +00:00
}
/**
* @name Phaser.TilemapLayer#scrollX
* @property {number} scrollX - Scrolls the map horizontally or returns the current x position.
*/
Object.defineProperty(Phaser.TilemapLayer.prototype, "scrollX", {
get: function () {
return this._x;
},
set: function (value) {
2014-02-05 06:29:17 +00:00
// if (value !== this._x && value >= 0 && this.layer && this.layer.widthInPixels > this.width)
if (value !== this._x && value >= 0 && this.layer.widthInPixels > this.width)
2013-11-28 15:57:09 +00:00
{
this._x = value;
2014-02-05 06:29:17 +00:00
if (this._x > (this.layer.widthInPixels - this.width))
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
this._x = this.layer.widthInPixels - this.width;
2013-11-28 15:57:09 +00:00
}
2014-02-05 06:29:17 +00:00
this._startX = this.game.math.floor(this._x / this.map.tileWidth);
2013-11-28 15:57:09 +00:00
if (this._startX &lt; 0)
{
this._startX = 0;
}
if (this._startX + this._maxX > this.layer.width)
{
this._startX = this.layer.width - this._maxX;
}
this.dirty = true;
}
}
});
/**
* @name Phaser.TilemapLayer#scrollY
* @property {number} scrollY - Scrolls the map vertically or returns the current y position.
*/
Object.defineProperty(Phaser.TilemapLayer.prototype, "scrollY", {
get: function () {
return this._y;
},
set: function (value) {
2014-02-05 06:29:17 +00:00
// if (value !== this._y && value >= 0 && this.layer && this.heightInPixels > this.renderHeight)
if (value !== this._y && value >= 0 && this.layer.heightInPixels > this.height)
2013-11-28 15:57:09 +00:00
{
this._y = value;
2014-02-05 06:29:17 +00:00
if (this._y > (this.layer.heightInPixels - this.height))
2013-11-28 15:57:09 +00:00
{
2014-02-05 06:29:17 +00:00
this._y = this.layer.heightInPixels - this.height;
2013-11-28 15:57:09 +00:00
}
2014-02-05 06:29:17 +00:00
this._startY = this.game.math.floor(this._y / this.map.tileHeight);
2013-11-28 15:57:09 +00:00
if (this._startY &lt; 0)
{
this._startY = 0;
}
if (this._startY + this._maxY > this.layer.height)
{
this._startY = this.layer.height - this._maxY;
}
this.dirty = true;
}
}
2014-02-05 06:29:17 +00:00
});
/**
* @name Phaser.TilemapLayer#collisionWidth
* @property {number} collisionWidth - The width of the collision tiles.
*/
Object.defineProperty(Phaser.TilemapLayer.prototype, "collisionWidth", {
get: function () {
return this._cw;
},
set: function (value) {
this._cw = value;
this.dirty = true;
}
});
/**
* @name Phaser.TilemapLayer#collisionHeight
* @property {number} collisionHeight - The height of the collision tiles.
*/
Object.defineProperty(Phaser.TilemapLayer.prototype, "collisionHeight", {
get: function () {
return this._ch;
},
set: function (value) {
this._ch = value;
this.dirty = true;
}
2013-11-28 15:57:09 +00:00
});
</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-11-28 15:57:09 +00:00
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Fri Feb 21 2014 15:36:22 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-11-28 15:57:09 +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>