Add filter by name (no menu entry yet)

Author: 0x0ade

Everest

@@ -26,7 +26,8 @@
 	MODOPTIONS_GHOSTMODULE_MODE_PLAY= 			PLAY
 	MODOPTIONS_GHOSTMODULE_MODE_ON= 			BOTH
 	MODOPTIONS_GHOSTMODULE_NAME= 				Ghost Name
-	MODOPTIONS_GHOSTMODULE_SHOWOTHERNAMES= 		Show Other's Names
+	MODOPTIONS_GHOSTMODULE_NAMEFILTER= 			Filter By Name
+	MODOPTIONS_GHOSTMODULE_SHOWNAMES= 			Show Names
 	MODOPTIONS_GHOSTMODULE_INNEROPACITY= 		Near Ghost Visibility
 	MODOPTIONS_GHOSTMODULE_INNERHAIROPACITY= 	Near Ghost Hair Visibility
 	MODOPTIONS_GHOSTMODULE_OUTEROPACITY= 		Far Ghost Visibility

GhostMod/Content/Dialog/English.txt

@@ -27,6 +27,8 @@ public class Ghost : Actor {
 
         public GhostName Name;
 
+        protected Color color;
+
         protected float alpha;
         protected float alphaHair;
 
@@ -57,7 +59,7 @@ public override void Added(Scene scene) {
             Hair.Start();
             UpdateHair();
 
-            if (Data != null && Data.Name != GhostModule.Settings.Name)
+            if (Data != null)
                 Scene.Add(Name = new GhostName(this, Data.Name));
         }
 
@@ -105,6 +107,8 @@ public override void Update() {
             Visible &= Frame.HasData;
             if (Data != null && Data.Dead)
                 Visible &= GhostModule.Settings.ShowDeaths;
+            if (Data != null && !string.IsNullOrEmpty(GhostModule.Settings.NameFilter))
+                Visible &= string.IsNullOrEmpty(Data.Name) || GhostModule.Settings.NameFilter.Equals(Data.Name, StringComparison.InvariantCultureIgnoreCase);
 
             if (Player.InControl && AutoForward && ForcedFrame == null) {
                 do {
@@ -116,9 +120,6 @@ public override void Update() {
             }
             playerHadControl = Player.InControl;
 
-            UpdateSprite();
-            UpdateHair();
-
             if (Data != null && Data.Opacity != null) {
                 alpha = Data.Opacity.Value;
                 alphaHair = Data.Opacity.Value;
@@ -136,6 +137,18 @@ public override void Update() {
                 alphaHair = Calc.LerpClamp(GhostModule.Settings.InnerHairOpacityFactor, GhostModule.Settings.OuterHairOpacityFactor, dist);
             }
 
+            if (Data != null) {
+                /* Proposed colors:
+                 * blue - full run PB
+                 * silver - chapter PB
+                 * gold - room PB
+                 */
+                 // TODO: Ghost colors based on time.
+            }
+
+            UpdateSprite();
+            UpdateHair();
+
             Visible &= alpha > 0f;
 
             if (Name != null)

GhostMod/Ghost.cs

@@ -18,7 +18,7 @@ public class GhostData {
         public readonly static string Magic = "everest-ghost\r\n";
         public readonly static char[] MagicChars = Magic.ToCharArray();
 
-        public readonly static int Version = 0;
+        public readonly static int Version = 1;
 
         public readonly static Regex PathVerifyRegex = new Regex("[\"`?* #" + Regex.Escape(new string(Path.GetInvalidFileNameChars()) + new string(Path.GetInvalidPathChars())) + "]", RegexOptions.Compiled);
 
@@ -78,6 +78,8 @@ public static void ForAllGhosts(Session session, Func<int, GhostData, bool> cb)
 
         public float? Opacity;
 
+        public Guid Run;
+
         protected string _FilePath;
         public string FilePath {
             get {
@@ -103,6 +105,7 @@ public GhostFrame this[int i] {
 
         public GhostData() {
             Date = DateTime.UtcNow;
+            Run = Guid.NewGuid();
         }
         public GhostData(Session session)
             : this() {
@@ -173,6 +176,12 @@ public GhostData Read(BinaryReader reader) {
 
             Opacity = reader.ReadBoolean() ? (float?) reader.ReadSingle() : null;
 
+            if (version >= 1) {
+                Run = new Guid(reader.ReadBytes(16));
+            } else {
+                Run = Guid.Empty;
+            }
+
             int count = reader.ReadInt32();
             reader.ReadChar(); // \r
             reader.ReadChar(); // \n
@@ -225,6 +234,8 @@ public void Write(BinaryWriter writer) {
                 writer.Write(false);
             }
 
+            writer.Write(Run.ToByteArray());
+
             writer.Write(Frames.Count);
             writer.Write('\r');
             writer.Write('\n');

GhostMod/GhostData.cs

@@ -24,6 +24,8 @@ public class GhostModule : EverestModule {
         public List<Ghost> Ghosts = new List<Ghost>();
         public GhostRecorder GhostRecorder;
 
+        public Guid Run;
+
         public GhostModule() {
             Instance = this;
 
@@ -50,6 +52,7 @@ public void OnLoadLevel(Level level, Player.IntroTypes playerIntro, bool isFromL
                 Ghosts.Clear();
                 GhostRecorder?.RemoveSelf();
                 GhostRecorder = null;
+                Run = Guid.NewGuid();
             }
 
             Step(level);
@@ -75,6 +78,7 @@ public void Step(Level level) {
             // Maybe we left the level prematurely earlier?
             if (GhostRecorder?.Data != null) {
                 GhostRecorder.Data.Target = target;
+                GhostRecorder.Data.Run = Run;
                 GhostRecorder.Data.Write();
             }
 

GhostMod/GhostModule.cs

@@ -17,7 +17,10 @@ public class GhostModuleSettings : EverestModuleSettings {
         [SettingInGame(false)]
         public string Name { get; set; } = "";
 
-        public bool ShowOtherNames { get; set; } = true;
+        [SettingIgnore] // Ignore on older builds of Everest which don't support custom entry creators.
+        public string NameFilter { get; set; } = "";
+
+        public bool ShowNames { get; set; } = true;
 
         public bool ShowDeaths { get; set; } = false;
 
@@ -57,6 +60,10 @@ public class GhostModuleSettings : EverestModuleSettings {
         [SettingIgnore]
         public float BorderSizeDist => BorderSize * BorderSize * 64f;
 
+        public void ShowNameFilterEntry(TextMenu menu, bool inGame) {
+            // TODO: Create a slider to choose between all available names.
+        }
+
     }
     public enum GhostModuleMode {
         Off = 0,

GhostMod/GhostModuleSettings.cs

@@ -32,7 +32,7 @@ public override void Render() {
 
             if ((GhostModule.Settings.Mode & GhostModuleMode.Play) != GhostModuleMode.Play)
                 return;
-            if (!GhostModule.Settings.ShowOtherNames ||
+            if (!GhostModule.Settings.ShowNames ||
                 Tracking == null)
                 return;
 

GhostMod/GhostName.cs

@@ -1,5 +1,5 @@
 Name: GhostMod
-Version: 1.0.1
+Version: 1.1.0
 DLL: GhostMod.dll
 Dependencies:
   - Name: Everest