/docs/Tileset.js.html
HTML | 759 lines | 566 code | 190 blank | 3 comment | 0 complexity | e5006a27fa9132a2e17721b716c84da1 MD5 | raw file
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Phaser Source: tilemap/Tileset.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.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: tilemap/Tileset.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 Tile set is a combination of an image containing the tiles and collision data per tile.
- * You should not normally instantiate this class directly.
- *
- * @class Phaser.Tileset
- * @constructor
- * @param {string} name - The name of the tileset in the map data.
- * @param {number} firstgid - The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.
- * @param {number} [width=32] - Width of each tile in pixels.
- * @param {number} [height=32] - Height of each tile in pixels.
- * @param {number} [margin=0] - The amount of margin around the tilesheet.
- * @param {number} [spacing=0] - The amount of spacing between each tile in the sheet.
- * @param {object} [properties] - Tileset properties.
- */
- Phaser.Tileset = function (name, firstgid, width, height, margin, spacing, properties) {
- if (typeof width === 'undefined' || width <= 0) { width = 32; }
- if (typeof height === 'undefined' || height <= 0) { height = 32; }
- if (typeof margin === 'undefined') { margin = 0; }
- if (typeof spacing === 'undefined') { spacing = 0; }
- /**
- * @property {string} name - The name of the Tileset.
- */
- this.name = name;
- /**
- * @property {number} firstgid - The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.
- */
- this.firstgid = firstgid;
- /**
- * @property {number} tileWidth - The width of a tile in pixels.
- */
- this.tileWidth = width;
- /**
- * @property {number} tileHeight - The height of a tile in pixels.
- */
- this.tileHeight = height;
- /**
- * @property {number} tileMargin - The margin around the tiles in the tileset.
- */
- this.tileMargin = margin;
- /**
- * @property {number} tileSpacing - The spacing in pixels between each tile in the tileset.
- */
- this.tileSpacing = spacing;
- /**
- * @property {object} properties - Tileset specific properties (typically defined in the Tiled editor).
- */
- this.properties = properties;
- /**
- * @property {object} image - The image used for rendering. This is a reference to the image stored in Phaser.Cache.
- */
- this.image = null;
- /**
- * @property {number} rows - The number of rows in the tile sheet.
- */
- this.rows = 0;
- /**
- * @property {number} columns - The number of columns in the tile sheet.
- */
- this.columns = 0;
- /**
- * @property {number} total - The total number of tiles in the tilesheet.
- */
- this.total = 0;
- /**
- * @property {array} draw - The tile drawImage look-up table
- * @private
- */
- this.drawCoords = [];
- };
- Phaser.Tileset.prototype = {
- /**
- * Draws a tile from this Tileset at the given coordinates on the context.
- *
- * @method Phaser.Tileset#draw
- * @param {HTMLCanvasContext} context - The context to draw the tile onto.
- * @param {number} x - The x coordinate to draw to.
- * @param {number} y - The y coordinate to draw to.
- * @param {number} index - The index of the tile within the set to draw.
- */
- draw: function (context, x, y, index) {
- if (!this.image || !this.drawCoords[index])
- {
- return;
- }
- context.drawImage(
- this.image,
- this.drawCoords[index][0],
- this.drawCoords[index][1],
- this.tileWidth,
- this.tileHeight,
- x,
- y,
- this.tileWidth,
- this.tileHeight
- );
- },
- /**
- * Adds a reference from this Tileset to an Image stored in the Phaser.Cache.
- *
- * @method Phaser.Tileset#setImage
- * @param {Image} image - The image this tileset will use to draw with.
- */
- setImage: function (image) {
- this.image = image;
- this.rows = Math.round((image.height - this.tileMargin) / (this.tileHeight + this.tileSpacing));
- this.columns = Math.round((image.width - this.tileMargin) / (this.tileWidth + this.tileSpacing));
- this.total = this.rows * this.columns;
- // Create the index look-up
- this.drawCoords.length = 0;
- var tx = this.tileMargin;
- var ty = this.tileMargin;
- var i = this.firstgid;
- for (var y = 0; y < this.rows; y++)
- {
- for (var x = 0; x < this.columns; x++)
- {
- this.drawCoords[i] = [ tx, ty ];
- tx += this.tileWidth + this.tileSpacing;
- i++;
- }
- tx = this.tileMargin;
- ty += this.tileHeight + this.tileSpacing;
- }
- },
- /**
- * Sets tile spacing and margins.
- *
- * @method Phaser.Tileset#setSpacing
- * @param {number} [tileMargin] - The margin around the tiles in the sheet.
- * @param {number} [tileSpacing] - The spacing between the tiles in the sheet.
- */
- setSpacing: function (margin, spacing) {
- this.tileMargin = margin;
- this.tileSpacing = spacing;
- this.setImage(this.image);
- }
- };
- Phaser.Tileset.prototype.constructor = Phaser.Tileset;
- </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 Fri Apr 11 2014 13:25:03 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>