v1.5.8, feat: FireBall track

Author: LozenChen

Dialog/English.txt

@@ -121,5 +121,6 @@ TAS_HELPER_PIXEL_GRID=                                     Pixel Grid
 TAS_HELPER_ENABLE_PIXEL_GRID=                              Pixel Grid
 TAS_HELPER_PIXEL_GRID_WIDTH=                               Pixel Grid Width
 TAS_HELPER_PIXEL_GRID_OPACITY=                             Pixel Grid Opacity
+TAS_HELPER_FIREBALL_TRACK=                                 Ice/FireBall Track
 TAS_HELPER_CAMERA_TARGET=                                  Camera Target
 TAS_HELPER_CAMERA_TARGET_VECTOR_OPACITY=                   Camera-Target Link Opacity

Dialog/Simplified Chinese.txt

@@ -122,5 +122,6 @@ TAS_HELPER_PIXEL_GRID=                                     像素网格
 TAS_HELPER_ENABLE_PIXEL_GRID=                              像素网格
 TAS_HELPER_PIXEL_GRID_WIDTH=                               像素网格宽度
 TAS_HELPER_PIXEL_GRID_OPACITY=                             像素网格不透明度
+TAS_HELPER_FIREBALL_TRACK=                                 冰/火球轨迹
 TAS_HELPER_CAMERA_TARGET=                                  镜头移动目标
 TAS_HELPER_CAMERA_TARGET_VECTOR_OPACITY=                   镜头-目标 连线的不透明度

Entities/FireBallExt.cs

@@ -0,0 +1,68 @@
+using Celeste.Mod.TASHelper.Utils;
+using Microsoft.Xna.Framework;
+using Monocle;
+using System.Reflection;
+
+namespace Celeste.Mod.TASHelper.Entities;
+
+public static class FireBallExt {
+
+    public static void Load() {
+        On.Monocle.EntityList.DebugRender += PatchEntityListDebugRender;
+        On.Celeste.Level.LoadLevel += OnLoadLevel;
+    }
+
+    public static void Unload() {
+        On.Monocle.EntityList.DebugRender -= PatchEntityListDebugRender;
+        On.Celeste.Level.LoadLevel -= OnLoadLevel;
+    }
+
+    public static void Initialize() {
+        LevelExtensions.AddToTracker(typeof(FireBall));
+        FireBallNodesGetter = typeof(FireBall).GetField("nodes",BindingFlags.Instance| BindingFlags.NonPublic);
+    }
+
+    public static FieldInfo FireBallNodesGetter;
+
+    internal static readonly List<Vector2[]> CachedNodes = new List<Vector2[]>();
+
+    private static void OnLoadLevel(On.Celeste.Level.orig_LoadLevel orig, Level self, Player.IntroTypes playerIntro, bool isFromLoader) {
+        CachedNodes.Clear();
+        orig(self, playerIntro, isFromLoader);
+    }
+    private static void PatchEntityListDebugRender(On.Monocle.EntityList.orig_DebugRender orig, EntityList self, Camera camera) {
+        orig(self, camera);
+        if (!TasHelperSettings.UsingFireBallTrack || self.Scene is not Level level) {
+            return;
+        }
+        foreach (Entity entity in level.Tracker.GetEntities<FireBall>()) {
+            Vector2[] nodes = (Vector2[])FireBallNodesGetter.GetValue(entity);
+            if (!CachedNodes.Contains(nodes)) {
+                CachedNodes.Add(nodes);
+            }
+        }
+        foreach (Vector2[] nodes in CachedNodes) {
+            for (int i = 0; i < nodes.Length - 1; i++) {
+                Monocle.Draw.Line(nodes[i], nodes[i + 1], Color.Yellow * 0.5f);
+            }
+        }
+    }
+
+    /*
+     * The KillBox is just those part under the bounce hitbox, unless FireBall happens to have Position.Y an integer
+     * btw there is some OoO issue, so i decide not to render it
+     * CelesteTAS
+    private static void PatchFireBallDebugRender(Entity entity) {
+        if (entity is not FireBall self || !(bool)IceModeGetter.GetValue(self)) {
+            return;
+        }
+        float y = self.Y + 4f - 1f;
+        float z = (float)Math.Ceiling(y);
+        if (z <= y) {
+            z += 1f;
+        }
+        float top = Math.Max(self.Collider.AbsoluteTop, z);
+        Draw.Rect(self.X - 4f, top, 9f, 1f, self.Collidable ? Color.WhiteSmoke : Color.WhiteSmoke * HitboxColor.UnCollidableAlpha);
+    }
+    */
+}

