Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-12 22:33:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Tileset.js.html

670 lines
14 KiB
HTML
Raw Normal View History

Updated documentation.
2013-11-28 15:57:09 +00:00
<!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>
<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.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>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.DOMSprite.html">DOMSprite</a>
</li>
Updated documentation.
2013-11-28 15:57:09 +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>
<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.GameObjectFactory.html">GameObjectFactory</a>
</li>
Updated doc files.
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>
Updated documentation.
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>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<li>
<a href="Phaser.Image.html">Image</a>
</li>
Updated documentation.
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>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.Line.html">Line</a>
</li>
Updated documentation.
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.Arcade.Body.html">Body</a>
</li>
<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.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>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
Updated documentation.
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.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>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
Updated documentation.
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>
Tilemap had the wrong @method signatures so most were missing from the docs.
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>
Updated documentation.
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/Tileset.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
Updated doc files.
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
Updated documentation.
2013-11-28 15:57:09 +00:00
* @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.
Updated doc files.
2014-02-05 06:29:17 +00:00
* You should not normally instantiate this class directly.
Updated documentation.
2013-11-28 15:57:09 +00:00
*
* @class Phaser.Tileset
* @constructor
Updated doc files.
2014-02-05 06:29:17 +00:00
* @param {string} name - The name of the tileset in the map data.
* @param {number} firstgid - The Tiled firstgid value.
* @param {number} width - Width of each tile in pixels.
* @param {number} height - Height of each tile in pixels.
* @param {number} margin - The amount of margin around the tilesheet.
* @param {number} spacing - The amount of spacing between each tile in the sheet.
* @param {object} properties - Tileset properties.
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser.Tileset = function (name, firstgid, width, height, margin, spacing, properties) {
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* @property {string} name - The name of the Tileset.
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.name = name;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* @property {number} firstgid - The Tiled firstgid value.
* @default
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.firstgid = firstgid;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* @property {number} tileWidth - The width of a tile in pixels.
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.tileWidth = width;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* @property {number} tileHeight - The height of a tile in pixels.
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.tileHeight = height;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* @property {number} tileMargin - The margin around the tiles in the sheet.
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.tileMargin = margin;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* @property {number} tileSpacing - The margin around the tiles in the sheet.
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.tileSpacing = spacing;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* @property {object} properties - Tileset specific properties (typically defined in the Tiled editor).
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.properties = properties;
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
/**
* @property {object} tilePproperties - Tile specific properties (typically defined in the Tiled editor).
*/
// this.tileProperties = {};
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
/**
* @property {object} image - The image used for rendering. This is a reference to the image stored in Phaser.Cache.
*/
this.image = null;
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* @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.
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
this.columns = 0;
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
/**
* @property {number} total - The total number of tiles in the tilesheet.
*/
this.total = 0;
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
};
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser.Tileset.prototype = {
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* Gets a Tile from this set.
*
* @method Phaser.Tileset#getTile
* @param {number} index - The index of the tile within the set.
Updated doc files.
2014-02-05 06:29:17 +00:00
* @return {object} The tile object.
Updated documentation.
2013-11-28 15:57:09 +00:00
getTile: function (index) {
Updated doc files.
2014-02-05 06:29:17 +00:00
return this.tiles[index];
Updated documentation.
2013-11-28 15:57:09 +00:00
},
*/
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* Gets a Tile from this set.
Updated documentation.
2013-11-28 15:57:09 +00:00
*
Updated doc files.
2014-02-05 06:29:17 +00:00
* @method Phaser.Tileset#getTileX
Updated documentation.
2013-11-28 15:57:09 +00:00
* @param {number} index - The index of the tile within the set.
Updated doc files.
2014-02-05 06:29:17 +00:00
* @return {object} The tile object.
getTileX: function (index) {
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
return this.tiles[index][0];
Updated documentation.
2013-11-28 15:57:09 +00:00
},
Updated doc files.
2014-02-05 06:29:17 +00:00
*/
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* Gets a Tile from this set.
Updated documentation.
2013-11-28 15:57:09 +00:00
*
Updated doc files.
2014-02-05 06:29:17 +00:00
* @method Phaser.Tileset#getTileY
Updated documentation.
2013-11-28 15:57:09 +00:00
* @param {number} index - The index of the tile within the set.
Updated doc files.
2014-02-05 06:29:17 +00:00
* @return {object} The tile object.
getTileY: function (index) {
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
return this.tiles[index][1];
Updated documentation.
2013-11-28 15:57:09 +00:00
},
Updated doc files.
2014-02-05 06:29:17 +00:00
*/
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* Sets tile spacing and margins.
Updated documentation.
2013-11-28 15:57:09 +00:00
*
Updated doc files.
2014-02-05 06:29:17 +00:00
* @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.
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Updated doc files.
2014-02-05 06:29:17 +00:00
setSpacing: function (margin, spacing) {
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
this.tileMargin = margin;
this.tileSpacing = spacing;
Updated documentation.
2013-11-28 15:57:09 +00:00
},
/**
Updated doc files.
2014-02-05 06:29:17 +00:00
* Checks if the tile at the given index exists.
Updated documentation.
2013-11-28 15:57:09 +00:00
*
Updated doc files.
2014-02-05 06:29:17 +00:00
* @method Phaser.Tileset#checkTileIndex
Updated documentation.
2013-11-28 15:57:09 +00:00
* @param {number} index - The index of the tile within the set.
Updated doc files.
2014-02-05 06:29:17 +00:00
* @return {boolean} True if a tile exists at the given index otherwise false.
checkTileIndex: function (index) {
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
return (this.tiles[index]);
Updated documentation.
2013-11-28 15:57:09 +00:00
}
Updated doc files.
2014-02-05 06:29:17 +00:00
*/
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
};
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser.Tileset.prototype.constructor = Phaser.Tileset;
Updated documentation.
2013-11-28 15:57:09 +00:00
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Updated documentation.
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>
Tilemap had the wrong @method signatures so most were missing from the docs.
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>.
Updated documentation.
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>
Reference in a new issue Copy permalink