class FlxTile

How fast the speed of this object is changing (in pixels per second). Useful for smooth movement and gravity.

Bit field of flags (use with UP, DOWN, LEFT, RIGHT, etc) indicating collision directions. Use bitwise operators to check the values stored here. Useful for things like one-way platforms (e.g. allowCollisions = UP;). The accessor "solid" just flips this variable between NONE and ANY.

Set the angle (in degrees) of a sprite to rotate it. WARNING: rotating sprites decreases their rendering performance by a factor of ~10x when using blitting!

How fast the spin speed should change (in degrees per second).

Like drag but for spinning.

This is how fast you want this sprite to spin (in degrees per second).

Whether this sprite is dragged along with the horizontal movement of objects it collides with (makes sense for horizontally-moving platforms in platformers for example). Use values IMMOVABLE, ALWAYS, HEAVIER or NEVER

Whether this sprite is dragged along with the vertical movement of objects it collides with (for sticking to vertically-moving platforms in platformers for example). Use values IMMOVABLE, ALWAYS, HEAVIER or NEVER

Overriding this will force a specific color to be used for debug rect (ignoring any of the other debug bounding box colors specified).

Color used for the debug rect if allowCollisions == NONE.

Color used for the debug rect if this object collides partially (immovable in the case of FlxObject, or allowCollisions not equal to ANY or NONE in the case of tiles in FlxTilemap).

Color used for the debug rect if allowCollisions == ANY.

This isn't drag exactly, more like deceleration that is only applied when acceleration is not affecting the sprite.

The bounciness of this object. Only affects collisions. Default value is 0, or "not bouncy at all."

Handy for storing health percentage or armor points or whatever.

The height of this object's hitbox. For sprites, use offset to control the hitbox position.

Setting this to true will prevent the object's bounding box from appearing when FlxG.debugger.drawDebug is true.

Whether an object will move/alter position after a collision.

Important variable for collision processing. By default this value is set automatically during at the start of update().

The virtual mass of the object. Default value is 1. Currently only used with elasticity during collision resolution. Change at your own risk; effects seem crazy unpredictable so far!

Use in conjunction with angularAcceleration for fluid spin speed control.

If you are using acceleration, you can use maxVelocity with it to cap the speed automatically (very useful!).

Set this to false if you want to skip the automatic motion/movement stuff (see updateMotion()). FlxObject and FlxSprite default to true. FlxText, FlxTileblock and FlxTilemap default to false.

The path this object follows. Not initialized by default. Assign a new FlxPath() object and start() it if you want to this object to follow a path. Set path to null again to stop following the path. See flixel.util.FlxPath for more info and usage examples.

Whether or not the position of this object should be rounded before any draw() or collision checking.

Whether or not the coordinates should be rounded during rendering. Does not affect copyPixels(), which can only render on whole pixels. Defaults to the camera's global pixelPerfectRender value, but overrides that value if not equal to null.

Controls how much this object is affected by camera scrolling. 0 = no movement (e.g. a background layer), 1 = same movement speed as the foreground. Default value is (1,1), except for UI elements like FlxButton where it's (0,0).

Whether the object collides or not. For more control over what directions the object will collide from, use collision constants (like LEFT, FLOOR, etc) to set the value of allowCollisions directly.

Bit field of flags (use with UP, DOWN, LEFT, RIGHT, etc) indicating surface contacts. Use bitwise operators to check the values stored here, or use isTouching(), justTouched(), etc. You can even use them broadly as boolean values if you're feeling saucy!

The basic speed of this object (in pixels per second).

Bit field of flags (use with UP, DOWN, LEFT, RIGHT, etc) indicating surface contacts from the previous game loop step. Use bitwise operators to check the values stored here, or use isTouching(), justTouched(), etc. You can even use them broadly as boolean values if you're feeling saucy!

The width of this object's hitbox. For sprites, use offset to control the hitbox position.

X position of the upper left corner of this object in world space.

Y position of the upper left corner of this object in world space.