Entities/SimplifiedSpinner.cs

@@ -85,21 +85,15 @@ public static void Initialize() {
         }
 
         if (ModUtils.BrokemiaHelperInstalled) {
-            typeof(Level).GetMethod("LoadLevel").IlHook((cursor, _) => {
-                cursor.Emit(OpCodes.Ldarg_0);
-                cursor.EmitDelegate(TrackCassetteSpinner);
-            });
+            TrackCassetteSpinner();
             typeof(Level).GetMethod("BeforeRender").IlHook((cursor, _) => {
                 cursor.Emit(OpCodes.Ldarg_0);
                 cursor.EmitDelegate<Action<Level>>(BrokemiaBeforeRender);
             });
         }
 
         if (ModUtils.IsaGrabBagInstalled) {
-            typeof(Level).GetMethod("LoadLevel").IlHook((cursor, _) => {
-                cursor.Emit(OpCodes.Ldarg_0);
-                cursor.EmitDelegate(TrackDreamSpinnerRenderer);
-            });
+            TrackDreamSpinnerRenderer();
             typeof(Level).GetMethod("BeforeRender").IlHook((cursor, _) => {
                 cursor.Emit(OpCodes.Ldarg_0);
                 cursor.EmitDelegate<Action<Level>>(IsaGrabBagBeforeRender);
@@ -212,15 +206,8 @@ private static void ChronoBeforeRender(Level self) {
         }
     }
 
-    private static void TrackCassetteSpinner(Level self) {
-        Type t = typeof(BrokemiaHelper.CassetteSpinner);
-        if (!Tracker.TrackedEntityTypes.ContainsKey(t)) {
-            Tracker.TrackedEntityTypes.Add(t, new List<Type>());
-            Tracker.TrackedEntityTypes[t].Add(t);
-        }
-        if (!self.Tracker.Entities.ContainsKey(t)) {
-            self.Tracker.Entities.Add(t, new List<Entity>());
-        }
+    private static void TrackCassetteSpinner() {
+        LevelExtensions.AddToTracker(typeof(BrokemiaHelper.CassetteSpinner));
     }
     private static void BrokemiaBeforeRender(Level self) {
         if (Updated) {
@@ -237,15 +224,8 @@ private static void BrokemiaBeforeRender(Level self) {
         }
     }
 
-    private static void TrackDreamSpinnerRenderer(Level self) {
-        Type t = typeof(IsaGrabBag.DreamSpinnerRenderer);
-        if (!Tracker.TrackedEntityTypes.ContainsKey(t)) {
-            Tracker.TrackedEntityTypes.Add(t, new List<Type>());
-            Tracker.TrackedEntityTypes[t].Add(t);
-        }
-        if (!self.Tracker.Entities.ContainsKey(t)) {
-            self.Tracker.Entities.Add(t, new List<Entity>());
-        }
+    private static void TrackDreamSpinnerRenderer() {
+        LevelExtensions.AddToTracker(typeof(IsaGrabBag.DreamSpinnerRenderer));
     }
 
     private static void IsaGrabBagBeforeRender(Level self) {

Module/TASHelperMenu.cs

@@ -97,6 +97,7 @@ private static EaseInSubMenu CreateMoreOptionsSubMenu(TextMenu menu) {
             subMenu.Add(new TextMenuExt.IntSlider("Pixel Grid Opacity".ToDialogText(), 1, 10, TasHelperSettings.PixelGridOpacity).Change(value => TasHelperSettings.PixelGridOpacity = value));
             subMenu.Add(new TextMenu.OnOff("Camera Target".ToDialogText(), TasHelperSettings.UsingCameraTarget).Change(value => TasHelperSettings.UsingCameraTarget = value));
             subMenu.Add(new TextMenuExt.IntSlider("Camera Target Vector Opacity".ToDialogText(), 1, 9, TasHelperSettings.CameraTargetLinkOpacity).Change(value => TasHelperSettings.CameraTargetLinkOpacity = value));
+            subMenu.Add(new TextMenu.OnOff("FireBall Track".ToDialogText(), TasHelperSettings.UsingFireBallTrack).Change(value => TasHelperSettings.UsingFireBallTrack = value));
             TextMenu.Item MainSwitchStateItem;
             EaseInSubHeaderExtPub StateDescription = new EaseInSubHeaderExtPub("Configure At State All".ToDialogText(), false, menu) {
                 TextColor = Color.Gray,

Module/TASHelperSettings.cs

@@ -22,7 +22,7 @@ internal void OnLoadSettings() {
         // do nothing currently
 
         // Everest will save & load settings of public fields/properties when open the game
-        // i don't want the setters of those properties which has a do not save attribute, which will break the awakes
+        // i don't want to call setters of those properties which has a do not save attribute, which will break the awakes
         // so i have to make them internal
         // but i also want to expose them to users, so i add TasHelperSettingsAlias class
         // i need to save those loadRangeMode fields, so they should be public
@@ -82,6 +82,7 @@ internal void Sleep() {
         Awake_PixelGrid = false;
         Awake_SpawnPoint = false;
         Awake_EntityActivatorReminder = false;
+        Awake_FireBallTrack = false;
     }
     internal void Awake(bool awakeAll) {
         MainSwitch = awakeAll ? MainSwitchModes.AllowAll : MainSwitchModes.OnlyDefault;
@@ -94,6 +95,7 @@ internal void Awake(bool awakeAll) {
         Awake_PixelGrid = awakeAll;
         Awake_SpawnPoint = true;
         Awake_EntityActivatorReminder = true;
+        Awake_FireBallTrack = true;
     }
 
     #endregion
@@ -351,6 +353,19 @@ internal bool UsingSpawnPoint {
 
     public int OtherSpawnPointOpacity = 2;
 
+    public bool Awake_FireBallTrack = true;
+
+    public bool usingFireBallTrack = false;
+
+    [SettingDoNotSave]
+    internal bool UsingFireBallTrack {
+        get => Enabled && Awake_FireBallTrack && usingFireBallTrack;
+        set {
+            usingFireBallTrack = value;
+            Awake_FireBallTrack = true;
+        }
+    }
+
     public bool AllowEnableModWithMainSwitch = true;
 
     private bool mainSwitchStateVisualize = true;
@@ -596,5 +611,10 @@ public static bool UsingSpawnPoint {
         get => TasHelperSettings.UsingSpawnPoint;
         set => TasHelperSettings.UsingSpawnPoint = value;
     }
+
+    public static bool UsingFireBallTrack {
+        get => TasHelperSettings.UsingFireBallTrack;
+        set => TasHelperSettings.UsingFireBallTrack = value;
+    }
 }
 

README.md

@@ -38,8 +38,12 @@ A Celeste Mod designed to be a tool in TAS making.
 
 # WIP:
 
+- Slowdown indicator (note there's 1 frame delay between DeltaTime and TimeRate)
+
 - Better custom info.
 
+- Scrollable console.
+
 # Known issues:
 
 - Actual Collide Hitboxes are overridden -> it's actually bad to use actual collide hitboxes when doing a spinner stun, you really need the exact frame the hazard becomes collidable (opaque). So personnally i do not suggest using actual collide hitboxes in this case. Appended hitbox sounds good but current implement relies on opacity to show information. I have no good idea about it so it's set aside.
@@ -48,4 +52,4 @@ A Celeste Mod designed to be a tool in TAS making.
 
 - Laggy when there are too many spinners (e.g. Strawberry Jam GrandMaster HeartSide) -> Partially solved in v1.4.7
 
-- Hotkeys can't work after several savestates -> Where does this bug come from???
+- Hotkeys can't work after several savestates -> Seems fixed in v1.5.7

TASHelper.csproj

@@ -7,11 +7,7 @@
     <Nullable>enable</Nullable>
     <Authors>$(AssemblyName)</Authors>
     <RootNamespace>Celeste.Mod.TASHelper</RootNamespace>
-  </PropertyGroup>
-
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
-    <WarningLevel>4</WarningLevel>
-    <NoWarn>CS8618</NoWarn>
+    <Configurations>Release</Configurations>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">

TASHelper.sln

@@ -11,8 +11,7 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{8AA4040A-8388-48E7-9726-BC2D75BF49CB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{8AA4040A-8388-48E7-9726-BC2D75BF49CB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8AA4040A-8388-48E7-9726-BC2D75BF49CB}.Debug|Any CPU.ActiveCfg = Release|Any CPU
 		{8AA4040A-8388-48E7-9726-BC2D75BF49CB}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{8AA4040A-8388-48E7-9726-BC2D75BF49CB}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection

Utils/Extensions.cs

@@ -2,6 +2,7 @@
 using System.Collections.Concurrent;
 using System.Reflection;
 using System.Reflection.Emit;
+using Monocle;
 
 namespace Celeste.Mod.TASHelper.Utils;
 
@@ -427,3 +428,21 @@ public static TValue LastValueOrDefault<TKey, TValue>(this SortedDictionary<TKey
         return dict.Count > 0 ? dict.Last().Value : default;
     }
 }
+
+internal static class LevelExtensions {
+    public static void AddToTracker(Type t) {
+        typeof(Level).GetMethod("LoadLevel").IlHook((cursor, _) => {
+            cursor.Emit(Mono.Cecil.Cil.OpCodes.Ldarg_0);
+            cursor.EmitDelegate((Level level) => {
+                if (!Tracker.TrackedEntityTypes.ContainsKey(t)) {
+                    Tracker.TrackedEntityTypes.Add(t, new List<Type>());
+                    Tracker.TrackedEntityTypes[t].Add(t);
+                }
+                if (!level.Tracker.Entities.ContainsKey(t)) {
+                    level.Tracker.Entities.Add(t, new List<Entity>());
+                }
+            });
+        });
+    }
+
+}

Utils/Loader.cs

@@ -11,6 +11,7 @@ public static void EntityLoad() {
         SimplifiedSpinner.Load();
         Messenger.Load();
         SpawnPoint.Load();
+        FireBallExt.Load();
     }
 
     public static void EntityUnload() {
@@ -19,6 +20,7 @@ public static void EntityUnload() {
         SimplifiedSpinner.Unload();
         Messenger.Unload();
         SpawnPoint.Unload();
+        FireBallExt.Unload();
     }
 
     public static void HelperLoad() {
@@ -52,6 +54,7 @@ public static void Initialize() {
         Messenger.Initialize();
         SpawnPoint.Initialize();
         RestoreSettingsExt.Initialize();
+        FireBallExt.Initialize();
     }
 
     public static void LoadContent() {

everest.yaml

@@ -1,5 +1,5 @@
 - Name: TASHelper
-  Version: 1.5.7
+  Version: 1.5.8
   DLL: bin/Release/net4.5.2/TASHelper.dll
   Dependencies:
     - Name: Everest