Internal storage system to prevent graphics from being used repeatedly in memory.

Internal helper variable for clearing the cameras each frame.

Internal tracker for game object.

Internal volume level, used for global sound control.

Get and set the background color of the game. Get functionality is equivalent to FlxG.camera.bgColor. Set functionality sets the background color of all the current cameras.

By default this just refers to the first entry in the cameras array declared above, but you can do what you like with it.

An array of FlxCamera objects that are used to draw stuff. By default flixel creates one camera the size of the screen.

Whether you are running in Debug or Release mode. Set automatically by FlxPreloader during startup.

Represents the amount of time in seconds that passed since last frame.

How many times you want your game to update each second. More updates usually means better collisions and smoother motion. NOTE: This is NOT the same thing as the Flash Player framerate!

Useful helper objects for doing Flash-specific rendering. Primarily used for "debug visuals" like drawing bounding boxes directly to the screen buffer.

How many times you want your game to update each second. More updates usually means better collisions and smoother motion. NOTE: This is NOT the same thing as the Flash Player framerate!

The global random number generator seed (for deterministic behavior in recordings and saves).

The height of the screen in game pixels.

A reference to a FlxKeyboard object. Important for input!

FlxG.levels and FlxG.scores are generic global variables that can be used for various cross-state stuff.

Assign a major version to your library. Appears before the decimal in the console.

Assign a minor version to your library. Appears after the decimal in the console.

If you build and maintain your own version of flixel, you can give it your own name here.

Setting this to true will disable/skip stuff that isn't necessary for mobile platforms like Android. [BETA]

A reference to a FlxMouse object. Important for input!

A handy container for a background music object.

Whether or not the game sounds are muted.

Handy shared variable for implementing your own pause behavior.

An array container for plugins. By default flixel uses a couple of plugins: DebugPathDisplay, and TimerManager.

FlxG.saves is a generic bucket for storing FlxSaves so you can access them whenever you want.

A list of all the sounds being played in the game.

Read-only: retrieves the Flash stage object (required for event listeners) Will be null if it's not safe/useful yet.

Read-only: access the current game state from anywhere.

How fast or slow time should pass in the game; default is 1.0.

Allows you to possibly slightly optimize the rendering process IF you are not doing any pre-processing in your game state's draw() call.

The default value is false.

Whether to show visual debug displays or not. Default = false.

Set volume to a number between 0 and 1 to change the global volume.

The default value is 0.5.

Set this hook to get a callback whenever the volume changes. Function should take the form myVolumeHandler(Volume:Number).

The width of the screen in game pixels.

The dimensions of the game world, used by the quad tree for collisions and overlap checks.

How many times the quad tree should divide the world on each axis. Generally, sparse collisions can have fewer divisons, while denser collision activity usually profits from more. Default value is 6.

Loads a bitmap from a file, caches it, and generates a horizontally flipped version if necessary.

Parameters

Add a new camera object to the game. Handy for PiP, split-screen, etc.

Parameters

Adds a new plugin to the global plugin array.

Parameters

Check the local bitmap cache to see if a bitmap with this key has been loaded already.

Parameters

Dumps the cache's image references.

Call this function to see if one FlxObject collides with another. Can be called with one object and one group, or two groups, or two objects, whatever floats your boat! For maximum performance try bundling a lot of objects together using a FlxGroup (or even bundling groups together!).

This function just calls FlxG.overlap and presets the ProcessCallback parameter to FlxObject.separate. To create your own collision logic, write your own ProcessCallback and use FlxG.overlap to set it up.

NOTE: does NOT take objects' scrollfactor into account, all overlaps are checked in world space.

Parameters

Generates a new BitmapData object (a colored square) and caches it.

Parameters

Called by FlxGame on state changes to stop and destroy sounds.

Parameters

Used by the game object to call draw() on all the plugins.

The screen is gradually filled with this color.

Parameters

