Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Replaced CRLF line endings with LF.

  • Loading branch information...
commit 1c685f8f7824f6c40c405032b85bd8cd9a759380 1 parent dcd890f
@haydn haydn authored
View
524 org/flixel/FlxButton.as
@@ -1,263 +1,263 @@
-package org.flixel
-{
+package org.flixel
+{
import flash.events.MouseEvent;
-
- /**
- * A simple button class that calls a function when clicked by the mouse.
- *
- * @author Adam Atomic
- */
- public class FlxButton extends FlxSprite
- {
- [Embed(source="data/button.png")] protected var ImgDefaultButton:Class;
-
- /**
- * Used with public variable <code>status</code>, means not highlighted or pressed.
- */
- static public var NORMAL:uint = 0;
- /**
- * Used with public variable <code>status</code>, means highlighted (usually from mouse over).
- */
- static public var HIGHLIGHT:uint = 1;
- /**
- * Used with public variable <code>status</code>, means pressed (usually from mouse click).
- */
- static public var PRESSED:uint = 2;
-
- /**
- * The text that appears on the button.
- */
- public var label:FlxText;
- /**
- * Controls the offset (from top left) of the text from the button.
- */
- public var labelOffset:FlxPoint;
- /**
- * Shows the current state of the button.
- */
- public var status:uint;
-
- /**
- * Used for checkbox-style behavior.
- */
- protected var _onToggle:Boolean;
- /**
- * This function is called when the button is clicked.
- */
- protected var _onClick:Function;
- /**
- * This function is called when the mouse goes over the button.
- */
- protected var _onOver:Function;
- /**
- * This function is called when the mouse leaves the button area.
- */
- protected var _onOut:Function;
- /**
- * Tracks whether or not the button is currently pressed.
- */
- protected var _pressed:Boolean;
- /**
- * Whether or not the button has initialized itself yet.
- */
- protected var _initialized:Boolean;
-
- /**
- * Creates a new <code>FlxButton</code> object with a gray background
- * and a callback function on the UI thread.
- *
- * @param X The X position of the button.
- * @param Y The Y position of the button.
- * @param Label The text that you want to appear on the button.
- * @param OnClick The function to call whenever the button is clicked.
- * @param OnOver The function to call whenever the mouse goes over the button.
- * @param OnOut The function to call whenever the mouse leaves the button area.
- */
- public function FlxButton(X:Number=0,Y:Number=0,Label:String=null,OnClick:Function=null,OnOver:Function=null,OnOut:Function=null)
- {
- super(X,Y);
- _onClick = OnClick;
- _onOver = OnOver;
- _onOut = OnOut;
- if(Label != null)
- {
- label = new FlxText(0,0,80,Label);
- label.setFormat(null,8,0x333333,"center");
- labelOffset = new FlxPoint(-1,3);
- }
- loadGraphic(ImgDefaultButton,true,false,80,20);
-
- status = NORMAL;
- _onToggle = false;
- _pressed = false;
- _initialized = false;
- }
-
- /**
- * Called by the game state when state is changed (if this object belongs to the state)
- */
- override public function destroy():void
- {
- if(FlxG.stage != null)
- FlxG.stage.removeEventListener(MouseEvent.MOUSE_UP, onMouseUp);
- if(label != null)
- {
- label.destroy();
- label = null;
- }
- _onClick = null;
- super.destroy();
- }
-
- /**
- * Since button uses its own mouse handler for thread reasons,
- * we run a little pre-check here to make sure that we only add
- * the mouse handler when it is actually safe to do so.
- */
- override public function preUpdate():void
- {
- super.preUpdate();
-
- if(!_initialized)
- {
- if(FlxG.stage != null)
- {
- FlxG.stage.addEventListener(MouseEvent.MOUSE_UP, onMouseUp);
- _initialized = true;
- }
- }
- }
-
- /**
- * Called by the game loop automatically, handles mouseover and click detection.
- */
- override public function update():void
- {
- updateButton(); //Basic button logic
-
- //Default button appearance is to simply update
- // the label appearance based on animation frame.
- if(label == null)
- return;
- switch(frame)
- {
- case HIGHLIGHT: //Extra behavior to accomodate checkbox logic.
- label.alpha = 1.0;
- break;
- case PRESSED:
- label.alpha = 0.5;
- label.y++;
- break;
- case NORMAL:
- default:
- label.alpha = 0.8;
- break;
- }
- }
-
- /**
- * Basic button update logic
- */
- protected function updateButton():void
- {
- //Figure out if the button is highlighted or pressed or what
- // (ignore checkbox behavior for now).
- if(FlxG.mouse.visible)
- {
- if(cameras == null)
- cameras = FlxG.cameras;
- var camera:FlxCamera;
- var i:uint = 0;
- var l:uint = cameras.length;
- var offAll:Boolean = true;
- while(i < l)
- {
- camera = cameras[i++] as FlxCamera;
- FlxG.mouse.getWorldPosition(camera,_point);
- if(overlapsPoint(_point,true,camera))
- {
- offAll = false;
- if(FlxG.mouse.justPressed())
- status = PRESSED;
- if(status == NORMAL)
- {
- status = HIGHLIGHT;
- if(_onOver != null)
- _onOver();
- }
- }
- }
- if(offAll)
- {
- if((status != NORMAL) && (_onOut != null))
- _onOut();
- status = NORMAL;
- }
- }
-
- //Then if the label and/or the label offset exist,
- // position them to match the button.
- if(label != null)
- {
- label.x = x;
- label.y = y;
- }
- if(labelOffset != null)
- {
- label.x += labelOffset.x;
- label.y += labelOffset.y;
- }
-
- //Then pick the appropriate frame of animation
- if((status == HIGHLIGHT) && _onToggle)
- frame = NORMAL;
- else
- frame = status;
- }
-
- /**
- * Just draws the button graphic and text label to the screen.
- */
- override public function draw():void
- {
- super.draw();
- if(label != null)
- label.draw();
- }
-
- /**
- * Updates the size of the text field to match the button.
- */
- override protected function resetHelpers():void
- {
- super.resetHelpers();
- if(label != null)
- label.width = width;
- }
-
- /**
- * Use this to toggle checkbox-style behavior.
- */
- public function get on():Boolean
- {
- return _onToggle;
- }
-
- /**
- * @private
- */
- public function set on(On:Boolean):void
- {
- _onToggle = On;
- }
-
- /**
- * Internal function for handling the actual callback call (for UI thread dependent calls like <code>FlxU.openURL()</code>).
- */
- protected function onMouseUp(event:MouseEvent):void
- {
- if(exists && visible && active && (status == PRESSED) && (_onClick != null))
- _onClick();
- }
- }
-}
+
+ /**
+ * A simple button class that calls a function when clicked by the mouse.
+ *
+ * @author Adam Atomic
+ */
+ public class FlxButton extends FlxSprite
+ {
+ [Embed(source="data/button.png")] protected var ImgDefaultButton:Class;
+
+ /**
+ * Used with public variable <code>status</code>, means not highlighted or pressed.
+ */
+ static public var NORMAL:uint = 0;
+ /**
+ * Used with public variable <code>status</code>, means highlighted (usually from mouse over).
+ */
+ static public var HIGHLIGHT:uint = 1;
+ /**
+ * Used with public variable <code>status</code>, means pressed (usually from mouse click).
+ */
+ static public var PRESSED:uint = 2;
+
+ /**
+ * The text that appears on the button.
+ */
+ public var label:FlxText;
+ /**
+ * Controls the offset (from top left) of the text from the button.
+ */
+ public var labelOffset:FlxPoint;
+ /**
+ * Shows the current state of the button.
+ */
+ public var status:uint;
+
+ /**
+ * Used for checkbox-style behavior.
+ */
+ protected var _onToggle:Boolean;
+ /**
+ * This function is called when the button is clicked.
+ */
+ protected var _onClick:Function;
+ /**
+ * This function is called when the mouse goes over the button.
+ */
+ protected var _onOver:Function;
+ /**
+ * This function is called when the mouse leaves the button area.
+ */
+ protected var _onOut:Function;
+ /**
+ * Tracks whether or not the button is currently pressed.
+ */
+ protected var _pressed:Boolean;
+ /**
+ * Whether or not the button has initialized itself yet.
+ */
+ protected var _initialized:Boolean;
+
+ /**
+ * Creates a new <code>FlxButton</code> object with a gray background
+ * and a callback function on the UI thread.
+ *
+ * @param X The X position of the button.
+ * @param Y The Y position of the button.
+ * @param Label The text that you want to appear on the button.
+ * @param OnClick The function to call whenever the button is clicked.
+ * @param OnOver The function to call whenever the mouse goes over the button.
+ * @param OnOut The function to call whenever the mouse leaves the button area.
+ */
+ public function FlxButton(X:Number=0,Y:Number=0,Label:String=null,OnClick:Function=null,OnOver:Function=null,OnOut:Function=null)
+ {
+ super(X,Y);
+ _onClick = OnClick;
+ _onOver = OnOver;
+ _onOut = OnOut;
+ if(Label != null)
+ {
+ label = new FlxText(0,0,80,Label);
+ label.setFormat(null,8,0x333333,"center");
+ labelOffset = new FlxPoint(-1,3);
+ }
+ loadGraphic(ImgDefaultButton,true,false,80,20);
+
+ status = NORMAL;
+ _onToggle = false;
+ _pressed = false;
+ _initialized = false;
+ }
+
+ /**
+ * Called by the game state when state is changed (if this object belongs to the state)
+ */
+ override public function destroy():void
+ {
+ if(FlxG.stage != null)
+ FlxG.stage.removeEventListener(MouseEvent.MOUSE_UP, onMouseUp);
+ if(label != null)
+ {
+ label.destroy();
+ label = null;
+ }
+ _onClick = null;
+ super.destroy();
+ }
+
+ /**
+ * Since button uses its own mouse handler for thread reasons,
+ * we run a little pre-check here to make sure that we only add
+ * the mouse handler when it is actually safe to do so.
+ */
+ override public function preUpdate():void
+ {
+ super.preUpdate();
+
+ if(!_initialized)
+ {
+ if(FlxG.stage != null)
+ {
+ FlxG.stage.addEventListener(MouseEvent.MOUSE_UP, onMouseUp);
+ _initialized = true;
+ }
+ }
+ }
+
+ /**
+ * Called by the game loop automatically, handles mouseover and click detection.
+ */
+ override public function update():void
+ {
+ updateButton(); //Basic button logic
+
+ //Default button appearance is to simply update
+ // the label appearance based on animation frame.
+ if(label == null)
+ return;
+ switch(frame)
+ {
+ case HIGHLIGHT: //Extra behavior to accomodate checkbox logic.
+ label.alpha = 1.0;
+ break;
+ case PRESSED:
+ label.alpha = 0.5;
+ label.y++;
+ break;
+ case NORMAL:
+ default:
+ label.alpha = 0.8;
+ break;
+ }
+ }
+
+ /**
+ * Basic button update logic
+ */
+ protected function updateButton():void
+ {
+ //Figure out if the button is highlighted or pressed or what
+ // (ignore checkbox behavior for now).
+ if(FlxG.mouse.visible)
+ {
+ if(cameras == null)
+ cameras = FlxG.cameras;
+ var camera:FlxCamera;
+ var i:uint = 0;
+ var l:uint = cameras.length;
+ var offAll:Boolean = true;
+ while(i < l)
+ {
+ camera = cameras[i++] as FlxCamera;
+ FlxG.mouse.getWorldPosition(camera,_point);
+ if(overlapsPoint(_point,true,camera))
+ {
+ offAll = false;
+ if(FlxG.mouse.justPressed())
+ status = PRESSED;
+ if(status == NORMAL)
+ {
+ status = HIGHLIGHT;
+ if(_onOver != null)
+ _onOver();
+ }
+ }
+ }
+ if(offAll)
+ {
+ if((status != NORMAL) && (_onOut != null))
+ _onOut();
+ status = NORMAL;
+ }
+ }
+
+ //Then if the label and/or the label offset exist,
+ // position them to match the button.
+ if(label != null)
+ {
+ label.x = x;
+ label.y = y;
+ }
+ if(labelOffset != null)
+ {
+ label.x += labelOffset.x;
+ label.y += labelOffset.y;
+ }
+
+ //Then pick the appropriate frame of animation
+ if((status == HIGHLIGHT) && _onToggle)
+ frame = NORMAL;
+ else
+ frame = status;
+ }
+
+ /**
+ * Just draws the button graphic and text label to the screen.
+ */
+ override public function draw():void
+ {
+ super.draw();
+ if(label != null)
+ label.draw();
+ }
+
+ /**
+ * Updates the size of the text field to match the button.
+ */
+ override protected function resetHelpers():void
+ {
+ super.resetHelpers();
+ if(label != null)
+ label.width = width;
+ }
+
+ /**
+ * Use this to toggle checkbox-style behavior.
+ */
+ public function get on():Boolean
+ {
+ return _onToggle;
+ }
+
+ /**
+ * @private
+ */
+ public function set on(On:Boolean):void
+ {
+ _onToggle = On;
+ }
+
+ /**
+ * Internal function for handling the actual callback call (for UI thread dependent calls like <code>FlxU.openURL()</code>).
+ */
+ protected function onMouseUp(event:MouseEvent):void
+ {
+ if(exists && visible && active && (status == PRESSED) && (_onClick != null))
+ _onClick();
+ }
+ }
+}
View
2,406 org/flixel/FlxG.as
@@ -1,1204 +1,1204 @@
-package org.flixel
-{
- import flash.display.BitmapData;
- import flash.display.Graphics;
- import flash.display.Sprite;
- import flash.display.Stage;
- import flash.geom.Matrix;
- import flash.geom.Point;
- import flash.geom.Rectangle;
-
- import org.flixel.plugin.DebugPathDisplay;
- import org.flixel.plugin.TimerManager;
- import org.flixel.system.FlxDebugger;
- import org.flixel.system.FlxQuadTree;
+package org.flixel
+{
+ import flash.display.BitmapData;
+ import flash.display.Graphics;
+ import flash.display.Sprite;
+ import flash.display.Stage;
+ import flash.geom.Matrix;
+ import flash.geom.Point;
+ import flash.geom.Rectangle;
+
+ import org.flixel.plugin.DebugPathDisplay;
+ import org.flixel.plugin.TimerManager;
+ import org.flixel.system.FlxDebugger;
+ import org.flixel.system.FlxQuadTree;
import org.flixel.system.input.*;
-
- /**
- * This is a global helper class full of useful functions for audio,
- * input, basic info, and the camera system among other things.
- * Utilities for maths and color and things can be found in <code>FlxU</code>.
- * <code>FlxG</code> is specifically for Flixel-specific properties.
- *
- * @author Adam Atomic
- */
- public class FlxG
- {
- /**
- * If you build and maintain your own version of flixel,
- * you can give it your own name here.
- */
- static public var LIBRARY_NAME:String = "flixel";
- /**
- * Assign a major version to your library.
- * Appears before the decimal in the console.
- */
- static public var LIBRARY_MAJOR_VERSION:uint = 2;
- /**
- * Assign a minor version to your library.
- * Appears after the decimal in the console.
- */
- static public var LIBRARY_MINOR_VERSION:uint = 51;
-
- /**
- * Debugger overlay layout preset: Wide but low windows at the bottom of the screen.
- */
- static public const DEBUGGER_STANDARD:uint = 0;
- /**
- * Debugger overlay layout preset: Tiny windows in the screen corners.
- */
- static public const DEBUGGER_MICRO:uint = 1;
- /**
- * Debugger overlay layout preset: Large windows taking up bottom half of screen.
- */
- static public const DEBUGGER_BIG:uint = 2;
- /**
- * Debugger overlay layout preset: Wide but low windows at the top of the screen.
- */
- static public const DEBUGGER_TOP:uint = 3;
- /**
- * Debugger overlay layout preset: Large windows taking up left third of screen.
- */
- static public const DEBUGGER_LEFT:uint = 4;
- /**
- * Debugger overlay layout preset: Large windows taking up right third of screen.
- */
- static public const DEBUGGER_RIGHT:uint = 5;
-
- /**
- * 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.
- */
- static public const RED:uint = 0xffff0012;
- /**
- * Green is used to indicate solid but immovable objects.
- */
- static public const GREEN:uint = 0xff00f225;
- /**
- * Blue is used to indicate non-solid objects.
- */
- static public const BLUE:uint = 0xff0090e9;
- /**
- * Pink is used to indicate objects that are only partially solid, like one-way platforms.
- */
- static public const PINK:uint = 0xfff01eff;
- /**
- * White... for white stuff.
- */
- static public const WHITE:uint = 0xffffffff;
- /**
- * And black too.
- */
- static public const BLACK:uint = 0xff000000;
-
- /**
- * Internal tracker for game object.
- */
- static internal var _game:FlxGame;
- /**
- * Handy shared variable for implementing your own pause behavior.
- */
- static public var paused:Boolean;
- /**
- * Whether you are running in Debug or Release mode.
- * Set automatically by <code>FlxPreloader</code> during startup.
- */
- static public var debug:Boolean;
-
- /**
- * Represents the amount of time in seconds that passed since last frame.
- */
- static public var elapsed:Number;
- /**
- * How fast or slow time should pass in the game; default is 1.0.
- */
- static public var timeScale:Number;
- /**
- * The width of the screen in game pixels.
- */
- static public var width:uint;
- /**
- * The height of the screen in game pixels.
- */
- static public var height:uint;
- /**
- * The dimensions of the game world, used by the quad tree for collisions and overlap checks.
- */
- static public var worldBounds:FlxRect;
- /**
- * 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.
- */
- static public var worldDivisions:uint;
- /**
- * Whether to show visual debug displays or not.
- * Default = false.
- */
- static public var visualDebug:Boolean;
- /**
- * Setting this to true will disable/skip stuff that isn't necessary for mobile platforms like Android. [BETA]
- */
- static public var mobile:Boolean;
- /**
- * The global random number generator seed (for deterministic behavior in recordings and saves).
- */
- static public var globalSeed:Number;
- /**
- * <code>FlxG.levels</code> and <code>FlxG.scores</code> are generic
- * global variables that can be used for various cross-state stuff.
- */
- static public var levels:Array;
- static public var level:int;
- static public var scores:Array;
- static public var score:int;
- /**
- * <code>FlxG.saves</code> is a generic bucket for storing
- * FlxSaves so you can access them whenever you want.
- */
- static public var saves:Array;
- static public var save:int;
-
- /**
- * A reference to a <code>FlxMouse</code> object. Important for input!
- */
- static public var mouse:Mouse;
- /**
- * A reference to a <code>FlxKeyboard</code> object. Important for input!
- */
- static public var keys:Keyboard;
-
- /**
- * A handy container for a background music object.
- */
- static public var music:FlxSound;
- /**
- * A list of all the sounds being played in the game.
- */
- static public var sounds:FlxGroup;
- /**
- * Whether or not the game sounds are muted.
- */
- static public var mute:Boolean;
- /**
- * Internal volume level, used for global sound control.
- */
- static protected var _volume:Number;
-
- /**
- * An array of <code>FlxCamera</code> objects that are used to draw stuff.
- * By default flixel creates one camera the size of the screen.
- */
- static public var cameras:Array;
- /**
- * By default this just refers to the first entry in the cameras array
- * declared above, but you can do what you like with it.
- */
- static public var camera:FlxCamera;
- /**
- * Allows you to possibly slightly optimize the rendering process IF
- * you are not doing any pre-processing in your game state's <code>draw()</code> call.
- * @default false
- */
- static public var useBufferLocking:Boolean;
- /**
- * Internal helper variable for clearing the cameras each frame.
- */
- static protected var _cameraRect:Rectangle;
-
- /**
- * An array container for plugins.
- * By default flixel uses a couple of plugins:
- * DebugPathDisplay, and TimerManager.
- */
- static public var plugins:Array;
-
- /**
- * Set this hook to get a callback whenever the volume changes.
- * Function should take the form <code>myVolumeHandler(Volume:Number)</code>.
- */
- static public var volumeHandler:Function;
-
- /**
- * Useful helper objects for doing Flash-specific rendering.
- * Primarily used for "debug visuals" like drawing bounding boxes directly to the screen buffer.
- */
- static public var flashGfxSprite:Sprite;
- static public var flashGfx:Graphics;
-
- /**
- * Internal storage system to prevent graphics from being used repeatedly in memory.
- */
- static protected var _cache:Object;
-
- static public function getLibraryName():String
- {
- return FlxG.LIBRARY_NAME + " v" + FlxG.LIBRARY_MAJOR_VERSION + "." + FlxG.LIBRARY_MINOR_VERSION;
- }
-
- /**
- * Log data to the debugger.
- *
- * @param Data Anything you want to log to the console.
- */
- static public function log(Data:Object):void
- {
- if((_game != null) && (_game._debugger != null))
- _game._debugger.log.add((Data == null)?"ERROR: null object":Data.toString());
- }
-
- /**
- * Add a variable to the watch list in the debugger.
- * This lets you see the value of the variable all the time.
- *
- * @param AnyObject A reference to any object in your game, e.g. Player or Robot or this.
- * @param VariableName The name of the variable you want to watch, in quotes, as a string: e.g. "speed" or "health".
- * @param DisplayName Optional, display your own string instead of the class name + variable name: e.g. "enemy count".
- */
- static public function watch(AnyObject:Object,VariableName:String,DisplayName:String=null):void
- {
- if((_game != null) && (_game._debugger != null))
- _game._debugger.watch.add(AnyObject,VariableName,DisplayName);
- }
-
- /**
- * 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.
- *
- * @param AnyObject A reference to any object in your game, e.g. Player or Robot or this.
- * @param VariableName The name of the variable you want to watch, in quotes, as a string: e.g. "speed" or "health".
- */
- static public function unwatch(AnyObject:Object,VariableName:String=null):void
- {
- if((_game != null) && (_game._debugger != null))
- _game._debugger.watch.remove(AnyObject,VariableName);
- }
-
- /**
- * 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!
- */
- static public function get framerate():Number
- {
- return 1000/_game._step;
- }
-
- /**
- * @private
- */
- static public function set framerate(Framerate:Number):void
- {
- _game._step = 1000/Framerate;
- if(_game._maxAccumulation < _game._step)
- _game._maxAccumulation = _game._step;
- }
-
- /**
- * 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!
- */
- static public function get flashFramerate():Number
- {
- if(_game.root != null)
- return _game.stage.frameRate;
- else
- return 0;
- }
-
- /**
- * @private
- */
- static public function set flashFramerate(Framerate:Number):void
- {
- _game._flashFramerate = Framerate;
- if(_game.root != null)
- _game.stage.frameRate = _game._flashFramerate;
- _game._maxAccumulation = 2000/_game._flashFramerate - 1;
- if(_game._maxAccumulation < _game._step)
- _game._maxAccumulation = _game._step;
- }
-
- /**
- * Generates a random number. Deterministic, meaning safe
- * to use if you want to record replays in random environments.
- *
- * @return A <code>Number</code> between 0 and 1.
- */
- static public function random():Number
- {
- return globalSeed = FlxU.srand(globalSeed);
- }
-
- /**
- * Shuffles the entries in an array into a new random order.
- * <code>FlxG.shuffle()</code> is deterministic and safe for use with replays/recordings.
- * HOWEVER, <code>FlxU.shuffle()</code> is NOT deterministic and unsafe for use with replays/recordings.
- *
- * @param A A Flash <code>Array</code> object containing...stuff.
- * @param HowManyTimes How many swaps to perform during the shuffle operation. Good rule of thumb is 2-4 times as many objects are in the list.
- *
- * @return The same Flash <code>Array</code> object that you passed in in the first place.
- */
- static public function shuffle(Objects:Array,HowManyTimes:uint):Array
- {
- var i:uint = 0;
- var index1:uint;
- var index2:uint;
- var object:Object;
- while(i < HowManyTimes)
- {
- index1 = FlxG.random()*Objects.length;
- index2 = FlxG.random()*Objects.length;
- object = Objects[index2];
- Objects[index2] = Objects[index1];
- Objects[index1] = object;
- i++;
- }
- return Objects;
- }
-
- /**
- * Fetch a random entry from the given array.
- * Will return null if random selection is missing, or array has no entries.
- * <code>FlxG.getRandom()</code> is deterministic and safe for use with replays/recordings.
- * HOWEVER, <code>FlxU.getRandom()</code> is NOT deterministic and unsafe for use with replays/recordings.
- *
- * @param Objects A Flash array of objects.
- *
- * @return The random object that was selected.
- */
- static public function getRandom(Objects:Array):Object
- {
- if(Objects != null)
- {
- var l:uint = Objects.length;
- if(l > 0)
- return Objects[uint(FlxG.random()*l)];
- }
- return null;
- }
-
- /**
- * Load replay data from a string and play it back.
- *
- * @param Data The replay that you want to load.
- * @param State Optional parameter: if you recorded a state-specific demo or cutscene, pass a new instance of that state here.
- * @param CancelKeys Optional parameter: an array of string names of keys (see FlxKeyboard) that can be pressed to cancel the playback, e.g. ["ESCAPE","ENTER"]. Also accepts 2 custom key names: "ANY" and "MOUSE" (fairly self-explanatory I hope!).
- * @param Timeout Optional parameter: set a time limit for the replay. CancelKeys will override this if pressed.
- * @param Callback Optional parameter: if set, called when the replay finishes. Running to the end, CancelKeys, and Timeout will all trigger Callback(), but only once, and CancelKeys and Timeout will NOT call FlxG.stopReplay() if Callback is set!
- */
- static public function loadReplay(Data:String,State:FlxState=null,CancelKeys:Array=null,Timeout:Number=0,Callback:Function=null):void
- {
- _game._replay.load(Data);
- if(State == null)
- FlxG.resetGame();
- else
- FlxG.switchState(State);
- _game._replayCancelKeys = CancelKeys;
- _game._replayTimer = Timeout*1000;
- _game._replayCallback = Callback;
- _game._replayRequested = true;
- }
-
- /**
- * Resets the game or state and replay requested flag.
- *
- * @param StandardMode If true, reload entire game, else just reload current game state.
- */
- static public function reloadReplay(StandardMode:Boolean=true):void
- {
- if(StandardMode)
- FlxG.resetGame();
- else
- FlxG.resetState();
- if(_game._replay.frameCount > 0)
- _game._replayRequested = true;
- }
-
- /**
- * Stops the current replay.
- */
- static public function stopReplay():void
- {
- _game._replaying = false;
- if(_game._debugger != null)
- _game._debugger.vcr.stopped();
- resetInput();
- }
-
- /**
- * Resets the game or state and requests a new recording.
- *
- * @param StandardMode If true, reset the entire game, else just reset the current state.
- */
- static public function recordReplay(StandardMode:Boolean=true):void
- {
- if(StandardMode)
- FlxG.resetGame();
- else
- FlxG.resetState();
- _game._recordingRequested = true;
- }
-
- /**
- * Stop recording the current replay and return the replay data.
- *
- * @return The replay data in simple ASCII format (see <code>FlxReplay.save()</code>).
- */
- static public function stopRecording():String
- {
- _game._recording = false;
- if(_game._debugger != null)
- _game._debugger.vcr.stopped();
- return _game._replay.save();
- }
-
- /**
- * Request a reset of the current game state.
- */
- static public function resetState():void
- {
- _game._requestedState = new (FlxU.getClass(FlxU.getClassName(_game._state,false)))();
- }
-
- /**
- * Like hitting the reset button on a game console, this will re-launch the game as if it just started.
- */
- static public function resetGame():void
- {
- _game._requestedReset = true;
- }
-
- /**
- * Reset the input helper objects (useful when changing screens or states)
- */
- static public function resetInput():void
- {
- keys.reset();
- mouse.reset();
- }
-
- /**
- * Set up and play a looping background soundtrack.
- *
- * @param Music The sound file you want to loop in the background.
- * @param Volume How loud the sound should be, from 0 to 1.
- */
- static public function playMusic(Music:Class,Volume:Number=1.0):void
- {
- if(music == null)
- music = new FlxSound();
- else if(music.active)
- music.stop();
- music.loadEmbedded(Music,true);
- music.volume = Volume;
- music.survive = true;
- music.play();
- }
-
- /**
- * Creates a new sound object from an embedded <code>Class</code> object.
- *
- * @param EmbeddedSound The sound you want to play.
- * @param Volume How loud to play it (0 to 1).
- * @param Looped Whether or not to loop this sound.
- *
- * @return A <code>FlxSound</code> object.
- */
- static public function play(EmbeddedSound:Class,Volume:Number=1.0,Looped:Boolean=false):FlxSound
- {
- var sound:FlxSound = sounds.recycle(FlxSound) as FlxSound;
- sound.loadEmbedded(EmbeddedSound,Looped);
- sound.volume = Volume;
- sound.play();
- return sound;
- }
-
- /**
- * Creates a new sound object from a URL.
- *
- * @param URL The URL of the sound you want to play.
- * @param Volume How loud to play it (0 to 1).
- * @param Looped Whether or not to loop this sound.
- *
- * @return A FlxSound object.
- */
- static public function stream(URL:String,Volume:Number=1.0,Looped:Boolean=false):FlxSound
- {
- var sound:FlxSound = sounds.recycle(FlxSound) as FlxSound;
- sound.loadStream(URL,Looped);
- sound.volume = Volume;
- sound.play();
- return sound;
- }
-
- /**
- * Set <code>volume</code> to a number between 0 and 1 to change the global volume.
- *
- * @default 0.5
- */
- static public function get volume():Number
- {
- return _volume;
- }
-
- /**
- * @private
- */
- static public function set volume(Volume:Number):void
- {
- _volume = Volume;
- if(_volume < 0)
- _volume = 0;
- else if(_volume > 1)
- _volume = 1;
- if(volumeHandler != null)
- volumeHandler(FlxG.mute?0:_volume);
- }
-
- /**
- * Called by FlxGame on state changes to stop and destroy sounds.
- *
- * @param ForceDestroy Kill sounds even if they're flagged <code>survive</code>.
- */
- static internal function destroySounds(ForceDestroy:Boolean=false):void
- {
- if((music != null) && (ForceDestroy || !music.survive))
- {
- music.destroy();
- music = null;
- }
- var i:uint = 0;
- var sound:FlxSound;
- var l:uint = sounds.members.length;
- while(i < l)
- {
- sound = sounds.members[i++] as FlxSound;
- if((sound != null) && (ForceDestroy || !sound.survive))
- sound.destroy();
- }
- }
-
- /**
- * Called by the game loop to make sure the sounds get updated each frame.
- */
- static internal function updateSounds():void
- {
- if((music != null) && music.active)
- music.update();
- if((sounds != null) && sounds.active)
- sounds.update();
- }
-
- /**
- * Pause all sounds currently playing.
- */
- static public function pauseSounds():void
- {
- if((music != null) && music.exists && music.active)
- music.pause();
- var i:uint = 0;
- var sound:FlxSound;
- var l:uint = sounds.members.length;
- while(i < l)
- {
- sound = sounds.members[i++] as FlxSound;
- if((sound != null) && sound.exists && sound.active)
- sound.pause();
- }
- }
-
- /**
- * Resume playing existing sounds.
- */
- static public function playSounds():void
- {
- if((music != null) && music.exists)
- music.play();
- var i:uint = 0;
- var sound:FlxSound;
- var l:uint = sounds.members.length;
- while(i < l)
- {
- sound = sounds.members[i++] as FlxSound;
- if((sound != null) && sound.exists)
- sound.play();
- }
- }
-
- /**
- * Check the local bitmap cache to see if a bitmap with this key has been loaded already.
- *
- * @param Key The string key identifying the bitmap.
- *
- * @return Whether or not this file can be found in the cache.
- */
- static public function checkBitmapCache(Key:String):Boolean
- {
- return (_cache[Key] != undefined) && (_cache[Key] != null);
- }
-
- /**
- * Generates a new <code>BitmapData</code> object (a colored square) and caches it.
- *
- * @param Width How wide the square should be.
- * @param Height How high the square should be.
- * @param Color What color the square should be (0xAARRGGBB)
- * @param Unique Ensures that the bitmap data uses a new slot in the cache.
- * @param Key Force the cache to use a specific Key to index the bitmap.
- *
- * @return The <code>BitmapData</code> we just created.
- */
- static public function createBitmap(Width:uint, Height:uint, Color:uint, Unique:Boolean=false, Key:String=null):BitmapData
- {
- if(Key == null)
- {
- Key = Width+"x"+Height+":"+Color;
- if(Unique && checkBitmapCache(Key))
- {
- var inc:uint = 0;
- var ukey:String;
- do
- {
- ukey = Key + inc++;
- } while(checkBitmapCache(ukey));
- Key = ukey;
- }
- }
- if(!checkBitmapCache(Key))
- _cache[Key] = new BitmapData(Width,Height,true,Color);
- return _cache[Key];
- }
-
- /**
- * Loads a bitmap from a file, caches it, and generates a horizontally flipped version if necessary.
- *
- * @param Graphic The image file that you want to load.
- * @param Reverse Whether to generate a flipped version.
- * @param Unique Ensures that the bitmap data uses a new slot in the cache.
- * @param Key Force the cache to use a specific Key to index the bitmap.
- *
- * @return The <code>BitmapData</code> we just created.
- */
- static public function addBitmap(Graphic:Class, Reverse:Boolean=false, Unique:Boolean=false, Key:String=null):BitmapData
- {
- var needReverse:Boolean = false;
- if(Key == null)
- {
- Key = String(Graphic)+(Reverse?"_REVERSE_":"");
- if(Unique && checkBitmapCache(Key))
- {
- var inc:uint = 0;
- var ukey:String;
- do
- {
- ukey = Key + inc++;
- } while(checkBitmapCache(ukey));
- Key = ukey;
- }
- }
-
- //If there is no data for this key, generate the requested graphic
- if(!checkBitmapCache(Key))
- {
- _cache[Key] = (new Graphic).bitmapData;
- if(Reverse) needReverse = true;
- }
- var pixels:BitmapData = _cache[Key];
- if(!needReverse && Reverse && (pixels.width == (new Graphic).bitmapData.width))
- needReverse = true;
- if(needReverse)
- {
- var newPixels:BitmapData = new BitmapData(pixels.width<<1,pixels.height,true,0x00000000);
- newPixels.draw(pixels);
- var mtx:Matrix = new Matrix();
- mtx.scale(-1,1);
- mtx.translate(newPixels.width,0);
- newPixels.draw(pixels,mtx);
- pixels = newPixels;
- }
- return pixels;
- }
-
- /**
- * Dumps the cache's image references.
- */
- static public function clearBitmapCache():void
- {
- _cache = new Object();
- }
-
- /**
- * Read-only: retrieves the Flash stage object (required for event listeners)
- * Will be null if it's not safe/useful yet.
- */
- static public function get stage():Stage
- {
- if(_game.root != null)
- return _game.stage;
- return null;
- }
-
- /**
- * Read-only: access the current game state from anywhere.
- */
- static public function get state():FlxState
- {
- return _game._state;
- }
-
- /**
- * Switch from the current game state to the one specified here.
- */
- static public function switchState(State:FlxState):void
- {
- _game._requestedState = State;
- }
-
- /**
- * Change the way the debugger's windows are laid out.
- *
- * @param Layout See the presets above (e.g. <code>DEBUGGER_MICRO</code>, etc).
- */
- static public function setDebuggerLayout(Layout:uint):void
- {
- if(_game._debugger != null)
- _game._debugger.setLayout(Layout);
- }
-
- /**
- * Just resets the debugger windows to whatever the last selected layout was (<code>DEBUGGER_STANDARD</code> by default).
- */
- static public function resetDebuggerLayout():void
- {
- if(_game._debugger != null)
- _game._debugger.resetLayout();
- }
-
- /**
- * Add a new camera object to the game.
- * Handy for PiP, split-screen, etc.
- *
- * @param NewCamera The camera you want to add.
- *
- * @return This <code>FlxCamera</code> instance.
- */
- static public function addCamera(NewCamera:FlxCamera):FlxCamera
- {
- FlxG._game.addChildAt(NewCamera._flashBitmap,FlxG._game.getChildIndex(FlxG._game._mouse));
- FlxG.cameras.push(NewCamera);
- return NewCamera;
- }
-
- /**
- * Dumps all the current cameras and resets to just one camera.
- * Handy for doing split-screen especially.
- *
- * @param NewCamera Optional; specify a specific camera object to be the new main camera.
- */
- static public function resetCameras(NewCamera:FlxCamera=null):void
- {
- var cam:FlxCamera;
- var i:uint = 0;
- var l:uint = cameras.length;
- while(i < l)
- {
- cam = FlxG.cameras[i++] as FlxCamera;
- FlxG._game.removeChild(cam._flashBitmap);
- cam.destroy();
- }
- FlxG.cameras.length = 0;
-
- if(NewCamera == null)
- NewCamera = new FlxCamera(0,0,FlxG.width,FlxG.height)
- FlxG.camera = FlxG.addCamera(NewCamera);
- }
-
- /**
- * All screens are filled with this color and gradually return to normal.
- *
- * @param Color The color you want to use.
- * @param Duration How long it takes for the flash to fade.
- * @param OnComplete A function you want to run when the flash finishes.
- * @param Force Force the effect to reset.
- */
- static public function flash(Color:uint=0xffffffff, Duration:Number=1, OnComplete:Function=null, Force:Boolean=false):void
- {
- var i:uint = 0;
- var l:uint = FlxG.cameras.length;
- while(i < l)
- (FlxG.cameras[i++] as FlxCamera).flash(Color,Duration,OnComplete,Force);
- }
-
- /**
- * The screen is gradually filled with this color.
- *
- * @param Color The color you want to use.
- * @param Duration How long it takes for the fade to finish.
- * @param OnComplete A function you want to run when the fade finishes.
- * @param Force Force the effect to reset.
- */
- static public function fade(Color:uint=0xffffffff, Duration:Number=1, OnComplete:Function=null, Force:Boolean=false):void
- {
- var i:uint = 0;
- var l:uint = FlxG.cameras.length;
- while(i < l)
- (FlxG.cameras[i++] as FlxCamera).fade(Color,Duration,OnComplete,Force);
- }
-
- /**
- * A simple screen-shake effect.
- *
- * @param Intensity Percentage of screen size representing the maximum distance that the screen can move while shaking.
- * @param Duration The length in seconds that the shaking effect should last.
- * @param OnComplete A function you want to run when the shake effect finishes.
- * @param Force Force the effect to reset (default = true, unlike flash() and fade()!).
- * @param Direction Whether to shake on both axes, just up and down, or just side to side (use class constants SHAKE_BOTH_AXES, SHAKE_VERTICAL_ONLY, or SHAKE_HORIZONTAL_ONLY). Default value is SHAKE_BOTH_AXES (0).
- */
- static public function shake(Intensity:Number=0.05, Duration:Number=0.5, OnComplete:Function=null, Force:Boolean=true, Direction:uint=0):void
- {
- var i:uint = 0;
- var l:uint = FlxG.cameras.length;
- while(i < l)
- (FlxG.cameras[i++] as FlxCamera).shake(Intensity,Duration,OnComplete,Force,Direction);
- }
-
- /**
- * 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.
- */
- static public function get bgColor():uint
- {
- if(FlxG.camera == null)
- return 0xff000000;
- else
- return FlxG.camera.bgColor;
- }
-
- static public function set bgColor(Color:uint):void
- {
- var i:uint = 0;
- var l:uint = FlxG.cameras.length;
- while(i < l)
- (FlxG.cameras[i++] as FlxCamera).bgColor = Color;
- }
-
- /**
- * Call this function to see if one <code>FlxObject</code> 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 <code>FlxGroup</code> (or even bundling groups together!).
- *
- * <p>NOTE: does NOT take objects' scrollfactor into account, all overlaps are checked in world space.</p>
- *
- * @param ObjectOrGroup1 The first object or group you want to check.
- * @param ObjectOrGroup2 The second object or group you want to check. If it is the same as the first, flixel knows to just do a comparison within that group.
- * @param NotifyCallback A function with two <code>FlxObject</code> parameters - e.g. <code>myOverlapFunction(Object1:FlxObject,Object2:FlxObject)</code> - that is called if those two objects overlap.
- * @param ProcessCallback A function with two <code>FlxObject</code> parameters - e.g. <code>myOverlapFunction(Object1:FlxObject,Object2:FlxObject)</code> - that is called if those two objects overlap. If a ProcessCallback is provided, then NotifyCallback will only be called if ProcessCallback returns true for those objects!
- *
- * @return Whether any oevrlaps were detected.
- */
- static public function overlap(ObjectOrGroup1:FlxBasic=null,ObjectOrGroup2:FlxBasic=null,NotifyCallback:Function=null,ProcessCallback:Function=null):Boolean
- {
- if(ObjectOrGroup1 == null)
- ObjectOrGroup1 = FlxG.state;
- if(ObjectOrGroup2 === ObjectOrGroup1)
- ObjectOrGroup2 = null;
- FlxQuadTree.divisions = FlxG.worldDivisions;
- var quadTree:FlxQuadTree = new FlxQuadTree(FlxG.worldBounds.x,FlxG.worldBounds.y,FlxG.worldBounds.width,FlxG.worldBounds.height);
- quadTree.load(ObjectOrGroup1,ObjectOrGroup2,NotifyCallback,ProcessCallback);
- var result:Boolean = quadTree.execute();
- quadTree.destroy();
- return result;
- }
-
- /**
- * Call this function to see if one <code>FlxObject</code> 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 <code>FlxGroup</code> (or even bundling groups together!).
- *
- * <p>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.</p>
- *
- * <p>NOTE: does NOT take objects' scrollfactor into account, all overlaps are checked in world space.</p>
- *
- * @param ObjectOrGroup1 The first object or group you want to check.
- * @param ObjectOrGroup2 The second object or group you want to check. If it is the same as the first, flixel knows to just do a comparison within that group.
- * @param NotifyCallback A function with two <code>FlxObject</code> parameters - e.g. <code>myOverlapFunction(Object1:FlxObject,Object2:FlxObject)</code> - that is called if those two objects overlap.
- *
- * @return Whether any objects were successfully collided/separated.
- */
- static public function collide(ObjectOrGroup1:FlxBasic=null, ObjectOrGroup2:FlxBasic=null, NotifyCallback:Function=null):Boolean
- {
- return overlap(ObjectOrGroup1,ObjectOrGroup2,NotifyCallback,FlxObject.separate);
- }
-
- /**
- * Adds a new plugin to the global plugin array.
- *
- * @param Plugin Any object that extends FlxBasic. Useful for managers and other things. See org.flixel.plugin for some examples!
- *
- * @return The same <code>FlxBasic</code>-based plugin you passed in.
- */
- static public function addPlugin(Plugin:FlxBasic):FlxBasic
- {
- //Don't add repeats
- var pluginList:Array = FlxG.plugins;
- var i:uint = 0;
- var l:uint = pluginList.length;
- while(i < l)
- {
- if(pluginList[i++].toString() == Plugin.toString())
- return Plugin;
- }
-
- //no repeats! safe to add a new instance of this plugin
- pluginList.push(Plugin);
- return Plugin;
- }
-
- /**
- * Retrieves a plugin based on its class name from the global plugin array.
- *
- * @param ClassType The class name of the plugin you want to retrieve. See the <code>FlxPath</code> or <code>FlxTimer</code> constructors for example usage.
- *
- * @return The plugin object, or null if no matching plugin was found.
- */
- static public function getPlugin(ClassType:Class):FlxBasic
- {
- var pluginList:Array = FlxG.plugins;
- var i:uint = 0;
- var l:uint = pluginList.length;
- while(i < l)
- {
- if(pluginList[i++] is ClassType)
- return plugins[i];
- i++;
- }
- return null;
- }
-
- /**
- * Removes an instance of a plugin from the global plugin array.
- *
- * @param Plugin The plugin instance you want to remove.
- *
- * @return The same <code>FlxBasic</code>-based plugin you passed in.
- */
- static public function removePlugin(Plugin:FlxBasic):FlxBasic
- {
- //Don't add repeats
- var pluginList:Array = FlxG.plugins;
- var i:int = pluginList.length-1;
- while(i >= 0)
- {
- if(pluginList[i] == Plugin)
- pluginList.splice(i,1);
- i--;
- }
- return Plugin;
- }
-
- /**
- * Removes an instance of a plugin from the global plugin array.
- *
- * @param ClassType The class name of the plugin type you want removed from the array.
- *
- * @return Whether or not at least one instance of this plugin type was removed.
- */
- static public function removePluginType(ClassType:Class):Boolean
- {
- //Don't add repeats
- var results:Boolean = false;
- var pluginList:Array = FlxG.plugins;
- var i:int = pluginList.length-1;
- while(i >= 0)
- {
- if(pluginList[i] is ClassType)
- {
- pluginList.splice(i,1);
- results = true;
- }
- i--;
- }
- return results;
- }
-
- /**
- * Called by <code>FlxGame</code> to set up <code>FlxG</code> during <code>FlxGame</code>'s constructor.
- */
- static internal function init(Game:FlxGame,Width:uint,Height:uint,Zoom:Number):void
- {
- FlxG._game = Game;
- FlxG.width = Width;
- FlxG.height = Height;
-
- FlxG.mute = false;
- FlxG._volume = 0.5;
- FlxG.sounds = new FlxGroup();
- FlxG.volumeHandler = null;
-
- FlxG.clearBitmapCache();
-
- if(flashGfxSprite == null)
- {
- flashGfxSprite = new Sprite();
- flashGfx = flashGfxSprite.graphics;
- }
-
- FlxCamera.defaultZoom = Zoom;
- FlxG._cameraRect = new Rectangle();
- FlxG.cameras = new Array();
- useBufferLocking = false;
-
- plugins = new Array();
- addPlugin(new DebugPathDisplay());
- addPlugin(new TimerManager());
-
- FlxG.mouse = new Mouse(FlxG._game._mouse);
- FlxG.keys = new Keyboard();
- FlxG.mobile = false;
-
- FlxG.levels = new Array();
- FlxG.scores = new Array();
- FlxG.visualDebug = false;
- }
-
- /**
- * Called whenever the game is reset, doesn't have to do quite as much work as the basic initialization stuff.
- */
- static internal function reset():void
- {
- FlxG.clearBitmapCache();
- FlxG.resetInput();
- FlxG.destroySounds(true);
- FlxG.levels.length = 0;
- FlxG.scores.length = 0;
- FlxG.level = 0;
- FlxG.score = 0;
- FlxG.paused = false;
- FlxG.timeScale = 1.0;
- FlxG.elapsed = 0;
- FlxG.globalSeed = Math.random();
- FlxG.worldBounds = new FlxRect(-10,-10,FlxG.width+20,FlxG.height+20);
- FlxG.worldDivisions = 6;
- var debugPathDisplay:DebugPathDisplay = FlxG.getPlugin(DebugPathDisplay) as DebugPathDisplay;
- if(debugPathDisplay != null)
- debugPathDisplay.clear();
- }
-
- /**
- * Called by the game object to update the keyboard and mouse input tracking objects.
- */
- static internal function updateInput():void
- {
- FlxG.keys.update();
- if(!_game._debuggerUp || !_game._debugger.hasMouse)
- FlxG.mouse.update(FlxG._game.mouseX,FlxG._game.mouseY);
- }
-
- /**
- * Called by the game object to lock all the camera buffers and clear them for the next draw pass.
- */
- static internal function lockCameras():void
- {
- var cam:FlxCamera;
- var cams:Array = FlxG.cameras;
- var i:uint = 0;
- var l:uint = cams.length;
- while(i < l)
- {
- cam = cams[i++] as FlxCamera;
- if((cam == null) || !cam.exists || !cam.visible)
- continue;
- if(useBufferLocking)
- cam.buffer.lock();
- cam.fill();
- cam.screen.dirty = true;
- }
- }
-
- /**
- * Called by the game object to draw the special FX and unlock all the camera buffers.
- */
- static internal function unlockCameras():void
- {
- var cam:FlxCamera;
- var cams:Array = FlxG.cameras;
- var i:uint = 0;
- var l:uint = cams.length;
- while(i < l)
- {
- cam = cams[i++] as FlxCamera;
- if((cam == null) || !cam.exists || !cam.visible)
- continue;
- cam.drawFX();
- if(useBufferLocking)
- cam.buffer.unlock();
- }
- }
-
- /**
- * Called by the game object to update the cameras and their tracking/special effects logic.
- */
- static internal function updateCameras():void
- {
- var cam:FlxCamera;
- var cams:Array = FlxG.cameras;
- var i:uint = 0;
- var l:uint = cams.length;
- while(i < l)
- {
- cam = cams[i++] as FlxCamera;
- if((cam != null) && cam.exists)
- {
- if(cam.active)
- cam.update();
- cam._flashBitmap.x = cam.x;
- cam._flashBitmap.y = cam.y;
- cam._flashBitmap.visible = cam.exists && cam.visible;
- }
- }
- }
-
- /**
- * Used by the game object to call <code>update()</code> on all the plugins.
- */
- static internal function updatePlugins():void
- {
- var plugin:FlxBasic;
- var pluginList:Array = FlxG.plugins;
- var i:uint = 0;
- var l:uint = pluginList.length;
- while(i < l)
- {
- plugin = pluginList[i++] as FlxBasic;
- if(plugin.exists && plugin.active)
- plugin.update();
- }
- }
-
- /**
- * Used by the game object to call <code>draw()</code> on all the plugins.
- */
- static internal function drawPlugins():void
- {
- var plugin:FlxBasic;
- var pluginList:Array = FlxG.plugins;
- var i:uint = 0;
- var l:uint = pluginList.length;
- while(i < l)
- {
- plugin = pluginList[i++] as FlxBasic;
- if(plugin.exists && plugin.visible)
- plugin.draw();
- }
- }
- }
-}
+
+ /**
+ * This is a global helper class full of useful functions for audio,
+ * input, basic info, and the camera system among other things.
+ * Utilities for maths and color and things can be found in <code>FlxU</code>.
+ * <code>FlxG</code> is specifically for Flixel-specific properties.
+ *
+ * @author Adam Atomic
+ */
+ public class FlxG
+ {
+ /**
+ * If you build and maintain your own version of flixel,
+ * you can give it your own name here.
+ */
+ static public var LIBRARY_NAME:String = "flixel";
+ /**
+ * Assign a major version to your library.
+ * Appears before the decimal in the console.
+ */
+ static public var LIBRARY_MAJOR_VERSION:uint = 2;
+ /**
+ * Assign a minor version to your library.
+ * Appears after the decimal in the console.
+ */
+ static public var LIBRARY_MINOR_VERSION:uint = 51;
+
+ /**
+ * Debugger overlay layout preset: Wide but low windows at the bottom of the screen.
+ */
+ static public const DEBUGGER_STANDARD:uint = 0;
+ /**
+ * Debugger overlay layout preset: Tiny windows in the screen corners.
+ */
+ static public const DEBUGGER_MICRO:uint = 1;
+ /**
+ * Debugger overlay layout preset: Large windows taking up bottom half of screen.
+ */
+ static public const DEBUGGER_BIG:uint = 2;
+ /**
+ * Debugger overlay layout preset: Wide but low windows at the top of the screen.
+ */
+ static public const DEBUGGER_TOP:uint = 3;
+ /**
+ * Debugger overlay layout preset: Large windows taking up left third of screen.
+ */
+ static public const DEBUGGER_LEFT:uint = 4;
+ /**
+ * Debugger overlay layout preset: Large windows taking up right third of screen.
+ */
+ static public const DEBUGGER_RIGHT:uint = 5;
+
+ /**
+ * 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.
+ */
+ static public const RED:uint = 0xffff0012;
+ /**
+ * Green is used to indicate solid but immovable objects.
+ */
+ static public const GREEN:uint = 0xff00f225;
+ /**
+ * Blue is used to indicate non-solid objects.
+ */
+ static public const BLUE:uint = 0xff0090e9;
+ /**
+ * Pink is used to indicate objects that are only partially solid, like one-way platforms.
+ */
+ static public const PINK:uint = 0xfff01eff;
+ /**
+ * White... for white stuff.
+ */
+ static public const WHITE:uint = 0xffffffff;
+ /**
+ * And black too.
+ */
+ static public const BLACK:uint = 0xff000000;
+
+ /**
+ * Internal tracker for game object.
+ */
+ static internal var _game:FlxGame;
+ /**
+ * Handy shared variable for implementing your own pause behavior.
+ */
+ static public var paused:Boolean;
+ /**
+ * Whether you are running in Debug or Release mode.
+ * Set automatically by <code>FlxPreloader</code> during startup.
+ */
+ static public var debug:Boolean;
+
+ /**
+ * Represents the amount of time in seconds that passed since last frame.
+ */
+ static public var elapsed:Number;
+ /**
+ * How fast or slow time should pass in the game; default is 1.0.
+ */
+ static public var timeScale:Number;
+ /**
+ * The width of the screen in game pixels.
+ */
+ static public var width:uint;
+ /**
+ * The height of the screen in game pixels.
+ */
+ static public var height:uint;
+ /**
+ * The dimensions of the game world, used by the quad tree for collisions and overlap checks.
+ */
+ static public var worldBounds:FlxRect;
+ /**
+ * 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.
+ */
+ static public var worldDivisions:uint;
+ /**
+ * Whether to show visual debug displays or not.
+ * Default = false.
+ */
+ static public var visualDebug:Boolean;
+ /**
+ * Setting this to true will disable/skip stuff that isn't necessary for mobile platforms like Android. [BETA]
+ */
+ static public var mobile:Boolean;
+ /**
+ * The global random number generator seed (for deterministic behavior in recordings and saves).
+ */
+ static public var globalSeed:Number;
+ /**
+ * <code>FlxG.levels</code> and <code>FlxG.scores</code> are generic
+ * global variables that can be used for various cross-state stuff.
+ */
+ static public var levels:Array;
+ static public var level:int;
+ static public var scores:Array;
+ static public var score:int;
+ /**
+ * <code>FlxG.saves</code> is a generic bucket for storing
+ * FlxSaves so you can access them whenever you want.
+ */
+ static public var saves:Array;
+ static public var save:int;
+
+ /**
+ * A reference to a <code>FlxMouse</code> object. Important for input!
+ */
+ static public var mouse:Mouse;
+ /**
+ * A reference to a <code>FlxKeyboard</code> object. Important for input!
+ */
+ static public var keys:Keyboard;
+
+ /**
+ * A handy container for a background music object.
+ */
+ static public var music:FlxSound;
+ /**
+ * A list of all the sounds being played in the game.
+ */
+ static public var sounds:FlxGroup;
+ /**
+ * Whether or not the game sounds are muted.
+ */
+ static public var mute:Boolean;
+ /**
+ * Internal volume level, used for global sound control.
+ */
+ static protected var _volume:Number;
+
+ /**
+ * An array of <code>FlxCamera</code> objects that are used to draw stuff.
+ * By default flixel creates one camera the size of the screen.
+ */
+ static public var cameras:Array;
+ /**
+ * By default this just refers to the first entry in the cameras array
+ * declared above, but you can do what you like with it.
+ */
+ static public var camera:FlxCamera;
+ /**
+ * Allows you to possibly slightly optimize the rendering process IF
+ * you are not doing any pre-processing in your game state's <code>draw()</code> call.
+ * @default false
+ */
+ static public var useBufferLocking:Boolean;
+ /**
+ * Internal helper variable for clearing the cameras each frame.
+ */
+ static protected var _cameraRect:Rectangle;
+
+ /**
+ * An array container for plugins.
+ * By default flixel uses a couple of plugins:
+ * DebugPathDisplay, and TimerManager.
+ */
+ static public var plugins:Array;
+
+ /**
+ * Set this hook to get a callback whenever the volume changes.
+ * Function should take the form <code>myVolumeHandler(Volume:Number)</code>.
+ */
+ static public var volumeHandler:Function;
+
+ /**
+ * Useful helper objects for doing Flash-specific rendering.
+ * Primarily used for "debug visuals" like drawing bounding boxes directly to the screen buffer.
+ */
+ static public var flashGfxSprite:Sprite;
+ static public var flashGfx:Graphics;
+
+ /**
+ * Internal storage system to prevent graphics from being used repeatedly in memory.
+ */
+ static protected var _cache:Object;
+
+ static public function getLibraryName():String
+ {
+ return FlxG.LIBRARY_NAME + " v" + FlxG.LIBRARY_MAJOR_VERSION + "." + FlxG.LIBRARY_MINOR_VERSION;
+ }
+
+ /**
+ * Log data to the debugger.
+ *
+ * @param Data Anything you want to log to the console.
+ */
+ static public function log(Data:Object):void
+ {
+ if((_game != null) && (_game._debugger != null))
+ _game._debugger.log.add((Data == null)?"ERROR: null object":Data.toString());
+ }
+
+ /**
+ * Add a variable to the watch list in the debugger.
+ * This lets you see the value of the variable all the time.
+ *
+ * @param AnyObject A reference to any object in your game, e.g. Player or Robot or this.
+ * @param VariableName The name of the variable you want to watch, in quotes, as a string: e.g. "speed" or "health".
+ * @param DisplayName Optional, display your own string instead of the class name + variable name: e.g. "enemy count".
+ */
+ static public function watch(AnyObject:Object,VariableName:String,DisplayName:String=null):void
+ {
+ if((_game != null) && (_game._debugger != null))
+ _game._debugger.watch.add(AnyObject,VariableName,DisplayName);
+ }
+
+ /**
+ * 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.
+ *
+ * @param AnyObject A reference to any object in your game, e.g. Player or Robot or this.
+ * @param VariableName The name of the variable you want to watch, in quotes, as a string: e.g. "speed" or "health".
+ */
+ static public function unwatch(AnyObject:Object,VariableName:String=null):void
+ {
+ if((_game != null) && (_game._debugger != null))
+ _game._debugger.watch.remove(AnyObject,VariableName);
+ }
+
+ /**
+ * 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!
+ */
+ static public function get framerate():Number
+ {
+ return 1000/_game._step;
+ }
+
+ /**
+ * @private
+ */
+ static public function set framerate(Framerate:Number):void
+ {
+ _game._step = 1000/Framerate;
+ if(_game._maxAccumulation < _game._step)
+ _game._maxAccumulation = _game._step;
+ }
+
+ /**
+ * 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!
+ */
+ static public function get flashFramerate():Number
+ {
+ if(_game.root != null)
+ return _game.stage.frameRate;
+ else
+ return 0;
+ }
+
+ /**
+ * @private
+ */
+ static public function set flashFramerate(Framerate:Number):void
+ {
+ _game._flashFramerate = Framerate;
+ if(_game.root != null)
+ _game.stage.frameRate = _game._flashFramerate;
+ _game._maxAccumulation = 2000/_game._flashFramerate - 1;
+ if(_game._maxAccumulation < _game._step)
+ _game._maxAccumulation = _game._step;
+ }
+
+ /**
+ * Generates a random number. Deterministic, meaning safe
+ * to use if you want to record replays in random environments.
+ *
+ * @return A <code>Number</code> between 0 and 1.
+ */
+ static public function random():Number
+ {
+ return globalSeed = FlxU.srand(globalSeed);
+ }
+
+ /**
+ * Shuffles the entries in an array into a new random order.
+ * <code>FlxG.shuffle()</code> is deterministic and safe for use with replays/recordings.
+ * HOWEVER, <code>FlxU.shuffle()</code> is NOT deterministic and unsafe for use with replays/recordings.
+ *
+ * @param A A Flash <code>Array</code> object containing...stuff.
+ * @param HowManyTimes How many swaps to perform during the shuffle operation. Good rule of thumb is 2-4 times as many objects are in the list.
+ *
+ * @return The same Flash <code>Array</code> object that you passed in in the first place.
+ */
+ static public function shuffle(Objects:Array,HowManyTimes:uint):Array
+ {
+ var i:uint = 0;
+ var index1:uint;
+ var index2:uint;
+ var object:Object;
+ while(i < HowManyTimes)
+ {
+ index1 = FlxG.random()*Objects.length;
+ index2 = FlxG.random()*Objects.length;
+ object = Objects[index2];
+ Objects[index2] = Objects[index1];
+ Objects[index1] = object;
+ i++;
+ }
+ return Objects;
+ }
+
+ /**
+ * Fetch a random entry from the given array.
+ * Will return null if random selection is missing, or array has no entries.
+ * <code>FlxG.getRandom()</code> is deterministic and safe for use with replays/recordings.
+ * HOWEVER, <code>FlxU.getRandom()</code> is NOT deterministic and unsafe for use with replays/recordings.
+ *
+ * @param Objects A Flash array of objects.
+ *
+ * @return The random object that was selected.
+ */
+ static public function getRandom(Objects:Array):Object
+ {
+ if(Objects != null)
+ {
+ var l:uint = Objects.length;
+ if(l > 0)
+ return Objects[uint(FlxG.random()*l)];
+ }
+ return null;
+ }
+
+ /**
+ * Load replay data from a string and play it back.
+ *
+ * @param Data The replay that you want to load.
+ * @param State Optional parameter: if you recorded a state-specific demo or cutscene, pass a new instance of that state here.
+ * @param CancelKeys Optional parameter: an array of string names of keys (see FlxKeyboard) that can be pressed to cancel the playback, e.g. ["ESCAPE","ENTER"]. Also accepts 2 custom key names: "ANY" and "MOUSE" (fairly self-explanatory I hope!).
+ * @param Timeout Optional parameter: set a time limit for the replay. CancelKeys will override this if pressed.
+ * @param Callback Optional parameter: if set, called when the replay finishes. Running to the end, CancelKeys, and Timeout will all trigger Callback(), but only once, and CancelKeys and Timeout will NOT call FlxG.stopReplay() if Callback is set!
+ */
+ static public function loadReplay(Data:String,State:FlxState=null,CancelKeys:Array=null,Timeout:Number=0,Callback:Function=null):void
+ {
+ _game._replay.load(Data);
+ if(State == null)
+ FlxG.resetGame();
+ else
+ FlxG.switchState(State);
+ _game._replayCancelKeys = CancelKeys;
+ _game._replayTimer = Timeout*1000;
+ _game._replayCallback = Callback;
+ _game._replayRequested = true;
+ }
+
+ /**
+ * Resets the game or state and replay requested flag.
+ *
+ * @param StandardMode If true, reload entire game, else just reload current game state.
+ */
+ static public function reloadReplay(StandardMode:Boolean=true):void
+ {
+ if(StandardMode)
+ FlxG.resetGame();
+ else
+ FlxG.resetState();
+ if(_game._replay.frameCount > 0)
+ _game._replayRequested = true;
+ }
+
+ /**
+ * Stops the current replay.
+ */
+ static public function stopReplay():void
+ {
+ _game._replaying = false;
+ if(_game._debugger != null)
+ _game._debugger.vcr.stopped();
+ resetInput();
+ }
+
+ /**
+ * Resets the game or state and requests a new recording.
+ *
+ * @param StandardMode If true, reset the entire game, else just reset the current state.
+ */
+ static public function recordReplay(StandardMode:Boolean=true):void
+ {
+ if(StandardMode)
+ FlxG.resetGame();
+ else
+ FlxG.resetState();
+ _game._recordingRequested = true;
+ }
+
+ /**
+ * Stop recording the current replay and return the replay data.
+ *
+ * @return The replay data in simple ASCII format (see <code>FlxReplay.save()</code>).
+ */
+ static public function stopRecording():String
+ {
+ _game._recording = false;
+ if(_game._debugger != null)
+ _game._debugger.vcr.stopped();
+ return _game._replay.save();
+ }
+
+ /**
+ * Request a reset of the current game state.
+ */
+ static public function resetState():void
+ {
+ _game._requestedState = new (FlxU.getClass(FlxU.getClassName(_game._state,false)))();
+ }
+
+ /**
+ * Like hitting the reset button on a game console, this will re-launch the game as if it just started.
+ */
+ static public function resetGame():void
+ {
+ _game._requestedReset = true;
+ }
+
+ /**
+ * Reset the input helper objects (useful when changing screens or states)
+ */
+ static public function resetInput():void
+ {
+ keys.reset();
+ mouse.reset();
+ }
+
+ /**
+ * Set up and play a looping background soundtrack.
+ *
+ * @param Music The sound file you want to loop in the background.
+ * @param Volume How loud the sound should be, from 0 to 1.
+ */
+ static public function playMusic(Music:Class,Volume:Number=1.0):void
+ {
+ if(music == null)
+ music = new FlxSound();
+ else if(music.active)
+ music.stop();
+ music.loadEmbedded(Music,true);
+ music.volume = Volume;
+ music.survive = true;
+ music.play();
+ }
+
+ /**
+ * Creates a new sound object from an embedded <code>Class</code> object.
+ *
+ * @param EmbeddedSound The sound you want to play.
+ * @param Volume How loud to play it (0 to 1).
+ * @param Looped Whether or not to loop this sound.
+ *
+ * @return A <code>FlxSound</code> object.
+ */
+ static public function play(EmbeddedSound:Class,Volume:Number=1.0,Looped:Boolean=false):FlxSound
+ {
+ var sound:FlxSound = sounds.recycle(FlxSound) as FlxSound;
+ sound.loadEmbedded(EmbeddedSound,Looped);
+ sound.volume = Volume;
+ sound.play();
+ return sound;
+ }
+
+ /**
+ * Creates a new sound object from a URL.
+ *
+ * @param URL The URL of the sound you want to play.
+ * @param Volume How loud to play it (0 to 1).
+ * @param Looped Whether or not to loop this sound.
+ *
+ * @return A FlxSound object.
+ */
+ static public function stream(URL:String,Volume:Number=1.0,Looped:Boolean=false):FlxSound
+ {
+ var sound:FlxSound = sounds.recycle(FlxSound) as FlxSound;
+ sound.loadStream(URL,Looped);
+ sound.volume = Volume;
+ sound.play();
+ return sound;
+ }
+
+ /**
+ * Set <code>volume</code> to a number between 0 and 1 to change the global volume.
+ *
+ * @default 0.5
+ */
+ static public function get volume():Number
+ {
+ return _volume;
+ }
+
+ /**
+ * @private
+ */
+ static public function set volume(Volume:Number):void
+ {
+ _volume = Volume;
+ if(_volume < 0)
+ _volume = 0;
+ else if(_volume > 1)
+ _volume = 1;
+ if(volumeHandler != null)
+ volumeHandler(FlxG.mute?0:_volume);
+ }
+
+ /**
+ * Called by FlxGame on state changes to stop and destroy sounds.
+ *
+ * @param ForceDestroy Kill sounds even if they're flagged <code>survive</code>.
+ */
+ static internal function destroySounds(ForceDestroy:Boolean=false):void
+ {
+ if((music != null) && (ForceDestroy || !music.survive))
+ {
+ music.destroy();
+ music = null;
+ }
+ var i:uint = 0;
+ var sound:FlxSound;
+ var l:uint = sounds.members.length;
+ while(i < l)
+ {
+ sound = sounds.members[i++] as FlxSound;
+ if((sound != null) && (ForceDestroy || !sound.survive))
+ sound.destroy();
+ }
+ }
+
+ /**
+ * Called by the game loop to make sure the sounds get updated each frame.
+ */
+ static internal function updateSounds():void
+ {
+ if((music != null) && music.active)
+ music.update();
+ if((sounds != null) && sounds.active)
+ sounds.update();
+ }
+
+ /**
+ * Pause all sounds currently playing.
+ */
+ static public function pauseSounds():void
+ {
+ if((music != null) && music.exists && music.active)
+ music.pause();
+ var i:uint = 0;
+ var sound:FlxSound;
+ var l:uint = sounds.members.length;
+ while(i < l)
+ {
+ sound = sounds.members[i++] as FlxSound;
+ if((sound != null) && sound.exists && sound.active)
+ sound.pause();
+ }
+ }
+
+ /**
+ * Resume playing existing sounds.
+ */
+ static public function playSounds():void
+ {
+ if((music != null) && music.exists)
+ music.play();
+ var i:uint = 0;
</