A unique ID starting from 0 and increasing by 1 for each subsequent FlxBasic that is created.

Controls whether update() is automatically called by FlxState/FlxGroup.

Useful state for many game objects - "dead" (!alive) vs alive. kill() and revive() both flip this switch (along with exists, but you can override that).

Gets or sets the first camera of this object.

This determines on which FlxCameras this object will be drawn. If it is null / has not been set, it uses the list of default draw targets, which is controlled via FlxG.camera.setDefaultDrawTarget as well as the DefaultDrawTarget argument of FlxG.camera.add.

The parent containing this basic, typically if you check this recursively you should reach the state

Controls whether update() and draw() are automatically called by FlxState/FlxGroup.

Controls whether draw() is automatically called by FlxState/FlxGroup.

Rarely called, and in this case just increments the visible objects count and calls drawDebug() if necessary.

Override this function to draw custom "debug mode" graphics to the specified camera while the debugger's drawDebug mode is toggled on.

Parameters:

Retrieve the midpoint of this object in world coordinates.

Parameters:

Returns:

Returns the world position of this object.

Parameters:

Returns:

Calculates the smallest globally aligned bounding box that encompasses this object's width and height, at its current rotation. Note, if called on a FlxSprite, the origin is used, but scale and offset are ignored. Use getScreenBounds to use these properties.

Parameters:

Returns:

Returns the screen position of this object.

Parameters:

Returns:

Reduces the health variable of this object by the amount specified in Damage. Calls kill() if health drops to or below zero.

Parameters:

Check and see if this object is currently within the world bounds - useful for killing objects that get too far away.

Returns:

Check and see if this object is currently on screen.

Parameters:

Returns:

Check if object is rendered pixel perfect on a specific camera.

Handy function for checking if this object is touching a particular surface. Note: These flags are set from FlxG.collide calls, and get reset in super.update().

Parameters:

Returns:

Handy function for checking if this object is just landed on a particular surface. Note: These flags are set from FlxG.collide calls, and get reset in super.update().

Parameters:

Returns:

Checks to see if some FlxObject overlaps this FlxObject or FlxGroup. If the group has a LOT of things in it, it might be faster to use FlxG.overlap(). WARNING: Currently tilemaps do NOT support screen space overlap checks!

Parameters:

Returns:

Checks to see if this FlxObject were located at the given position, would it overlap the FlxObject or FlxGroup? This is distinct from overlapsPoint(), which just checks that point, rather than taking the object's size into account. WARNING: Currently tilemaps do NOT support screen space overlap checks!

Parameters:

Returns:

Checks to see if a point in 2D world space overlaps this FlxObject.

Parameters:

Returns:

Handy function for reviving game objects. Resets their existence flags and position.

Parameters:

Centers this FlxObject on the screen, either by the x axis, y axis, or both.

Parameters:

Returns:

Helper function to set the coordinates of this object. Handy since it only requires one line of code.

Parameters:

Shortcut for setting both width and Height.

Parameters:

Convert object to readable string name. Useful for debugging, save games, etc.

Override this function to update your class's position and appearance. This is where most of your game rules and behavioral code will go.

The cameras that will draw this. Use this.cameras to set specific cameras for this object, otherwise the container's cameras are used, or the container's container and so on. If there is no container, say, if this is inside FlxGroups rather than a FlxContainer then the default draw cameras are returned.

The main camera that will draw this. Use this.cameras to set specific cameras for this object, otherwise the container's camera is used, or the container's container and so on. If there is no container, say, if this is inside FlxGroups rather than a FlxContainer then FlxG.camera is returned.

Handy function for "killing" game objects. Use reset() to revive them. Default behavior is to flag them as nonexistent AND dead. However, if you want the "corpse" to remain in the game, like to animate an effect or whatever, you should override this, setting only alive to false, and leaving exists true.

Handy function for bringing game objects "back to life". Just sets alive and exists back to true. In practice, this function is most often called by FlxObject#reset().