All screens are filled with this color and gradually return to normal.

Parameters

Retrieves a plugin based on its class name from the global plugin array.

Parameters

Fetch a random entry from the given array. Will return null if random selection is missing, or array has no entries. FlxG.getRandom() is deterministic and safe for use with replays/recordings. HOWEVER, FlxU.getRandom() is NOT deterministic and unsafe for use with replays/recordings.

Parameters

Called by FlxGame to set up FlxG during FlxGame's constructor.

Parameters

Load replay data from a string and play it back.

Parameters

Creates a new sound object.

Parameters

Called by the game object to lock all the camera buffers and clear them for the next draw pass.

Log data to the debugger.

Parameters

Call this function to see if one FlxObject overlaps another. Can be called with one object and one group, or two groups, or two objects, whatever floats your boat! For maximum performance try bundling a lot of objects together using a FlxGroup (or even bundling groups together!).

NOTE: does NOT take objects' scrollfactor into account, all overlaps are checked in world space.

Parameters

Pause all sounds currently playing.

Creates a new sound object from an embedded Class object. NOTE: Just calls FlxG.loadSound() with AutoPlay == true.

Parameters

Set up and play a looping background soundtrack.

Parameters

Generates a random number. Deterministic, meaning safe to use if you want to record replays in random environments.

Resets the game or state and requests a new recording.

Parameters

Resets the game or state and replay requested flag.

Parameters

Remove a camera from the game.

Parameters

Removes an instance of a plugin from the global plugin array.

Parameters

Removes an instance of a plugin from the global plugin array.

Parameters

Called whenever the game is reset, doesn't have to do quite as much work as the basic initialization stuff.

Dumps all the current cameras and resets to just one camera. Handy for doing split-screen especially.

Parameters

Just resets the debugger windows to whatever the last selected layout was (DEBUGGER_STANDARD by default).

Like hitting the reset button on a game console, this will re-launch the game as if it just started.

Reset the input helper objects (useful when changing screens or states)

Request a reset of the current game state.

Resume playing existing sounds.

Change the way the debugger's windows are laid out.

Parameters

A simple screen-shake effect.

Parameters

Shuffles the entries in an array into a new random order. FlxG.shuffle() is deterministic and safe for use with replays/recordings. HOWEVER, FlxU.shuffle() is NOT deterministic and unsafe for use with replays/recordings.

Parameters

Stop recording the current replay and return the replay data.

Stops the current replay.

Creates a new sound object from a URL. NOTE: Just calls FlxG.loadSound() with AutoPlay == true.

Parameters

Switch from the current game state to the one specified here.

Parameters

Called by the game object to draw the special FX and unlock all the camera buffers.

Remove a variable from the watch list in the debugger. Don't pass a Variable Name to remove all watched variables for the specified object.

Parameters

Called by the game object to update the cameras and their tracking/special effects logic.

Called by the game object to update the keyboard and mouse input tracking objects.

Used by the game object to call update() on all the plugins.

Called by the game loop to make sure the sounds get updated each frame.

Add a variable to the watch list in the debugger. This lets you see the value of the variable all the time.

Parameters

And black too.

Blue is used to indicate non-solid objects.

Debugger overlay layout preset: Large windows taking up bottom half of screen.

Debugger overlay layout preset: Large windows taking up left third of screen.

Debugger overlay layout preset: Tiny windows in the screen corners.

Debugger overlay layout preset: Large windows taking up right third of screen.

Debugger overlay layout preset: Wide but low windows at the bottom of the screen.

Debugger overlay layout preset: Wide but low windows at the top of the screen.

Green is used to indicate solid but immovable objects.

Pink is used to indicate objects that are only partially solid, like one-way platforms.

Some handy color presets. Less glaring than pure RGB full values. Primarily used in the visual debugger mode for bounding box displays. Red is used to indicate an active, movable, solid object.

White... for white stuff.