2013-10-01 15:15:45 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: Parser< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Class: Parser< / h1 >
< section >
< header >
< h2 >
Parser
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< 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" >
Responsible for parsing sprite sheet and JSON data into the internal FrameData format that Phaser uses for animations.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
animation/Parser.js, line 3
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
2013-10-01 15:39:39 +00:00
< h3 class = "subsection-title" > Methods< / h3 >
< 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" >
Parse the JSON data and extract the animation frame data from it.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > A reference to the currently running game.< / td >
< / tr >
< tr >
< td class = "name" > < code > json< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > The JSON data from the Texture Atlas. Must be in Array format.< / td >
< / tr >
< tr >
< td class = "name" > < code > cacheKey< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > The Game.Cache asset key of the texture image.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
animation/Parser.js, line 97
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
A FrameData object containing the parsed frames.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
< / 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" >
Parse the JSON data and extract the animation frame data from it.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > A reference to the currently running game.< / td >
< / tr >
< tr >
< td class = "name" > < code > json< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > The JSON data from the Texture Atlas. Must be in JSON Hash format.< / td >
< / tr >
< tr >
< td class = "name" > < code > cacheKey< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > The Game.Cache asset key of the texture image.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
animation/Parser.js, line 169
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
A FrameData object containing the parsed frames.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
< / 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" >
Parse a Sprite Sheet and extract the animation frame data from it.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > A reference to the currently running game.< / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > The Game.Cache asset key of the Sprite Sheet image.< / td >
< / tr >
< tr >
< td class = "name" > < code > frameWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > The fixed width of each frame of the animation.< / td >
< / tr >
< tr >
< td class = "name" > < code > frameHeight< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > The fixed height of each frame of the animation.< / td >
< / tr >
< tr >
< td class = "name" > < code > frameMax< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
-1
< / td >
< td class = "description last" > The total number of animation frames to extact from the Sprite Sheet. The default value of -1 means "extract all frames".< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
animation/Parser.js, line 15
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
A FrameData object containing the parsed frames.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
< / 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" >
Parse the XML data and extract the animation frame data from it.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > A reference to the currently running game.< / td >
< / tr >
< tr >
< td class = "name" > < code > xml< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > The XML data from the Texture Atlas. Must be in Starling XML format.< / td >
< / tr >
< tr >
< td class = "name" > < code > cacheKey< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > The Game.Cache asset key of the texture image.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
animation/Parser.js, line 244
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
A FrameData object containing the parsed frames.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Animation.FrameData.html" > Phaser.Animation.FrameData< / a > < / span >
< / dd >
< / dl >
< / dd >
< / dl >
2013-10-01 15:15:45 +00:00
< / article >
< / section >
< / div >
< nav >
2013-10-01 15:56:47 +00:00
< h2 > < a href = "index.html" > Index< / a > < / h2 > < h3 > Modules< / h3 > < ul > < li > < a href = "module-Phaser.html" > Phaser< / a > < / li > < li > < a href = "Animation.html" > Animation< / a > < / li > < li > < a href = "Camera.html" > Camera< / a > < / li > < li > < a href = "Game.html" > Game< / a > < / li > < / ul > < h3 > Classes< / h3 > < ul > < 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 > < li > < a href = "Phaser.Group.html" > Group< / a > < / li > < li > < a href = "Animation-Phaser.Animation.html" > Animation< / a > < / li > < li > < a href = "Camera-Phaser.Camera.html" > Camera< / a > < / li > < li > < a href = "Game-Phaser.Game.html" > Game< / a > < / li > < / ul > < h3 > Namespaces< / h3 > < ul > < li > < a href = "Phaser.html" > Phaser< / a > < / li > < / ul >
2013-10-01 15:15:45 +00:00
< / nav >
< br clear = "both" >
< footer >
2013-10-01 15:56:47 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.2.0-dev< / a > on Tue Oct 01 2013 16:44:22 GMT+0100 (BST)
2013-10-01 15:15:45 +00:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
