focus gain and lost events for scripts

- added `alpha`, `scroll`, and `angle` to `StageDataCharacter`
- added week titles for freya, milky, and kanimate
- fixed long burp for pico (dark & playable)

Author: charlesisfeline

assets/preload/data/characters/pico-dark.json

@@ -78,6 +78,17 @@
       "prefix": "burpsmile",
       "offsets": [37, 0]
     },
+    {
+      "name": "burpSmileLong",
+      "prefix": "burpsmile",
+      "frameIndices": [
+        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,
+        20, 21, 22, 23, 24, 25, 25, 26, 27, 28, 29, 30, 31, 31, 31, 31, 31, 31,
+        31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31,
+        31, 31, 31, 31, 31, 31
+      ],
+      "offsets": [37, 0]
+    },
     {
       "name": "shit",
       "prefix": "shit",

assets/preload/data/characters/pico-playable.json

@@ -98,6 +98,18 @@
       "prefix": "burpsmile",
       "offsets": [37, 0]
     },
+    {
+      "name": "burpSmileLong",
+      "prefix": "burpsmile",
+      "assetPath": "characters/Pico_Burps",
+      "frameIndices": [
+        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,
+        20, 21, 22, 23, 24, 25, 25, 26, 27, 28, 29, 30, 31, 31, 31, 31, 31, 31,
+        31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31, 31,
+        31, 31, 31, 31, 31, 31
+      ],
+      "offsets": [37, 0]
+    },
     {
       "name": "shit",
       "assetPath": "characters/Pico_Burps",

assets/preload/data/levels/xweek4.json

@@ -4,5 +4,6 @@
   "titleAsset": "storymenu/titles/chainz",
   "props": [],
   "background": "#413CAE",
+  "visible": false,
   "songs": ["topp", "azure", "doublyon"]
 }

assets/preload/images/storymenu/titles/chainz.png

@@ -176,7 +176,7 @@ typedef StageDataProp =
    * How much the prop scrolls relative to the camera. Used to create a parallax effect.
    * Represented as an [x, y] array of two floats.
    * [1, 1] means the prop moves 1:1 with the camera.
-   * [0.5, 0.5] means the prop half as much as the camera.
+   * [0.5, 0.5] means the prop moves half as much as the camera.
    * [0, 0] means the prop is not moved.
    * @default [0, 0]
    */
@@ -266,4 +266,32 @@ typedef StageDataCharacter =
    */
   @:optional
   var cameraOffsets:Array<Float>;
+
+  /**
+   * How much the character scrolls relative to the camera. Used to create a parallax effect.
+   * Represented as an [x, y] array of two floats.
+   * [1, 1] means the character moves 1:1 with the camera.
+   * [0.5, 0.5] means the character moves half as much as the camera.
+   * [0, 0] means the character is not moved.
+   * @default [0, 0]
+   */
+  @:optional
+  @:default([0, 0])
+  var scroll:Array<Float>;
+
+  /**
+   * The alpha of the character, as a float.
+   * @default 1.0
+   */
+  @:optional
+  @:default(1.0)
+  var alpha:Float;
+
+  /**
+   * The angle of the character, as a float.
+   * @default 1.0
+   */
+  @:optional
+  @:default(0.0)
+  var angle:Float;
 };

assets/preload/images/storymenu/titles/freya.png

@@ -37,6 +37,9 @@ interface IStateChangingScriptedClass extends IScriptedClass
   public function onSubStateOpenEnd(event:SubStateScriptEvent):Void;
   public function onSubStateCloseBegin(event:SubStateScriptEvent):Void;
   public function onSubStateCloseEnd(event:SubStateScriptEvent):Void;
