Add SignalFrontEnd.preGameStart (#2188)

HaxeFlixel · Nov 21, 2018 · 25198ae · 25198ae
1 parent 4e2c026
commit 25198ae
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/flixel/FlxGame.hx b/flixel/FlxGame.hx
@@ -88,7 +88,7 @@ class FlxGame extends Sprite
 	public var filtersEnabled:Bool = true;
 
 	/**
-	 * A flag for triggering the `gameStarted` "event".
+	 * A flag for triggering the `preGameStart` and `postGameStart` "events".
 	 */
 	@:allow(flixel.system.FlxSplash)
 	var _gameJustStarted:Bool = false;
@@ -622,6 +622,9 @@ class FlxGame extends Sprite
 		// Finally assign and create the new state
 		_state = _requestedState;
 
+		if (_gameJustStarted)
+			FlxG.signals.preGameStart.dispatch();
+
 		FlxG.signals.preStateCreate.dispatch(_state);
 
 		_state.create();
@@ -636,7 +639,7 @@ class FlxGame extends Sprite
 
 	function gameStart():Void
 	{
-		FlxG.signals.gameStarted.dispatch();
+		FlxG.signals.postGameStart.dispatch();
 		_gameJustStarted = false;
 	}
 

diff --git a/flixel/input/mouse/FlxMouse.hx b/flixel/input/mouse/FlxMouse.hx
@@ -375,7 +375,7 @@ class FlxMouse extends FlxPointer implements IFlxInputManager
 		#end
 
 		_cursorBitmapData = FlxDestroyUtil.dispose(_cursorBitmapData);
-		FlxG.signals.gameStarted.remove(onGameStart);
+		FlxG.signals.postGameStart.remove(onGameStart);
 	}
 
 	/**
@@ -422,7 +422,7 @@ class FlxMouse extends FlxPointer implements IFlxInputManager
 
 		_stage.addEventListener(MouseEvent.MOUSE_WHEEL, onMouseWheel);
 
-		FlxG.signals.gameStarted.add(onGameStart);
+		FlxG.signals.postGameStart.add(onGameStart);
 		Mouse.hide();
 	}
 

diff --git a/flixel/system/frontEnds/SignalFrontEnd.hx b/flixel/system/frontEnds/SignalFrontEnd.hx
@@ -16,10 +16,16 @@ class SignalFrontEnd
 	public var gameResized(default, null):FlxTypedSignal<Int->Int->Void> = new FlxTypedSignal<Int->Int->Void>();
 	public var preGameReset(default, null):FlxSignal = new FlxSignal();
 	public var postGameReset(default, null):FlxSignal = new FlxSignal();
+	/**
+	 * Gets dispatched just before the game is started (before the first state after the splash screen is created)
+	 */
+	public var preGameStart(default, null):FlxSignal = new FlxSignal();
 	/**
 	 * Gets dispatched when the game is started (first state after the splash screen).
 	 */
-	public var gameStarted(default, null):FlxSignal = new FlxSignal();
+	public var postGameStart(default, null):FlxSignal = new FlxSignal();
+	@:deprecated("Use postGameStart instead of gameStarted")
+	public var gameStarted(get, never):FlxSignal;
 	public var preUpdate(default, null):FlxSignal = new FlxSignal();
 	public var postUpdate(default, null):FlxSignal = new FlxSignal();
 	public var preDraw(default, null):FlxSignal = new FlxSignal();
@@ -29,4 +35,9 @@ class SignalFrontEnd
 
 	@:allow(flixel.FlxG)
 	function new() {}
+
+	function get_gameStarted():FlxSignal
+	{
+		return postGameStart;
+	}
 }