Deploying to gh-pages from @ 88f42ca 🚀

flixel/FlxSprite.html

@@ -8,7 +8,7 @@
 	float: none;
 	text-shadow: 0 0 0 transparent;
 }
-</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../">Leather Engine Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> FlxSprite</h1><h4><small>package <a href="../flixel/index.html">flixel</a></small></h4><h4><small>extends <a class="type" title="flixel.FlxObject - At their core FlxObjects are just boxes with positions that can move and collide with other objects." href="../flixel/FlxObject.html">FlxObject</a> &rsaquo; <a class="type" title="flixel.FlxBasic - This is a useful &quot;generic&quot; Flixel object." href="../flixel/FlxBasic.html">FlxBasic</a></small></h4>    <h4><small><span class="muted">extended by </span><a class="type" title="flixel.addons.display.shapes.FlxShape - A convenience class for wrapping vector shape drawing in FlxSprites, all ready to go." href="../flixel/addons/display/shapes/FlxShape.html">FlxShape</a>, <a class="type" title="flixel.addons.display.FlxBackdrop - Used for showing infinitely scrolling backgrounds." href="../flixel/addons/display/FlxBackdrop.html">FlxBackdrop</a>, <a class="type" title="flixel.addons.display.FlxExtendedMouseSprite - An enhanced FlxSprite that is capable of receiving mouse clicks, being dragged and thrown, mouse springs, gravity and other useful things Note: This class will be deprecated soon, It&#039;s quite outdated and unmaintained." href="../flixel/addons/display/FlxExtendedMouseSprite.html">FlxExtendedMouseSprite</a>, <a class="type" title="flixel.addons.display.FlxNestedSprite - Some sort of DisplayObjectContainer but very limited." href="../flixel/addons/display/FlxNestedSprite.html">FlxNestedSprite</a>, <a class="type" title="flixel.addons.display.FlxPieDial - A dynamic shape that fills up the way a pie chart does." href="../flixel/addons/display/FlxPieDial.html">FlxPieDial</a>, <a class="type" title="flixel.addons.display.FlxRadialGauge - A dynamic shape that fills up radially (like a pie chart)." href="../flixel/addons/display/FlxRadialGauge.html">FlxRadialGauge</a>, <a class="type" title="flixel.addons.display.FlxSpriteAniRot - Creating animated and rotated sprite from an un-rotated animated image." href="../flixel/addons/display/FlxSpriteAniRot.html">FlxSpriteAniRot</a>, <a class="type" title="flixel.addons.effects.chainable.FlxEffectSprite - Use this class to chain bitmap effects to your target FlxSprite frame." href="../flixel/addons/effects/chainable/FlxEffectSprite.html">FlxEffectSprite</a>, <a class="type" title="flixel.addons.effects.FlxClothSprite - A FlxSprite that draw it&#039;s frame in a mesh and behave like a cloth." href="../flixel/addons/effects/FlxClothSprite.html">FlxClothSprite</a>, <a class="type" title="flixel.addons.effects.FlxSkewedSprite" href="../flixel/addons/effects/FlxSkewedSprite.html">FlxSkewedSprite</a>, <a class="type" title="flixel.addons.effects.FlxTrailArea - This provides an area in which the added sprites have a trail effect." href="../flixel/addons/effects/FlxTrailArea.html">FlxTrailArea</a>, <a class="type" title="flixel.addons.transition.FlxTransitionSprite" href="../flixel/addons/transition/FlxTransitionSprite.html">FlxTransitionSprite</a>, <a class="type" title="flixel.addons.ui.FlxUIRegion" href="../flixel/addons/ui/FlxUIRegion.html">FlxUIRegion</a>, <a class="type" title="flixel.addons.ui.FlxUISprite" href="../flixel/addons/ui/FlxUISprite.html">FlxUISprite</a>, <a class="type" title="flixel.addons.weapon.FlxBullet - @link http://www." href="../flixel/addons/weapon/FlxBullet.html">FlxBullet</a>, <a class="type" title="flixel.effects.particles.FlxParticle - This is a simple particle class that extends the default behavior of FlxSprite to have slightly more specialized behavior common to many game scenarios." href="../flixel/effects/particles/FlxParticle.html">FlxParticle</a>, <a class="type" title="flixel.group.FlxTypedSpriteGroup - A FlxSpriteGroup that only allows specific members to be a specific type of FlxSprite." href="../flixel/group/FlxTypedSpriteGroup.html">FlxTypedSpriteGroup</a>, <a class="type" title="flixel.system.FlxBGSprite" href="../flixel/system/FlxBGSprite.html">FlxBGSprite</a>, <a class="type" title="flixel.text.FlxBitmapText - Extends FlxSprite to support rendering text." href="../flixel/text/FlxBitmapText.html">FlxBitmapText</a>, <a class="type" title="flixel.text.FlxText - Extends FlxSprite to support rendering text." href="../flixel/text/FlxText.html">FlxText</a>, <a class="type" title="flixel.tile.FlxTileblock - This is a basic &quot;environment object&quot; class, used to create simple walls and floors." href="../flixel/tile/FlxTileblock.html">FlxTileblock</a>, <a class="type" title="flixel.ui.FlxBar - FlxBar is a quick and easy way to create a graphical bar which can be used as part of your UI/HUD, or positioned next to a sprite." href="../flixel/ui/FlxBar.html">FlxBar</a>, <a class="type" title="flixel.ui.FlxTypedButton - A simple button class that calls a function when clicked by the mouse." href="../flixel/ui/FlxTypedButton.html">FlxTypedButton</a>, <a class="type" title="flixel.FlxStrip - A very basic rendering component which uses drawTriangles()." href="../flixel/FlxStrip.html">FlxStrip</a>, <a class="type" title="flxanimate.FlxAnimate" href="../flxanimate/FlxAnimate.html">FlxAnimate</a>, <a class="type" title="game.Character - The base character class." href="../game/Character.html">Character</a>, <a class="type" title="game.ClearPercentNumber" href="../game/ClearPercentNumber.html">ClearPercentNumber</a>, <a class="type" title="game.DancingSprite" href="../game/DancingSprite.html">DancingSprite</a>, <a class="type" title="game.EventSprite" href="../game/EventSprite.html">EventSprite</a>, <a class="type" title="game.NoteSplash" href="../game/NoteSplash.html">NoteSplash</a>, <a class="type" title="game.ScoreNum" href="../game/ScoreNum.html">ScoreNum</a>, <a class="type" title="game.SustainSplash" href="../game/SustainSplash.html">SustainSplash</a>, <a class="type" title="game.TallyNumber" href="../game/TallyNumber.html">TallyNumber</a>, <a class="type" title="hxvlc.flixel.FlxVideoSprite - This class extends FlxSprite to display video files in HaxeFlixel." href="../hxvlc/flixel/FlxVideoSprite.html">FlxVideoSprite</a>, <a class="type" title="modcharting.ModchartEditorEvent" href="../modcharting/ModchartEditorEvent.html">ModchartEditorEvent</a>, <a class="type" title="modcharting.PlayfieldRenderer" href="../modcharting/PlayfieldRenderer.html">PlayfieldRenderer</a>, <a class="type" title="ui.AlphaCharacter" href="../ui/AlphaCharacter.html">AlphaCharacter</a>, <a class="type" title="ui.Checkbox" href="../ui/Checkbox.html">Checkbox</a>, <a class="type" title="ui.DialoguePortrait" href="../ui/DialoguePortrait.html">DialoguePortrait</a>, <a class="type" title="ui.MenuCharacter" href="../ui/MenuCharacter.html">MenuCharacter</a>, <a class="type" title="ui.TrackerSprite - An FlxSprite that tracks another sprite&#039;s position and scale to appear next to it." href="../ui/TrackerSprite.html">TrackerSprite</a></small></h4><span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.macros.UsingHandler.build())</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.macros.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p>The core building blocks of all Flixel games. With helpful tools for animation, movement and
+</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../">Leather Engine Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> FlxSprite</h1><h4><small>package <a href="../flixel/index.html">flixel</a></small></h4><h4><small>extends <a class="type" title="flixel.FlxObject - At their core FlxObjects are just boxes with positions that can move and collide with other objects." href="../flixel/FlxObject.html">FlxObject</a> &rsaquo; <a class="type" title="flixel.FlxBasic - This is a useful &quot;generic&quot; Flixel object." href="../flixel/FlxBasic.html">FlxBasic</a></small></h4>    <h4><small><span class="muted">extended by </span><a class="type" title="flixel.addons.display.shapes.FlxShape - A convenience class for wrapping vector shape drawing in FlxSprites, all ready to go." href="../flixel/addons/display/shapes/FlxShape.html">FlxShape</a>, <a class="type" title="flixel.addons.display.FlxBackdrop - Used for showing infinitely scrolling backgrounds." href="../flixel/addons/display/FlxBackdrop.html">FlxBackdrop</a>, <a class="type" title="flixel.addons.display.FlxExtendedMouseSprite - An enhanced FlxSprite that is capable of receiving mouse clicks, being dragged and thrown, mouse springs, gravity and other useful things Note: This class will be deprecated soon, It&#039;s quite outdated and unmaintained." href="../flixel/addons/display/FlxExtendedMouseSprite.html">FlxExtendedMouseSprite</a>, <a class="type" title="flixel.addons.display.FlxNestedSprite - Some sort of DisplayObjectContainer but very limited." href="../flixel/addons/display/FlxNestedSprite.html">FlxNestedSprite</a>, <a class="type" title="flixel.addons.display.FlxPieDial - A dynamic shape that fills up the way a pie chart does." href="../flixel/addons/display/FlxPieDial.html">FlxPieDial</a>, <a class="type" title="flixel.addons.display.FlxRadialGauge - A dynamic shape that fills up radially (like a pie chart)." href="../flixel/addons/display/FlxRadialGauge.html">FlxRadialGauge</a>, <a class="type" title="flixel.addons.display.FlxSpriteAniRot - Creating animated and rotated sprite from an un-rotated animated image." href="../flixel/addons/display/FlxSpriteAniRot.html">FlxSpriteAniRot</a>, <a class="type" title="flixel.addons.effects.chainable.FlxEffectSprite - Use this class to chain bitmap effects to your target FlxSprite frame." href="../flixel/addons/effects/chainable/FlxEffectSprite.html">FlxEffectSprite</a>, <a class="type" title="flixel.addons.effects.FlxClothSprite - A FlxSprite that draw it&#039;s frame in a mesh and behave like a cloth." href="../flixel/addons/effects/FlxClothSprite.html">FlxClothSprite</a>, <a class="type" title="flixel.addons.effects.FlxSkewedSprite" href="../flixel/addons/effects/FlxSkewedSprite.html">FlxSkewedSprite</a>, <a class="type" title="flixel.addons.effects.FlxTrailArea - This provides an area in which the added sprites have a trail effect." href="../flixel/addons/effects/FlxTrailArea.html">FlxTrailArea</a>, <a class="type" title="flixel.addons.transition.FlxTransitionSprite" href="../flixel/addons/transition/FlxTransitionSprite.html">FlxTransitionSprite</a>, <a class="type" title="flixel.addons.ui.FlxUIRegion" href="../flixel/addons/ui/FlxUIRegion.html">FlxUIRegion</a>, <a class="type" title="flixel.addons.ui.FlxUISprite" href="../flixel/addons/ui/FlxUISprite.html">FlxUISprite</a>, <a class="type" title="flixel.addons.weapon.FlxBullet - @link http://www." href="../flixel/addons/weapon/FlxBullet.html">FlxBullet</a>, <a class="type" title="flixel.effects.particles.FlxParticle - This is a simple particle class that extends the default behavior of FlxSprite to have slightly more specialized behavior common to many game scenarios." href="../flixel/effects/particles/FlxParticle.html">FlxParticle</a>, <a class="type" title="flixel.group.FlxTypedSpriteGroup - A FlxSpriteGroup that only allows specific members to be a specific type of FlxSprite." href="../flixel/group/FlxTypedSpriteGroup.html">FlxTypedSpriteGroup</a>, <a class="type" title="flixel.system.FlxBGSprite" href="../flixel/system/FlxBGSprite.html">FlxBGSprite</a>, <a class="type" title="flixel.text.FlxBitmapText - Extends FlxSprite to support rendering text." href="../flixel/text/FlxBitmapText.html">FlxBitmapText</a>, <a class="type" title="flixel.text.FlxText - Extends FlxSprite to support rendering text." href="../flixel/text/FlxText.html">FlxText</a>, <a class="type" title="flixel.tile.FlxTileblock - This is a basic &quot;environment object&quot; class, used to create simple walls and floors." href="../flixel/tile/FlxTileblock.html">FlxTileblock</a>, <a class="type" title="flixel.ui.FlxBar - FlxBar is a quick and easy way to create a graphical bar which can be used as part of your UI/HUD, or positioned next to a sprite." href="../flixel/ui/FlxBar.html">FlxBar</a>, <a class="type" title="flixel.ui.FlxTypedButton - A simple button class that calls a function when clicked by the mouse." href="../flixel/ui/FlxTypedButton.html">FlxTypedButton</a>, <a class="type" title="flixel.FlxStrip - A very basic rendering component which uses drawTriangles()." href="../flixel/FlxStrip.html">FlxStrip</a>, <a class="type" title="flxanimate.FlxAnimate" href="../flxanimate/FlxAnimate.html">FlxAnimate</a>, <a class="type" title="game.Character - The base character class." href="../game/Character.html">Character</a>, <a class="type" title="game.ClearPercentNumber" href="../game/ClearPercentNumber.html">ClearPercentNumber</a>, <a class="type" title="game.DancingSprite" href="../game/DancingSprite.html">DancingSprite</a>, <a class="type" title="game.EventSprite" href="../game/EventSprite.html">EventSprite</a>, <a class="type" title="game.NoteSplash" href="../game/NoteSplash.html">NoteSplash</a>, <a class="type" title="game.ScoreNum" href="../game/ScoreNum.html">ScoreNum</a>, <a class="type" title="game.TallyNumber" href="../game/TallyNumber.html">TallyNumber</a>, <a class="type" title="hxvlc.flixel.FlxVideoSprite - This class extends FlxSprite to display video files in HaxeFlixel." href="../hxvlc/flixel/FlxVideoSprite.html">FlxVideoSprite</a>, <a class="type" title="modcharting.ModchartEditorEvent" href="../modcharting/ModchartEditorEvent.html">ModchartEditorEvent</a>, <a class="type" title="modcharting.PlayfieldRenderer" href="../modcharting/PlayfieldRenderer.html">PlayfieldRenderer</a>, <a class="type" title="ui.AlphaCharacter" href="../ui/AlphaCharacter.html">AlphaCharacter</a>, <a class="type" title="ui.Checkbox" href="../ui/Checkbox.html">Checkbox</a>, <a class="type" title="ui.DialoguePortrait" href="../ui/DialoguePortrait.html">DialoguePortrait</a>, <a class="type" title="ui.MenuCharacter" href="../ui/MenuCharacter.html">MenuCharacter</a>, <a class="type" title="ui.TrackerSprite - An FlxSprite that tracks another sprite&#039;s position and scale to appear next to it." href="../ui/TrackerSprite.html">TrackerSprite</a></small></h4><span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.macros.UsingHandler.build())</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.macros.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p>The core building blocks of all Flixel games. With helpful tools for animation, movement and
 features for the needs of most games.</p>
 <p>It is pretty common place to extend <code><a href="../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code> for your own game's needs; for example a <code>SpaceShip</code>
 class may extend <code><a href="../flixel/FlxSprite.html#FlxSprite">FlxSprite</a></code> but could have additional variables for the game like <code>shieldStrength</code>