2013-10-01 15:15:45 +00:00
<!DOCTYPE html>
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< html lang = "en" >
< head >
2013-10-02 00:16:40 +00:00
< meta charset = "utf-8" >
< title > Phaser Class: Parser< / 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" >
2013-10-01 15:15:45 +00:00
< / head >
< body >
2013-10-02 00:16:40 +00:00
< 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 = "modules.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Modules< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "module-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.Animation.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.Animation.FrameData.html" > FrameData< / a >
< / li >
< li >
< a href = "Phaser.Animation.Parser.html" > Parser< / a >
< / li >
< li >
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
2013-10-02 00:16:40 +00:00
< li >
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Device.html" > Device< / a >
< / li >
2013-10-02 00:16:40 +00:00
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2013-10-02 14:05:55 +00:00
< 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 >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
< a href = "Phaser.Loader.Parser.html" > Parser< / 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 >
2013-10-02 11:11:22 +00:00
< / li >
2013-10-02 19:18:24 +00:00
< 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 >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.StageScaleMode.html" > StageScaleMode< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2013-10-02 11:11:22 +00:00
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
2013-10-02 00:16:40 +00:00
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
< div class = "span8" >
< div id = "main" >
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
< h1 class = "page-title" > Class: Parser< / h1 >
2013-10-01 15:15:45 +00:00
< section >
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< header >
< h2 >
2013-10-02 00:16:40 +00:00
< span class = "ancestors" > < a href = "Phaser.Animation.html" > .Animation< / a > .< / span >
2013-10-01 15:15:45 +00:00
Parser
< / h2 >
2013-10-02 00:16:40 +00:00
< / header >
2013-10-01 15:15:45 +00:00
< article >
< div class = "container-overview" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< dt >
< h4 class = "name" id = "Parser" > < span class = "type-signature" > < / span > new Parser< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-10-02 00:16:40 +00:00
< p > Responsible for parsing sprite sheet and JSON data into the internal FrameData format that Phaser uses for animations.< / p >
2013-10-01 15:15:45 +00:00
< / div >
< dl class = "details" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 00:16:40 +00:00
< a href = "Parser.js.html" > animation/Parser.js< / a > , < a href = "Parser.js.html#sunlight-1-line-3" > line 3< / a >
2013-10-01 15:15:45 +00:00
< / li > < / ul > < / dd >
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< / dl >
< / dd >
< / div >
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-01 15:39:39 +00:00
< h3 class = "subsection-title" > Methods< / h3 >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dl >
< dt >
< h4 class = "name" id = "JSONData" > < span class = "type-signature" > < static> < / span > JSONData< span class = "signature" > (game, json, cacheKey)< / span > < span class = "type-signature" > → {< a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-10-02 00:16:40 +00:00
< p > Parse the JSON data and extract the animation frame data from it.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< h5 > Parameters:< / h5 >
2013-10-02 00:16:40 +00:00
< table class = "params table table-striped" >
2013-10-01 15:39:39 +00:00
< thead >
< tr >
< th > Name< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th > Type< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tbody >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > game< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > json< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The JSON data from the Texture Atlas. Must be in Array format.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > cacheKey< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The Game.Cache asset key of the texture image.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / tbody >
< / table >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dl class = "details" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 00:16:40 +00:00
< a href = "Parser.js.html" > animation/Parser.js< / a > , < a href = "Parser.js.html#sunlight-1-line-95" > line 95< / a >
2013-10-01 15:39:39 +00:00
< / li > < / ul > < / dd >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2013-10-02 00:16:40 +00:00
< p > A FrameData object containing the parsed frames.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dd >
< dt >
< h4 class = "name" id = "JSONDataHash" > < span class = "type-signature" > < static> < / span > JSONDataHash< span class = "signature" > (game, json, cacheKey)< / span > < span class = "type-signature" > → {< a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-10-02 00:16:40 +00:00
< p > Parse the JSON data and extract the animation frame data from it.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< h5 > Parameters:< / h5 >
2013-10-02 00:16:40 +00:00
< table class = "params table table-striped" >
2013-10-01 15:39:39 +00:00
< thead >
< tr >
< th > Name< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th > Type< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tbody >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > game< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > json< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The JSON data from the Texture Atlas. Must be in JSON Hash format.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > cacheKey< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The Game.Cache asset key of the texture image.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / tbody >
< / table >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dl class = "details" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 00:16:40 +00:00
< a href = "Parser.js.html" > animation/Parser.js< / a > , < a href = "Parser.js.html#sunlight-1-line-166" > line 166< / a >
2013-10-01 15:39:39 +00:00
< / li > < / ul > < / dd >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2013-10-02 00:16:40 +00:00
< p > A FrameData object containing the parsed frames.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dd >
< dt >
< h4 class = "name" id = "spriteSheet" > < span class = "type-signature" > < static> < / span > spriteSheet< span class = "signature" > (game, key, frameWidth, frameHeight, < span class = "optional" > frameMax< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-10-02 00:16:40 +00:00
< p > Parse a Sprite Sheet and extract the animation frame data from it.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< h5 > Parameters:< / h5 >
2013-10-02 00:16:40 +00:00
< table class = "params table table-striped" >
2013-10-01 15:39:39 +00:00
< thead >
< tr >
< th > Name< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th > Type< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th > Argument< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th > Default< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tbody >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > game< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "attributes" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "default" >
< / td >
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > key< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "attributes" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "default" >
< / td >
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The Game.Cache asset key of the Sprite Sheet image.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > frameWidth< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "attributes" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "default" >
< / td >
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The fixed width of each frame of the animation.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > frameHeight< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "attributes" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "default" >
< / td >
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The fixed height of each frame of the animation.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > frameMax< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "default" >
-1
< / td >
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The total number of animation frames to extact from the Sprite Sheet. The default value of -1 means " extract all frames" .< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / tbody >
< / table >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dl class = "details" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 00:16:40 +00:00
< a href = "Parser.js.html" > animation/Parser.js< / a > , < a href = "Parser.js.html#sunlight-1-line-14" > line 14< / a >
2013-10-01 15:39:39 +00:00
< / li > < / ul > < / dd >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2013-10-02 00:16:40 +00:00
< p > A FrameData object containing the parsed frames.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dd >
< dt >
< h4 class = "name" id = "XMLData" > < span class = "type-signature" > < static> < / span > XMLData< span class = "signature" > (game, xml, cacheKey)< / span > < span class = "type-signature" > → {< a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-10-02 00:16:40 +00:00
< p > Parse the XML data and extract the animation frame data from it.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< h5 > Parameters:< / h5 >
2013-10-02 00:16:40 +00:00
< table class = "params table table-striped" >
2013-10-01 15:39:39 +00:00
< thead >
< tr >
< th > Name< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th > Type< / th >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tbody >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > game< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > xml< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The XML data from the Texture Atlas. Must be in Starling XML format.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< tr >
< td class = "name" > < code > cacheKey< / code > < / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
< td class = "description last" > < p > The Game.Cache asset key of the texture image.< / p > < / td >
2013-10-01 15:39:39 +00:00
< / tr >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / tbody >
< / table >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dl class = "details" >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 00:16:40 +00:00
< a href = "Parser.js.html" > animation/Parser.js< / a > , < a href = "Parser.js.html#sunlight-1-line-240" > line 240< / a >
2013-10-01 15:39:39 +00:00
< / li > < / ul > < / dd >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2013-10-02 00:16:40 +00:00
< p > A FrameData object containing the parsed frames.< / p >
2013-10-01 15:39:39 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
2013-10-02 00:16:40 +00:00
2013-10-01 15:39:39 +00:00
< / dd >
< / dl >
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< / article >
2013-10-02 00:16:40 +00:00
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
Phaser Copyright © 2012-2013 Photon Storm Ltd.
< / span >
< br / >
< span class = "jsdoc-message" >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.2.0-dev< / a >
2013-10-03 00:21:08 +00:00
on Thu Oct 03 2013 01:18:42 GMT+0100 (BST) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-02 00:16:40 +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( {
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 >
2013-10-01 15:15:45 +00:00
2013-10-02 00:16:40 +00:00
2013-10-01 15:15:45 +00:00
< / body >
< / html >
