Merge pull request #87 from CPCTC/randomize-touch-switch

Feature: randomized moving touch switch

Author: vitellaryjr

Code/FLCC/CustomMovingTouchSwitch.cs

@@ -5,6 +5,7 @@
 using MonoMod.Utils;
 using System;
 using System.Collections;
+using System.Collections.Generic;
 using System.Linq;
 
 namespace vitmod
@@ -14,6 +15,7 @@ namespace vitmod
     public class CustomMovingTouchSwitch : Entity
     {
 		public EntityID ID;
+		private Vector2[] node_set;
 		private Vector2[] nodes;
 		private Color inactiveColor;
 		private Color movingColor;
@@ -24,6 +26,9 @@ public class CustomMovingTouchSwitch : Entity
 		private bool allowDisable;
 		private bool smoke;
 		private bool badelineDeactivate;
+		private bool randomOrder;
+		private int pathLength;
+		private bool revisitPreviousNodes;
 
 		public ISwitch Switch;
 		private Vector2 startPosition;
@@ -44,7 +49,8 @@ public class CustomMovingTouchSwitch : Entity
 		public CustomMovingTouchSwitch(EntityData data, Vector2 offset) : base(data.Position + offset)
 		{
 			ID = new EntityID(data.Level.Name, data.ID);
-			nodes = data.NodesOffset(offset);
+			node_set = data.NodesOffset(offset);
+			nodes = [];
 			var flag = data.Attr("flag");
 			var inverted = data.Bool("inverted");
 			var persistent = data.Bool("persistent");
@@ -57,6 +63,12 @@ public CustomMovingTouchSwitch(EntityData data, Vector2 offset) : base(data.Posi
 			allowDisable = data.Bool("allowDisable");
 			smoke = data.Bool("smoke", true);
 			badelineDeactivate = data.Bool("badelineDeactivate");
+			randomOrder = data.Bool("randomOrder");
+			pathLength = data.Int("pathLength", -1);
+			if (pathLength == -1) {
+				pathLength = node_set.Length;
+			}
+			revisitPreviousNodes = data.Bool("revisitPreviousNodes");
 			var iconName = data.Attr("icon", "vanilla");
 			icon = new Sprite(GFX.Game, iconName == "vanilla" ? "objects/touchswitch/icon" : $"objects/{(iconName is "tall" or "triangle" or "circle" ? "CrystallineHelper/FLCC/" : "")}customMovingTouchSwitch/{iconName}/icon");
 
@@ -258,6 +270,38 @@ private IEnumerator DrawPathParticles(Vector2 start, Vector2 end)
 			}
 		}
 
+		public override void Added(Scene scene) {
+			base.Added(scene);
+			if (randomOrder) {
+				Calc.PushRandom(VitModule.GetSeed(SceneAs<Level>()));
+
+				List<Vector2> path = new List<Vector2>(pathLength);
+
+				List<int> idx_pool = new List<int>(node_set.Length);
+				for (int i = 0; i < node_set.Length; i++) {
+					idx_pool.Add(i);
+				}
+
+				Vector2 prev = startPosition;
+
+				for (int i = 0; i < pathLength; i++) {
+					List<int> idx_candidates = new List<int>(idx_pool);
+					idx_candidates.RemoveAll(idx => node_set[idx] == prev);
+					if (idx_candidates.Count == 0) break;
+					int idx = Calc.Choose<int>(Calc.Random, idx_candidates);
+					if (!revisitPreviousNodes) {
+						idx_pool.Remove(idx);
+					}
+					path.Add(prev = node_set[idx]);
+				}
+
+				nodes = path.ToArray();
+				Calc.PopRandom();
+			} else {
+				nodes = node_set;
+			}
+		}
+
 		public override void Update()
 		{
 			timer += Engine.DeltaTime * 8f;

Code/TriggerTrigger.cs

@@ -387,11 +387,7 @@ private void ActivateTriggers(Player player) {
                     trigger.OnEnter(player);
                 }
             } else if (triggers.Count > 0) {
-                if (VitModule.Settings.TriggerTriggerRandomizationType == RandomizationTypes.FileTimer) {
-                    Calc.PushRandom((int)(SaveData.Instance.Time % int.MaxValue));
-                } else {
-                    Calc.PushRandom((int)(SceneAs<Level>().Session.Time % int.MaxValue));
-                }
+                Calc.PushRandom(VitModule.GetSeed(SceneAs<Level>()));
                 chosenTrigger = Calc.Choose(Calc.Random, triggers);
                 Calc.PopRandom();
 
@@ -634,10 +630,6 @@ public enum ActivationTypes {
             OnGrounded,
             OnPlayerState,
         };
-        public enum RandomizationTypes {
-            FileTimer,
-            ChapterTimer
-        };
         public enum InputTypes {
             Left,
             Right,

Code/VitModule.cs

@@ -55,11 +55,11 @@ public class VitModuleSession : EverestModuleSession
 
         public class VitModuleSettings : EverestModuleSettings
         {
-            public TriggerTrigger.RandomizationTypes TriggerTriggerRandomizationType
+            public RandomizationTypes RandomizationType
             {
                 get;
                 set;
-            } = TriggerTrigger.RandomizationTypes.FileTimer;
+            } = RandomizationTypes.FileTimer;
 
             public bool DisplayDashSequence {
                 get;
@@ -838,6 +838,19 @@ public override void Unload()
             On.Celeste.Level.Reload -= Level_Reload;
         }
 
+        public static int GetSeed(Level level) {
+            if (Settings.RandomizationType == RandomizationTypes.FileTimer) {
+                return (int)(SaveData.Instance.Time % int.MaxValue);
+            } else {
+                return (int)(level.Session.Time % int.MaxValue);
+            }
+        }
+
+        public enum RandomizationTypes {
+            FileTimer,
+            ChapterTimer
+        };
+
         public const string TimeFrozenFlag = "CrystallineHelper_TimeIsFrozen";
 
         private float rainbowTimer;

Loenn/entities/custom_touch_switch.lua

@@ -20,6 +20,9 @@ customTouchSwitch.placements = {
             smoke = true,
             allowDisable = true,
             badelineDeactivate = false,
+            randomOrder = false,
+            pathLength = -1,
+            revisitPreviousNodes = false,
         }
     }
 }
@@ -35,8 +38,19 @@ customTouchSwitch.fieldInformation = {
     icon = {
         options = {"vanilla", "tall", "triangle", "circle"},
     },
+    pathLength = {
+        fieldType = "integer",
+    },
 }
 
+function customTouchSwitch.ignoredFields(ent)
+    if ent.randomOrder then
+        return {"_name", "_id", "originX", "originY"}
+    else
+        return {"_name", "_id", "originX", "originY", "pathLength", "revisitPreviousNodes"}
+    end
+end
+
 customTouchSwitch.nodeLimits = {0, -1}
 customTouchSwitch.nodeLineRenderType = "line"
 

Loenn/lang/en_gb.lang

@@ -254,6 +254,9 @@ entities.vitellary/customtouchswitch.attributes.description.allowDisable=Whether
 entities.vitellary/customtouchswitch.attributes.description.badelineDeactivate=Whether the touch switch deactivates when touched by an interactive badeline chaser.
 entities.vitellary/customtouchswitch.attributes.description.moveTime=The time it takes for the switch to move between nodes.
 entities.vitellary/customtouchswitch.attributes.description.easing=The easing of the switch's movement between nodes.
+entities.vitellary/customtouchswitch.attributes.description.randomOrder=Should the order the nodes are visited be randomized? Off: Nodes are visited in order. On: `Path Length` of this entity's nodes are visited in a random order.
+entities.vitellary/customtouchswitch.attributes.description.pathLength=When using `Random Order`, the number of nodes that should be visited before finishing. -1 to use the number of attached nodes.
+entities.vitellary/customtouchswitch.attributes.description.revisitPreviousNodes=When using `Random Order`, am I allowed to revisit nodes I have already been to? The sequence may be finished early if there are no nodes left to visit.
 
 # Trigger Beam
 entities.vitellary/triggerbeam.attributes.description.color=The color of the beam.