2013-11-28 15:57:09 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Tileset< / 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 >
< 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 >
2014-02-18 03:01:51 +00:00
< 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 >
2014-02-21 15:37:26 +00:00
< 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 >
2014-02-08 07:24:22 +00:00
< 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 >
2014-02-21 15:37:26 +00:00
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.html" > P2< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / 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 >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2013-11-28 15:57:09 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
< li >
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2013-11-28 15:57:09 +00:00
< 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 >
2014-02-18 03:01:51 +00:00
< 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.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 >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Tileset< / h1 >
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
Tileset
< / h2 >
< div class = "class-description" > < p > Phaser.Tileset< / p > < / div >
< / header >
< article >
< div class = "container-overview" >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "Tileset" > < span class = "type-signature" > < / span > new Tileset< span class = "signature" > (name, firstgid, width, height, margin, spacing, properties)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-05 06:29:17 +00:00
< p > 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.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > name< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > string< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The name of the tileset in the map data.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > firstgid< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > width< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Width of each tile in pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > height< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Height of each tile in pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > margin< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The amount of margin around the tilesheet.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > spacing< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The amount of spacing between each tile in the sheet.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< tr >
< td class = "name" > < code > properties< / code > < / td >
< td class = "type" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< span class = "param-type" > object< / span >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Tileset properties.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-21" > line 21< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "columns" > < span class = "type-signature" > < / span > columns< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > columns< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The number of columns in the tile sheet.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-71" > line 71< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "firstgid" > < span class = "type-signature" > < / span > firstgid< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > firstgid< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The Tiled firstgid value. In non-Tiled data this should be considered the starting index value of the first tile in this set.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-31" > line 31< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "image" > < span class = "type-signature" > < / span > image< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > image< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > object< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The image used for rendering. This is a reference to the image stored in Phaser.Cache.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-61" > line 61< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "name" > < span class = "type-signature" > < / span > name< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > name< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > string< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The name of the Tileset.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-26" > line 26< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "properties" > < span class = "type-signature" > < / span > properties< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > properties< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > object< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Tileset specific properties (typically defined in the Tiled editor).< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-56" > line 56< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "rows" > < span class = "type-signature" > < / span > rows< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > rows< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The number of rows in the tile sheet.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-66" > line 66< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "tileHeight" > < span class = "type-signature" > < / span > tileHeight< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tileHeight< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The height of a tile in pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-41" > line 41< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "tileMargin" > < span class = "type-signature" > < / span > tileMargin< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tileMargin< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The margin around the tiles in the tileset.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-46" > line 46< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "tileSpacing" > < span class = "type-signature" > < / span > tileSpacing< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tileSpacing< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The spacing in pixels between each tile in the tileset.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
2014-02-05 06:29:17 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-51" > line 51< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "tileWidth" > < span class = "type-signature" > < / span > tileWidth< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tileWidth< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The width of a tile in pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
2014-02-05 06:29:17 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-36" > line 36< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-05 06:29:17 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< dt >
< h4 class = "name" id = "total" > < span class = "type-signature" > < / span > total< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< dl >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > total< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The total number of tiles in the tilesheet.< / p > < / td >
< / tr >
< / tbody >
< / table >
2013-11-28 15:57:09 +00:00
< / dl >
2014-02-05 06:29:17 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-76" > line 76< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-11-28 15:57:09 +00:00
< / dd >
2014-02-05 06:29:17 +00:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
2013-11-28 15:57:09 +00:00
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "draw" > < span class = "type-signature" > < / span > draw< span class = "signature" > (context, x, y, index)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-14 06:36:05 +00:00
< p > Draws a tile from this Tileset at the given coordinates on the context.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > context< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > HTMLCanvasContext< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The context to draw the tile onto.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > x< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The x coordinate to draw to.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-03-14 06:36:05 +00:00
< tr >
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > y< / code > < / td >
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The y coordinate to draw to.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > index< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The index of the tile within the set to draw.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
2014-02-08 07:24:22 +00:00
< / tbody >
< / table >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-88" > line 88< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "setImage" > < span class = "type-signature" > < / span > setImage< span class = "signature" > (image)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-14 06:36:05 +00:00
< p > Adds a reference from this Tileset to an Image stored in the Phaser.Cache.< / p >
2014-02-08 07:24:22 +00:00
< / div >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< h5 > Parameters:< / h5 >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th > Type< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< tbody >
2013-11-28 15:57:09 +00:00
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > image< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > Image< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The image this tileset will use to draw with.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-118" > line 118< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "setSpacing" > < span class = "type-signature" > < / span > setSpacing< span class = "signature" > (< span class = "optional" > tileMargin< / span > , < span class = "optional" > tileSpacing< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > Sets tile spacing and margins.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-05 06:29:17 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tileMargin< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The margin around the tiles in the sheet.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tileSpacing< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The spacing between the tiles in the sheet.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tileset.js.html" > tilemap/Tileset.js< / a > , < a href = "Tileset.js.html#sunlight-1-line-154" > line 154< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / 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 >
2014-03-14 06:36:05 +00:00
on Fri Mar 14 2014 06:34:36 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 >
< div class = "span3" >
< div id = "toc" > < / div >
< / 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( {
2014-03-14 06:36:05 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-11-28 15:57:09 +00:00
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 >
