package com.ratalaika.Flixel.system.debug { import flash.display.Bitmap; import flash.display.BitmapData; import flash.display.Sprite; import flash.events.Event; import flash.events.IOErrorEvent; import flash.events.MouseEvent; import flash.net.FileFilter; import flash.net.FileReference; import flash.text.TextField; import flash.text.TextFormat; import flash.utils.ByteArray; import com.ratalaika.Flixel.FlxG; import com.ratalaika.Flixel.FlxU; import com.ratalaika.Flixel.system.FlxReplay; import com.ratalaika.Flixel.system.replay.FrameRecord; import com.ratalaika.Flixel.system.replay.MouseRecord; /** * This class contains the record, stop, play, and step 1 frame buttons seen on the top edge of the debugger overlay. * * @author Adam Atomic */ public class VCR extends Sprite { [Embed(source="../../data/vcr/open.png")] protected var ImgOpen:Class; [Embed(source="../../data/vcr/record_off.png")] protected var ImgRecordOff:Class; [Embed(source="../../data/vcr/record_on.png")] protected var ImgRecordOn:Class; [Embed(source="../../data/vcr/stop.png")] protected var ImgStop:Class; [Embed(source="../../data/vcr/Flixel.png")] protected var ImgFlixel:Class; [Embed(source="../../data/vcr/restart.png")] protected var ImgRestart:Class; [Embed(source="../../data/vcr/pause.png")] protected var ImgPause:Class; [Embed(source="../../data/vcr/play.png")] protected var ImgPlay:Class; [Embed(source="../../data/vcr/step.png")] protected var ImgStep:Class; static protected const FILE_TYPES:Array = [new FileFilter("Flixel Game Recording", "*.fgr")]; static protected const DEFAULT_FILE_NAME:String = "replay.fgr"; /** * Whether the debugger has been paused. */ public var paused:Boolean; /** * Whether a "1 frame step forward" was requested. */ public var stepRequested:Boolean; protected var _open:Bitmap; protected var _recordOff:Bitmap; protected var _recordOn:Bitmap; protected var _stop:Bitmap; protected var _flixel:Bitmap; protected var _restart:Bitmap; protected var _pause:Bitmap; protected var _play:Bitmap; protected var _step:Bitmap; protected var _overOpen:Boolean; protected var _overRecord:Boolean; protected var _overRestart:Boolean; protected var _overPause:Boolean; protected var _overStep:Boolean; protected var _pressingOpen:Boolean; protected var _pressingRecord:Boolean; protected var _pressingRestart:Boolean; protected var _pressingPause:Boolean; protected var _pressingStep:Boolean; protected var _file:FileReference; protected var _runtimeDisplay:TextField; protected var _runtime:uint; /** * Creates the "VCR" control panel for debugger pausing, stepping, and recording. */ public function VCR() { super(); var spacing:uint = 7; _open = new ImgOpen(); addChild(_open); _recordOff = new ImgRecordOff(); _recordOff.x = _open.x + _open.width + spacing; addChild(_recordOff); _recordOn = new ImgRecordOn(); _recordOn.x = _recordOff.x; _recordOn.visible = false; addChild(_recordOn); _stop = new ImgStop(); _stop.x = _recordOff.x; _stop.visible = false; addChild(_stop); _flixel = new ImgFlixel(); _flixel.x = _recordOff.x + _recordOff.width + spacing; addChild(_flixel); _restart = new ImgRestart(); _restart.x = _flixel.x + _flixel.width + spacing; addChild(_restart); _pause = new ImgPause(); _pause.x = _restart.x + _restart.width + spacing; addChild(_pause); _play = new ImgPlay(); _play.x = _pause.x; _play.visible = false; addChild(_play); _step = new ImgStep(); _step.x = _pause.x + _pause.width + spacing; addChild(_step); _runtimeDisplay = new TextField(); _runtimeDisplay.width = width; _runtimeDisplay.x = width; _runtimeDisplay.y = -2; _runtimeDisplay.multiline = false; _runtimeDisplay.wordWrap = false; _runtimeDisplay.selectable = false; _runtimeDisplay.defaultTextFormat = new TextFormat("Courier",12,0xffffff,null,null,null,null,null,"center"); _runtimeDisplay.visible = false; addChild(_runtimeDisplay); _runtime = 0; stepRequested = false; _file = null; unpress(); checkOver(); updateGUI(); addEventListener(Event.ENTER_FRAME,init); } /** * Clean up memory. */ public function destroy():void { _file = null; if (_open) removeChild(_open); _open = null; if (_recordOff) removeChild(_recordOff); _recordOff = null; if (_recordOn) removeChild(_recordOn); _recordOn = null; if (_stop) removeChild(_stop); _stop = null; if (_flixel) removeChild(_flixel); _flixel = null; if (_restart) removeChild(_restart); _restart = null; if (_pause) removeChild(_pause); _pause = null; if (_play) removeChild(_play); _play = null; if (_step) removeChild(_step); _step = null; if (parent) { parent.removeEventListener(MouseEvent.MOUSE_MOVE,handleMouseMove); parent.removeEventListener(MouseEvent.MOUSE_DOWN,handleMouseDown); parent.removeEventListener(MouseEvent.MOUSE_UP,handleMouseUp); } } /** * Usually called by FlxGame when a requested recording has begun. * Just updates the VCR GUI so the buttons are in the right state. */ public function recording():void { _stop.visible = false; _recordOff.visible = false; _recordOn.visible = true; } /** * Usually called by FlxGame when a replay has been stopped. * Just updates the VCR GUI so the buttons are in the right state. */ public function stopped():void { _stop.visible = false; _recordOn.visible = false; _recordOff.visible = true; } /** * Usually called by FlxGame when a requested replay has begun. * Just updates the VCR GUI so the buttons are in the right state. */ public function playing():void { _recordOff.visible = false; _recordOn.visible = false; _stop.visible = true; } /** * Just updates the VCR GUI so the runtime displays roughly the right thing. */ public function updateRuntime(Time:uint):void { _runtime += Time; _runtimeDisplay.text = FlxU.formatTime(_runtime/1000,true); if(!_runtimeDisplay.visible) _runtimeDisplay.visible = true; } //*** ACTUAL BUTTON BEHAVIORS ***// /** * Called when the "open file" button is pressed. * Opens the file dialog and registers event handlers for the file dialog. */ public function onOpen():void { _file = new FileReference(); _file.addEventListener(Event.SELECT, onOpenSelect); _file.addEventListener(Event.CANCEL, onOpenCancel); _file.browse(FILE_TYPES); } /** * Called when a file is picked from the file dialog. * Attempts to load the file and registers file loading event handlers. * * @param E Flash event. */ protected function onOpenSelect(E:Event=null):void { _file.removeEventListener(Event.SELECT, onOpenSelect); _file.removeEventListener(Event.CANCEL, onOpenCancel); _file.addEventListener(Event.COMPLETE, onOpenComplete); _file.addEventListener(IOErrorEvent.IO_ERROR, onOpenError); _file.load(); } /** * Called when a file is opened successfully. * If there's stuff inside, then the contents are loaded into a new replay. * * @param E Flash Event. */ protected function onOpenComplete(E:Event=null):void { _file.removeEventListener(Event.COMPLETE, onOpenComplete); _file.removeEventListener(IOErrorEvent.IO_ERROR, onOpenError); //Turn the file into a giant string var fileContents:String = null; var data:ByteArray = _file.data; if(data !== null) fileContents = data.readUTFBytes(data.bytesAvailable); _file = null; if((fileContents === null) || (fileContents.length <= 0)) { FlxG.log("ERROR: Empty flixel gameplay record."); return; } FlxG.loadReplay(fileContents); } /** * Called if the open file dialog is canceled. * * @param E Flash Event. */ protected function onOpenCancel(E:Event=null):void { _file.removeEventListener(Event.SELECT, onOpenSelect); _file.removeEventListener(Event.CANCEL, onOpenCancel); _file = null; } /** * Called if there is a file open error. * * @param E Flash Event. */ protected function onOpenError(E:Event=null):void { _file.removeEventListener(Event.COMPLETE, onOpenComplete); _file.removeEventListener(IOErrorEvent.IO_ERROR, onOpenError); _file = null; FlxG.log("ERROR: Unable to open flixel gameplay record."); } /** * Called when the user presses the white record button. * If Alt is pressed, the current state is reset, and a new recording is requested. * If Alt is NOT pressed, the game is reset, and a new recording is requested. * * @param StandardMode Whether to reset the whole game, or just this FlxState. StandardMode == false is useful for recording demos or attract modes. */ public function onRecord(StandardMode:Boolean=false):void { if(_play.visible) onPlay(); FlxG.recordReplay(StandardMode); } /** * Called when the user presses the red record button. * Stops the current recording, opens the save file dialog, and registers event handlers. */ public function stopRecording():void { var data:String = FlxG.stopRecording(); if((data !== null) && (data.length > 0)) { _file = new FileReference(); _file.addEventListener(Event.COMPLETE, onSaveComplete); _file.addEventListener(Event.CANCEL,onSaveCancel); _file.addEventListener(IOErrorEvent.IO_ERROR, onSaveError); _file.save(data, DEFAULT_FILE_NAME); } } /** * Called when the file is saved successfully. * * @param E Flash Event. */ protected function onSaveComplete(E:Event=null):void { _file.removeEventListener(Event.COMPLETE, onSaveComplete); _file.removeEventListener(Event.CANCEL,onSaveCancel); _file.removeEventListener(IOErrorEvent.IO_ERROR, onSaveError); _file = null; FlxG.log("FLIXEL: successfully saved flixel gameplay record."); } /** * Called when the save file dialog is cancelled. * * @param E Flash Event. */ protected function onSaveCancel(E:Event=null):void { _file.removeEventListener(Event.COMPLETE, onSaveComplete); _file.removeEventListener(Event.CANCEL,onSaveCancel); _file.removeEventListener(IOErrorEvent.IO_ERROR, onSaveError); _file = null; } /** * Called if there is an error while saving the gameplay recording. * * @param E Flash Event. */ protected function onSaveError(E:Event=null):void { _file.removeEventListener(Event.COMPLETE, onSaveComplete); _file.removeEventListener(Event.CANCEL,onSaveCancel); _file.removeEventListener(IOErrorEvent.IO_ERROR, onSaveError); _file = null; FlxG.log("ERROR: problem saving flixel gameplay record."); } /** * Called when the user presses the stop button. * Stops the current replay. */ public function onStop():void { FlxG.stopReplay(); } /** * Called when the user presses the Rewind-looking button. * If Alt is pressed, the entire game is reset. * If Alt is NOT pressed, only the current state is reset. * The GUI is updated accordingly. * * @param StandardMode Whether to reset the current game (== true), or just the current state. Just resetting the current state can be very handy for debugging. */ public function onRestart(StandardMode:Boolean=false):void { if(FlxG.reloadReplay(StandardMode)) { _recordOff.visible = false; _recordOn.visible = false; _stop.visible = true; } } /** * Called when the user presses the Pause button. * This is different from user-defined pause behavior, or focus lost behavior. * Does NOT pause music playback!! */ public function onPause():void { paused = true; _pause.visible = false; _play.visible = true; } /** * Called when the user presses the Play button. * This is different from user-defined unpause behavior, or focus gained behavior. */ public function onPlay():void { paused = false; _play.visible = false; _pause.visible = true; } /** * Called when the user presses the fast-forward-looking button. * Requests a 1-frame step forward in the game loop. */ public function onStep():void { if(!paused) onPause(); stepRequested = true; } //***EVENT HANDLERS***// /** * Just sets up basic mouse listeners, a la FlxWindow. * * @param E Flash event. */ protected function init(E:Event=null):void { if(root === null) return; removeEventListener(Event.ENTER_FRAME,init); parent.addEventListener(MouseEvent.MOUSE_MOVE,handleMouseMove); parent.addEventListener(MouseEvent.MOUSE_DOWN,handleMouseDown); parent.addEventListener(MouseEvent.MOUSE_UP,handleMouseUp); } /** * If the mouse moves, check to see if any buttons should be highlighted. * * @param E Flash mouse event. */ protected function handleMouseMove(E:MouseEvent=null):void { if(!checkOver()) unpress(); updateGUI(); } /** * If the mouse is pressed down, check to see if the user started pressing down a specific button. * * @param E Flash mouse event. */ protected function handleMouseDown(E:MouseEvent=null):void { unpress(); if(_overOpen) _pressingOpen = true; if(_overRecord) _pressingRecord = true; if(_overRestart) _pressingRestart = true; if(_overPause) _pressingPause = true; if(_overStep) _pressingStep = true; } /** * If the mouse is released, check to see if it was released over a button that was pressed. * If it was, take the appropriate action based on button state and visibility. * * @param E Flash mouse event. */ protected function handleMouseUp(E:MouseEvent=null):void { if(_overOpen && _pressingOpen) onOpen(); else if(_overRecord && _pressingRecord) { if(_stop.visible) onStop(); else if(_recordOn.visible) stopRecording(); else onRecord(!E.altKey); } else if(_overRestart && _pressingRestart) onRestart(!E.altKey); else if(_overPause && _pressingPause) { if(_play.visible) onPlay(); else onPause(); } else if(_overStep && _pressingStep) onStep(); unpress(); checkOver(); updateGUI(); } //***MISC GUI MGMT STUFF***// /** * This function checks to see what button the mouse is currently over. * Has some special behavior based on whether a recording is happening or not. * * @return Whether the mouse was over any buttons or not. */ protected function checkOver():Boolean { _overOpen = _overRecord = _overRestart = _overPause = _overStep = false; if((mouseX < 0) || (mouseX > width) || (mouseY < 0) || (mouseY > 15)) return false; if((mouseX >= _recordOff.x) && (mouseX <= _recordOff.x + _recordOff.width)) _overRecord = true; if(!_recordOn.visible && !_overRecord) { if((mouseX >= _open.x) && (mouseX <= _open.x + _open.width)) _overOpen = true; else if((mouseX >= _restart.x) && (mouseX <= _restart.x + _restart.width)) _overRestart = true; else if((mouseX >= _pause.x) && (mouseX <= _pause.x + _pause.width)) _overPause = true; else if((mouseX >= _step.x) && (mouseX <= _step.x + _step.width)) _overStep = true; } return true; } /** * Sets all the pressed state variables for the buttons to false. */ protected function unpress():void { _pressingOpen = false; _pressingRecord = false; _pressingRestart = false; _pressingPause = false; _pressingStep = false; } /** * Figures out what buttons to highlight based on the _overWhatever and _pressingWhatever variables. */ protected function updateGUI():void { if(_recordOn.visible) { _open.alpha = _restart.alpha = _pause.alpha = _step.alpha = 0.35; _recordOn.alpha = 1.0; return; } if(_overOpen && (_open.alpha != 1.0)) _open.alpha = 1.0; else if(!_overOpen && (_open.alpha !== 0.8)) _open.alpha = 0.8; if(_overRecord && (_recordOff.alpha != 1.0)) _recordOff.alpha = _recordOn.alpha = _stop.alpha = 1.0; else if(!_overRecord && (_recordOff.alpha !== 0.8)) _recordOff.alpha = _recordOn.alpha = _stop.alpha = 0.8; if(_overRestart && (_restart.alpha != 1.0)) _restart.alpha = 1.0; else if(!_overRestart && (_restart.alpha !== 0.8)) _restart.alpha = 0.8; if(_overPause && (_pause.alpha != 1.0)) _pause.alpha = _play.alpha = 1.0; else if(!_overPause && (_pause.alpha !== 0.8)) _pause.alpha = _play.alpha = 0.8; if(_overStep && (_step.alpha != 1.0)) _step.alpha = 1.0; else if(!_overStep && (_step.alpha !== 0.8)) _step.alpha = 0.8; } } }