Internal tracker for opacity, used with Flash getter/setter.

Internal, stores all the animations that were added to this sprite.

Internal tracker for how many frames of "baked" rotation there are (if any).

Internal tracker for the animation callback. Default is null. If assigned, will be called each time the current frame changes. A function that has 3 parameters: a string name, a uint frame number, and a uint frame index.

Internal tracker for color tint, used with Flash getter/setter.

Internal, helps with animation, caching and drawing.

Internal, keeps track of the current animation being played.

Internal, keeps track of the current frame of animation. This is NOT an index into the tile sheet, but the frame number in the animation object.

Internal, keeps track of the current index into the tile sheet based on animation or rotation.

Internal tracker for what direction the sprite is currently facing, used with Flash getter/setter.

Internal, reused frequently during drawing and animating.

Internal, reused frequently during drawing and animating. Always contains (0,0).

Internal, reused frequently during drawing and animating.

Internal, reused frequently during drawing and animating.

Internal, keeps track of whether the sprite was loaded with support for automatic reverse/mirroring.

Internal, used to time each frame of animation.

Internal, helps with animation, caching and drawing.

Internal, stores the entire source graphic (not the current displayed animation frame), used with Flash getter/setter.

Set alpha to a number between 0 and 1 to change the opacity of the sprite.

Controls whether the object is smoothed when rotated, affects performance.

The default value is false.

Blending modes, just like Photoshop or whatever. E.g. "multiply", "screen", etc.

The default value is null.

Set color to a number in this format: 0xRRGGBB. color IGNORES ALPHA. To change the opacity use alpha. Tints the whole sprite to be this color (similar to OpenGL vertex colors).

Set this flag to true to force the sprite to update during the draw() call. NOTE: Rarely if ever necessary, most sprite operations will flip this flag automatically.

Set facing using FlxSprite.LEFT,RIGHT, UP, and DOWN to take advantage of flipped sprites and/or just track player orientation more easily.

Whether the current animation has finished its first (or only) loop.

Tell the sprite to change to a specific frame of animation.

The height of the actual graphic or image being displayed (not necessarily the game object/bounding box). NOTE: Edit at your own risk!! This is intended to be read-only.

The actual Flash BitmapData object representing the current display state of the sprite.

The total number of frames in this image. WARNING: assumes each row in the sprite sheet is full!

The width of the actual graphic or image being displayed (not necessarily the game object/bounding box). NOTE: Edit at your own risk!! This is intended to be read-only.

If you changed the size of your sprite object after loading or making the graphic, you might need to offset the graphic away from the bound box to center it the way you want.

WARNING: The origin of the sprite will default to its center. If you change this, the visuals and the collisions will likely be pretty out-of-sync if you do any rotation.

Set pixels to any BitmapData object. Automatically adjust graphic size and render helpers.

Change the size of your sprite's graphic. NOTE: Scale doesn't currently affect collisions automatically, you will need to adjust the width, height and offset manually. WARNING: scaling sprites decreases rendering performance for this sprite by a factor of 10x!

Creates a white 8x8 square FlxSprite at the specified position. Optionally can load a simple, one-frame graphic instead.

Adds a new animation to the sprite.

Parameters

Pass in a function to be called whenever this sprite's animation changes.

Parameters

Internal function to update the current animation frame.

Helper function that adjusts the offset automatically to center the bounding box within the graphic.

Parameters

Clean up memory.

Called by game loop, updates then blits or renders current frame of animation to the screen

Request (or force) that the sprite update the frame before rendering. Useful if you are doing procedural generation or other weirdness!

Parameters

This function draws a line on this sprite from position X1,Y1 to position X2,Y2 with the specified color.

Parameters

Fills this sprite's graphic with a specific color.

Parameters

Load an image from an embedded graphic file.

Parameters

Create a pre-rotated sprite sheet from a simple sprite. This can make a huge difference in graphical performance!

Parameters

This function creates a flat colored square image dynamically.

Parameters

Check and see if this object is currently on screen. Differs from FlxObject's implementation in that it takes the actual graphic into account, not just the hitbox or bounding box or whatever.

Parameters

Checks to see if a point in 2D world space overlaps this FlxSprite object's current displayed pixels. This check is ALWAYS made in screen space, and always takes scroll factors into account.

Parameters

Plays an existing animation (e.g. "run"). If you call an animation that is already playing it will be ignored.

Parameters

Automatically called after update() by the game loop, this function just calls updateAnimation().

Tell the sprite to change to a random frame of animation Useful for instantiating particles or other weird things.

Parameters

Resets some important variables for sprite optimization and rendering.

Helper function that just sets origin to (0,0)

This function draws or stamps one FlxSprite onto another. This function is NOT intended to replace draw()!

Parameters

Internal function for updating the sprite's animation. Useful for cases when you need to update this but are buried down in too many supers. This function is called automatically by FlxSprite.postUpdate().