+
+  public function onFocusLost(event:FocusScriptEvent):Void;
+  public function onFocusGained(event:FocusScriptEvent):Void;
 }
 
 /**

assets/preload/images/storymenu/titles/kanimate.png

@@ -467,6 +467,22 @@ class StateChangeScriptEvent extends ScriptEvent
   }
 }
 
+/**
+ * An event that is fired when the game loses or gains focus.
+ */
+class FocusScriptEvent extends ScriptEvent
+{
+  public function new(type:ScriptEventType, cancelable:Bool = false):Void
+  {
+    super(type, cancelable);
+  }
+
+  public override function toString():String
+  {
+    return 'FocusScriptEvent(type=' + type + ')';
+  }
+}
+
 /**
  * An event that is fired when moving out of or into an FlxSubState.
  */

assets/preload/images/storymenu/titles/milky.png

@@ -182,6 +182,12 @@ class ScriptEventDispatcher
         case SUBSTATE_CLOSE_END:
           t.onSubStateCloseEnd(cast event);
           return;
+        case FOCUS_LOST:
+          t.onFocusLost(cast event);
+          return;
+        case FOCUS_GAINED:
+          t.onFocusGained(cast event);
+          return;
         default: // Continue;
       }
     }

source/funkin/data/stage/StageData.hx

@@ -237,6 +237,20 @@ enum abstract ScriptEventType(String) from String to String
    */
   var SUBSTATE_CLOSE_END = 'SUBSTATE_CLOSE_END';
 
+  /**
+   * Called when the game regains focus.
+   *
+   * This event is not cancelable.
+   */
+  var FOCUS_GAINED = 'FOCUS_GAINED';
+
+  /**
+   * Called when the game loses focus.
+   *
+   * This event is not cancelable.
+   */
+  var FOCUS_LOST = 'FOCUS_LOST';
+
   /**
    * Called when the game starts a conversation.
    *

source/funkin/modding/IScriptedClass.hx

@@ -121,5 +121,9 @@ class Module implements IPlayStateScriptedClass implements IStateChangingScripte
 
   public function onSubStateCloseEnd(event:SubStateScriptEvent) {}
 
+  public function onFocusGained(event:FocusScriptEvent) {}
+
+  public function onFocusLost(event:FocusScriptEvent) {}
+
   public function onSongRetry(event:ScriptEvent) {}
 }

source/funkin/modding/events/ScriptEvent.hx

@@ -452,6 +452,12 @@ class Stage extends FlxSpriteGroup implements IPlayStateScriptedClass implements
       character.cameraFocusPoint.x += stageCharData.cameraOffsets[0];
       character.cameraFocusPoint.y += stageCharData.cameraOffsets[1];
 
+      character.scrollFactor.x = stageCharData.scroll[0];
+      character.scrollFactor.y = stageCharData.scroll[1];
+
+      character.alpha = stageCharData.alpha;
+      character.angle = stageCharData.angle;
+
       #if FEATURE_DEBUG_FUNCTIONS
       // Draw the debug icon at the character's feet.
       if (charType == BF || charType == DAD)

source/funkin/modding/events/ScriptEventDispatcher.hx

@@ -152,6 +152,20 @@ class MusicBeatState extends FlxTransitionableState implements IEventHandler
     dispatchEvent(new UpdateScriptEvent(elapsed));
   }
 
+  override function onFocus():Void
+  {
+    super.onFocus();
+
+    dispatchEvent(new FocusScriptEvent(FOCUS_GAINED));
+  }
+
+  override function onFocusLost():Void
+  {
+    super.onFocusLost();
+
+    dispatchEvent(new FocusScriptEvent(FOCUS_LOST));
+  }
+
   function createWatermarkText()
   {
     // Both have an xPos of 0, but a width equal to the full screen.

source/funkin/modding/events/ScriptEventType.hx

@@ -144,6 +144,20 @@ class MusicBeatSubState extends FlxSubState implements IEventHandler
     dispatchEvent(new UpdateScriptEvent(elapsed));
   }
 
+  override function onFocus():Void
+  {
+    super.onFocus();
+
+    dispatchEvent(new FocusScriptEvent(FOCUS_GAINED));
+  }
+
+  override function onFocusLost():Void
+  {
+    super.onFocusLost();
+
+    dispatchEvent(new FocusScriptEvent(FOCUS_LOST));
+  }
+
   public function initConsoleHelpers():Void {}
 
   function reloadAssets()