Deploying to gh-pages from @ 792fa22 🚀

flixel/graphics/frames/FlxAtlasFrames.html

@@ -12,9 +12,9 @@
 Plus it contains few packer parser methods for most commonly used atlas formats.</p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="findFrame"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#findFrame"><span class="identifier">findFrame</span></a>(<span style="white-space:nowrap">graphic:<a class="type" title="flixel.graphics.FlxGraphic - BitmapData wrapper which is used for rendering." href="../../../flixel/graphics/FlxGraphic.html">FlxGraphic</a>,</span> <span style="white-space:nowrap">?border:<a class="type" title="flixel.math.FlxPoint - 2-dimensional point class Pooling To avoid creating new instances, unnecessarily, used points can be for later use." href="../../../flixel/math/FlxPoint.html">FlxPoint</a></span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Returns the <code>FlxAtlasFrame</code> of the specified <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code> object.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>graphic</code></th><td><p><code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code> object to find the <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection for.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p><code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection for the specified <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code> object
 Could be <code>null</code> if <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code> doesn't have it yet.</p></div></div></div><div class="field "><a name="fromAseprite"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#fromAseprite"><span class="identifier">fromAseprite</span></a>(<span style="white-space:nowrap">source:<a class="type" title="flixel.system.FlxGraphicAsset" href="../../../flixel/system/FlxGraphicAsset.html">FlxGraphicAsset</a>,</span> <span style="white-space:nowrap">description:<a class="type" title="flixel.system.FlxAsepriteJsonAsset" href="../../../flixel/system/FlxAsepriteJsonAsset.html">FlxAsepriteJsonAsset</a></span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Parsing method for atlases generated from Aseprite's JSON export options. Note that Aseprite
 and Texture Packer use the same JSON format, however this method honors frames' <code>duration</code>
-whereas <code>fromTexturePackerJson</code> ignores it by default (for backwrds compatibility reasons).</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>source</code></th><td><p>The image source (can be <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code>, <code><a href="../../../String.html">String</a></code>, or <code><a href="../../../openfl/display/BitmapData.html#BitmapData">BitmapData</a></code>).</p></td></tr><tr><th style="width:25%;"><code>description</code></th><td><p>Contents of JSON file with atlas description.
+whereas <code>fromTexturePackerJson</code> ignores it by default (for backwards compatibility reasons).</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>source</code></th><td><p>The image source (can be <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code>, <code><a href="../../../String.html">String</a></code>, or <code><a href="../../../openfl/display/BitmapData.html#BitmapData">BitmapData</a></code>).</p></td></tr><tr><th style="width:25%;"><code>description</code></th><td><p>Contents of JSON file with atlas description.
 You can get it with <code><a href="../../../flixel/FlxG.html#getText">FlxG.assets.getText</a>(path/to/description.json)</code>.
-Or you can just a pass path to the JSON file in the assets directory.
+Or you can just pass a path to the JSON file in the assets directory.
 You can also directly pass in the parsed object.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Newly created <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection.</p></div><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://www.aseprite.org/docs/sprite-sheet/#texture-atlases">Exporting texture atlases with Aseprite</a></p></div></li></ul></div></div><div class="field "><a name="fromLibGdx"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#fromLibGdx"><span class="identifier">fromLibGdx</span></a>(<span style="white-space:nowrap">source:<a class="type" title="flixel.system.FlxGraphicAsset" href="../../../flixel/system/FlxGraphicAsset.html">FlxGraphicAsset</a>,</span> <span style="white-space:nowrap">description:<a class="type" title="String - The basic String class." href="../../../String.html">String</a></span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Parsing method for LibGDX atlases.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>source</code></th><td><p>The image source (can be <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code>, <code><a href="../../../String.html">String</a></code> or <code><a href="../../../openfl/display/BitmapData.html#BitmapData">BitmapData</a></code>).</p></td></tr><tr><th style="width:25%;"><code>description</code></th><td><p>Contents of the file with atlas description.
 You can get it with <code><a href="../../../flixel/FlxG.html#getText">FlxG.assets.getText</a>(path/to/description/file)</code>.
 Or you can just pass path to the description file in the assets directory.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Newly created <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection.</p></div></div></div><div class="field "><a name="fromSparrow"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#fromSparrow"><span class="identifier">fromSparrow</span></a>(<span style="white-space:nowrap">source:<a class="type" title="flixel.system.FlxGraphicAsset" href="../../../flixel/system/FlxGraphicAsset.html">FlxGraphicAsset</a>,</span> <span style="white-space:nowrap">xml:<a class="type" title="flixel.system.FlxXmlAsset" href="../../../flixel/system/FlxXmlAsset.html">FlxXmlAsset</a></span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Parsing method for Sparrow texture atlases
