feat: force arrive animation

GodSeekerPlus/GodSeekerPlus.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<AssemblyTitle>GodSeekerPlus</AssemblyTitle>
-		<Version>0.11.0</Version>
+		<Version>0.12.0</Version>
 		<Description>A Hollow Knight mod to enhance your Godhome experience</Description>
 		<Authors>Clazex</Authors>
 		<Copyright>Copyright © 2021 Clazex</Copyright>

GodSeekerPlus/Lang/en.json

@@ -5,6 +5,7 @@
 	"Modules/DoorDefaultBegin": "Door Default Begin",
 	"Modules/FastDreamWarp": "Fast Dream Warp",
 	"Modules/FastSuperDash": "Fast Super Dash",
+	"Modules/ForceArriveAnimation": "Force Arrive Animation",
 	"Modules/ForceOvercharm": "Force Overcharm",
 	"Modules/FrameRateLimit": "Frame Rate Limit",
 	"Modules/GreyPrinceEnterShort": "Grey Prince Enter Short",

GodSeekerPlus/Lang/zh.json

@@ -5,6 +5,7 @@
 	"Modules/DoorDefaultBegin": "门默认开始",
 	"Modules/FastDreamWarp": "快速梦门传送",
 	"Modules/FastSuperDash": "快速超级冲刺",
+	"Modules/ForceArriveAnimation": "强制入场动画",
 	"Modules/ForceOvercharm": "强制护符过载",
 	"Modules/FrameRateLimit": "帧率限制",
 	"Modules/GreyPrinceEnterShort": "灰色王子短入场",

GodSeekerPlus/Modules/ForceArriveAnimation.cs

@@ -0,0 +1,37 @@
+namespace GodSeekerPlus.Modules;
+
+[Module(toggleable = true, defaultEnabled = false)]
+internal sealed class ForceArriveAnimation : Module {
+	private static readonly string[] scenes = {
+		"GG_Vengefly",
+		"GG_Vengefly_V",
+		"GG_Ghost_Xero",
+		"GG_Ghost_Xero_V",
+		"GG_Hive_Knight",
+		"GG_Crystal_Guardian_2"
+	};
+
+	private protected override void Load() =>
+		On.PlayMakerFSM.OnEnable += ModifyDreamEntryFSM;
+
+	private protected override void Unload() =>
+		On.PlayMakerFSM.OnEnable -= ModifyDreamEntryFSM;
+
+	private static void ModifyDreamEntryFSM(On.PlayMakerFSM.orig_OnEnable orig, PlayMakerFSM self) {
+		orig(self);
+
+		if (
+			self.gameObject.name == "Dream Entry"
+			&& self.FsmName == "Control"
+			&& scenes.Contains(self.gameObject.scene.name)
+		) {
+			self.ChangeTransition("First Boss? 1", "STATUE", "Hide Player");
+
+			FsmState stateFirstBoss = self.GetState("First Boss?");
+			stateFirstBoss.GetAction<GGCheckIfBossSequence>().falseEvent =
+				stateFirstBoss.GetAction<GGCheckIfFirstBossScene>().trueEvent;
+
+			Logger.LogDebug("Dream Entry FSM modified");
+		}
+	}
+}

README.md

@@ -12,6 +12,7 @@ Compatible with `Hollow Knight` 1.5.
 - **Door Default Begin**: Default selecting the Begin button when opening Pantheon Door UI.
 - **Fast Dream Warping**: Remove dream warping charge time when in boss scenes. This decrease the total warping time from 2.25s to 0.25s.
 - **Fast Super Dash**: Buff Super Dash speed in Hall of Gods.
+- **Force Arrive Animation**: Force the arrive animation to be played when fighting Vengefly King, Xero, Hive Knight and Enraged Guardian in Hall of Gods.
 - **Force Overcharm**: Force entering the overcharmed state.
 - **Frame Rate Limit**: Create a lag in every in-game frame.
 - **Grey Prince Enter Short**: Force Grey Prince to use short enter, as when defeated last time.
@@ -31,6 +32,7 @@ All features can be toggled in-game.
   + `DoorDefaultBegin` (`Boolean`): Whether to enable the Door Default Begin feature. Defaults to `true`.
   + `FastDreamWarp` (`Boolean`): Whether to enable the Fast Dream Warping feature. Defaults to `true`.
   + `FastSuperDash` (`Boolean`): Whether to enable the Fast Super Dash feature. Defaults to `true`.
+  + `ForceArriveAnimation` (`Boolean`): Whether to enable the Force Arrive Animation feature. Defaults to `false`.
   + `ForceOvercharm` (`Boolean`): Whether to enable the Force Overcharm feature. Defaults to `false`.
   + `FrameRateLimit` (`Boolean`): Whether to enable the Frame Rate Limit feature. Defaults to `false`.
   + `GreyPrinceEnterShort` (`Boolean`): Whether to enable the Grey Prince Enter Short feature. Defaults to `true`.

README.zh.md

@@ -12,6 +12,7 @@
 - **门默认开始**：打开万神殿门界面时默认选中开始按钮。
 - **快速梦门传送**：当在 Boss 场景中时，移除梦之门传送充能时间。这将总传送时间从 2.25 秒减少到 0.25 秒。
 - **快速超级冲刺**：提升在诸神堂中的超级冲刺速度。
+- **强制入场动画**：在诸神堂中挑战复仇蝇之王，泽若，蜂巢骑士和暴怒守卫时强制播放入场动画。
 - **强制护符过载**：强制进入护符过载状态。
 - **帧率限制**：在游戏内的每帧添加卡顿。
 - **灰色王子短入场**：强制灰色王子使用短入场，如同上一次击败之的效果。
@@ -31,6 +32,7 @@
   + `DoorDefaultBegin` (`Boolean`)：是否启用 `门默认开始` 功能。默认为 `true`。
   + `FastDreamWarp` (`Boolean`)：是否启用 `快速梦门传送` 功能。默认为 `true`。
   + `FastSuperDash` (`Boolean`)：是否启用 `快速超级冲刺` 功能。默认为 `true`。
+  + `ForceArriveAnimation` (`Boolean`)：是否启用 `强制入场动画` 功能。默认为 `false`。
   + `ForceOvercharm` (`Boolean`)：是否启用 `强制护符过载` 功能。默认为 `false`。
   + `FrameRateLimit` (`Boolean`)：是否启用 `帧率限制` 功能。默认为 `false`。
   + `GreyPrinceEnterShort` (`Boolean`)：是否启用 `灰色王子短入场` 功能。默认为 `true`。