@@ -23,9 +23,9 @@
 You can get it with <code><a href="../../../flixel/FlxG.html#getText">FlxG.assets.getText</a>(path/to/description/file)</code>.
 Or you can just pass a path to the description file in the assets directory.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Newly created <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection.</p></div></div></div><div class="field "><a name="fromTexturePackerJson"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ useFrameDuration : false })</span><span class="label label-static">static</span><a href="#fromTexturePackerJson"><span class="identifier">fromTexturePackerJson</span></a>(<span style="white-space:nowrap">source:<a class="type" title="flixel.system.FlxGraphicAsset" href="../../../flixel/system/FlxGraphicAsset.html">FlxGraphicAsset</a>,</span> <span style="white-space:nowrap">description:<a class="type" title="flixel.system.FlxTexturePackerJsonAsset" href="../../../flixel/system/FlxTexturePackerJsonAsset.html">FlxTexturePackerJsonAsset</a>,</span> <span style="white-space:nowrap">useFrameDuration:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../../../Bool.html">Bool</a> = false</span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Parsing method for TexturePacker atlases in JSON format.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>source</code></th><td><p>The image source (can be <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code>, <code><a href="../../../String.html">String</a></code>, or <code><a href="../../../openfl/display/BitmapData.html#BitmapData">BitmapData</a></code>).</p></td></tr><tr><th style="width:25%;"><code>description</code></th><td><p>Contents of JSON file with atlas description.
 You can get it with <code><a href="../../../flixel/FlxG.html#getText">FlxG.assets.getText</a>(path/to/description.json)</code>.
-Or you can just a pass path to the JSON file in the assets directory.
+Or you can just pass a path to the JSON file in the assets directory.
 You can also directly pass in the parsed object.</p></td></tr><tr><th style="width:25%;"><code>useFrameDuration</code></th><td><p>If true, any frame durations defined in the JSON will override the
-frameRate set in you <code><a href="../../../flixel/animation/FlxAnimationController.html#FlxAnimationController">FlxAnimationController</a></code>.
+frameRate set in your <code><a href="../../../flixel/animation/FlxAnimationController.html#FlxAnimationController">FlxAnimationController</a></code>.
 Note: You can also use <code>fromAseprite</code> which uses duration.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Newly created <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection.</p></div></div></div><div class="field "><a name="fromTexturePackerXml"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#fromTexturePackerXml"><span class="identifier">fromTexturePackerXml</span></a>(<span style="white-space:nowrap">source:<a class="type" title="flixel.system.FlxGraphicAsset" href="../../../flixel/system/FlxGraphicAsset.html">FlxGraphicAsset</a>,</span> <span style="white-space:nowrap">xml:<a class="type" title="flixel.system.FlxXmlAsset" href="../../../flixel/system/FlxXmlAsset.html">FlxXmlAsset</a></span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Parsing method for TexturePacker atlases in generic XML format.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>source</code></th><td><p>The image source (can be <code><a href="../../../flixel/graphics/FlxGraphic.html#FlxGraphic">FlxGraphic</a></code>, <code><a href="../../../String.html">String</a></code> or <code><a href="../../../openfl/display/BitmapData.html#BitmapData">BitmapData</a></code>).</p></td></tr><tr><th style="width:25%;"><code>xml</code></th><td><p>Contents of the XML file with atlas description.
 Can be a path to the XML asset, an XML string, or an <code><a href="../../../Xml.html">Xml</a></code> object.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Newly created <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> collection.</p></div></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">parent:<a class="type" title="flixel.graphics.FlxGraphic - BitmapData wrapper which is used for rendering." href="../../../flixel/graphics/FlxGraphic.html">FlxGraphic</a>,</span> <span style="white-space:nowrap">?border:<a class="type" title="flixel.math.FlxPoint - 2-dimensional point class Pooling To avoid creating new instances, unnecessarily, used points can be for later use." href="../../../flixel/math/FlxPoint.html">FlxPoint</a></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="addAtlas"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ overwriteHash : false })</span><a href="#addAtlas"><span class="identifier">addAtlas</span></a>(<span style="white-space:nowrap">collection:<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a>,</span> <span style="white-space:nowrap">overwriteHash:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../../../Bool.html">Bool</a> = false</span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Adds all ofthe frames from the specified collection</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>collection</code></th><td><p>The frames to add. Note: calling destroy() on this collection
 after it has been added can cause crashes.</p></td></tr><tr><th style="width:25%;"><code>overwriteHash</code></th><td><p>If true, any new frames with matching names will replace old ones.</p></td></tr></table><div class="javadoc inline-content">Available since <p>5.3.0</p>.</div></div></div><div class="field "><a name="concat"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ overwriteHash : false })</span><a href="#concat"><span class="identifier">concat</span></a>(<span style="white-space:nowrap">collection:<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a>,</span> <span style="white-space:nowrap">overwriteHash:<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="../../../Bool.html">Bool</a> = false</span>):<a class="type" title="flixel.graphics.frames.FlxAtlasFrames - Atlas frames collection." href="../../../flixel/graphics/frames/FlxAtlasFrames.html">FlxAtlasFrames</a></code></h3><div class="doc"><p>Creates a new <code><a href="../../../flixel/graphics/frames/FlxAtlasFrames.html#FlxAtlasFrames">FlxAtlasFrames</a></code> instance with all the frames from this and the desired instance.</p>