Merge pull request #92 from earthwise01/custom-wind-fixes

Custom Wind Fixes

Author: catapillie

Ahorn/lang/en_gb.lang

@@ -213,14 +213,15 @@ placements.triggers.vitellary/resetdoortrigger.tooltips.onlyInRoom=Whether the t
 
 # Custom Wind Trigger
 placements.triggers.vitellary/customwindtrigger.tooltips.speedX=The horizontal speed of the wind. Can be a list of speeds, separated by commas. For reference, normal wind speed is 4, and strong is 8.
-placements.triggers.vitellary/customwindtrigger.tooltips.speedY=The vertical speed of the wind. Can be a list of speeds, separated by commas. For reference, normal wind speed is 4, and strong is 8.
+placements.triggers.vitellary/customwindtrigger.tooltips.speedY=The vertical speed of the wind. Can be a list of speeds, separated by commas. For reference, normal down wind speed is 3, and up is -4.
 placements.triggers.vitellary/customwindtrigger.tooltips.alternationSpeed=The time, in seconds, that it takes to switch between speeds if there is a list in either horizontal or vertical speed. Can also be a list of speeds, separated by commas, which will be looped through.
 placements.triggers.vitellary/customwindtrigger.tooltips.catchupSpeed=How fast the wind changes from the previous value. Default is 1.
 placements.triggers.vitellary/customwindtrigger.tooltips.activationType=Special condition for the wind to activate.
 placements.triggers.vitellary/customwindtrigger.tooltips.loop=Whether the wind should loop or just stop at the last values when going through a list of speeds.
 placements.triggers.vitellary/customwindtrigger.tooltips.persist=If true, the wind created will stay after transitioning to a different room or dying. It will still be replaced by other wind triggers.
 placements.triggers.vitellary/customwindtrigger.tooltips.oneUse=Whether the wind trigger should disappear after being used.
 placements.triggers.vitellary/customwindtrigger.tooltips.onRoomEnter=Whether the wind trigger should activate immediately when the player enters its room, regardless of the player position.
+placements.triggers.vitellary/customwindtrigger.tooltips.fixUpdateDepth=Whether the wind should always update before the player. If unchecked, whether it updates before or after the player is able to change depending on load order, resulting in inconsistent behavior.
 
 # Player Timestop Trigger
 placements.triggers.vitellary/nomovetrigger.tooltips.stopLength=Determines how long the player will be frozen for.

Ahorn/triggers/customWindTrigger.jl

@@ -2,9 +2,9 @@ module CustomWindTrigger
 
 using ..Ahorn, Maple
 
-const actTypes = ["", "Seed", "Strawberry", "Keyberry", "Locked Door", "Refill", "Jellyfish", "Theo", "Core Mode (Hot)", "Core Mode (Cold)", "Death"]
+const actTypes = ["", "Seeds", "Strawberry", "Keyberry", "Locked Door", "Refill", "Jellyfish", "Theo", "Core Mode (Hot)", "Core Mode (Cold)", "Death"]
 
-@mapdef Trigger "vitellary/customwindtrigger" Wind(x::Integer, y::Integer, width::Integer=Maple.defaultTriggerWidth, height::Integer=Maple.defaultTriggerHeight, speedX::String="0", speedY::String="0", alternationSpeed::String="0", catchupSpeed::Number=1.0, activationType::String="", loop::Bool=true, persist::Bool=false, oneUse::Bool=false, onRoomEnter::Bool=false)
+@mapdef Trigger "vitellary/customwindtrigger" Wind(x::Integer, y::Integer, width::Integer=Maple.defaultTriggerWidth, height::Integer=Maple.defaultTriggerHeight, speedX::String="0", speedY::String="0", alternationSpeed::String="0", catchupSpeed::Number=1.0, activationType::String="", loop::Bool=true, persist::Bool=false, oneUse::Bool=false, onRoomEnter::Bool=false, fixUpdateDepth::Bool=true)
 
 const placements = Ahorn.PlacementDict(
     "Custom Wind Trigger (Crystalline)" => Ahorn.EntityPlacement(
@@ -16,6 +16,6 @@ const placements = Ahorn.PlacementDict(
 Ahorn.editingOptions(entity::Wind) = Dict{String, Any}(
     "activationType" => actTypes
 )
-Ahorn.editingOrder(entity::Wind) = String["x", "y", "width", "height", "speedX", "speedY", "alternationSpeed", "catchupSpeed", "activationType", "onRoomEnter", "persist", "loop", "oneUse"]
+Ahorn.editingOrder(entity::Wind) = String["x", "y", "width", "height", "speedX", "speedY", "alternationSpeed", "catchupSpeed", "activationType", "onRoomEnter", "persist", "loop", "oneUse", "fixUpdateDepth"]
 
 end

Code/CustomWindController.cs

@@ -31,7 +31,7 @@ public static void Unload()
             On.Celeste.TheoCrystal.OnPickup -= TheoCrystal_OnPickup;
         }
 
-        public CustomWindController(List<float> speedX, List<float> speedY, List<float> alternateSpeed, float catchupSpeed, string activateType, bool loop, bool persist)
+        public CustomWindController(List<float> speedX, List<float> speedY, List<float> alternateSpeed, float catchupSpeed, string activateType, bool loop, bool persist, bool fixUpdateDepth)
         {
             active = false;
             Tag = Tags.TransitionUpdate;
@@ -42,9 +42,10 @@ public CustomWindController(List<float> speedX, List<float> speedY, List<float>
             this.activateType = activateType;
             this.loop = loop;
             if (persist)
-            {
                 Tag |= Tags.Global | Tags.Persistent;
-            }
+
+            if (fixUpdateDepth)
+                Depth = 1;
         }
 
         public override void Update()
@@ -240,7 +241,7 @@ public void ActivateWind(bool debug = false)
 
         public void DeactivateWind()
         {
-            if (!active) { return; }
+            if (!active) return;
             active = false;
             if (coroutine != null)
             {

Code/CustomWindTrigger.cs

@@ -18,7 +18,7 @@ public CustomWindTrigger(EntityData data, Vector2 offset) : base(data, offset)
         {
             speedX = new List<float>();
             string[] speedXStrings = data.Attr("speedX", "0").Split(',');
-            foreach(string sx in speedXStrings)
+            foreach (string sx in speedXStrings)
             {
                 speedX.Add(float.Parse(sx));
             }
@@ -30,7 +30,7 @@ public CustomWindTrigger(EntityData data, Vector2 offset) : base(data, offset)
             }
             alternateSpeed = new List<float>();
             string[] alternateSpeedStrings = data.Attr("alternationSpeed", "0").Split(',');
-            foreach(string sa in alternateSpeedStrings)
+            foreach (string sa in alternateSpeedStrings)
             {
                 alternateSpeed.Add(float.Parse(sa));
             }
@@ -41,6 +41,7 @@ public CustomWindTrigger(EntityData data, Vector2 offset) : base(data, offset)
             oneUse = data.Bool("oneUse", false);
             ID = data.ID;
             onRoomEnter = data.Bool("onRoomEnter", false);
+            fixUpdateDepth = data.Bool("fixUpdateDepth", false);
         }
 
         public override void Awake(Scene scene)
@@ -65,7 +66,7 @@ public override void OnEnter(Player player)
             {
                 customWind.RemoveSelf();
             }
-            customWind = new CustomWindController(speedX, speedY, alternateSpeed, catchupSpeed, activateType, loop, persist);
+            customWind = new CustomWindController(speedX, speedY, alternateSpeed, catchupSpeed, activateType, loop, persist, fixUpdateDepth);
             Scene.Add(customWind);
             if (oneUse)
             {
@@ -97,5 +98,7 @@ public override void OnEnter(Player player)
         private int ID;
 
         private bool onRoomEnter;
+
+        private bool fixUpdateDepth;
     }
 }

Loenn/lang/en_gb.lang

@@ -342,14 +342,15 @@ entities.vitellary/dashcodecontroller.attributes.description.index=This sequence
 
 # Custom Wind Trigger
 triggers.vitellary/customwindtrigger.attributes.description.speedX=The horizontal speed of the wind. Can be a list of speeds, separated by commas. For reference, normal wind speed is 4, and strong is 8.
-triggers.vitellary/customwindtrigger.attributes.description.speedY=The vertical speed of the wind. Can be a list of speeds, separated by commas. For reference, normal wind speed is 4, and strong is 8.
+triggers.vitellary/customwindtrigger.attributes.description.speedY=The vertical speed of the wind. Can be a list of speeds, separated by commas. For reference, normal down wind speed is 3, and up is -4.
 triggers.vitellary/customwindtrigger.attributes.description.alternationSpeed=The time, in seconds, that it takes to switch between speeds if there is a list in either horizontal or vertical speed. Can also be a list of speeds, separated by commas, which will be looped through.
 triggers.vitellary/customwindtrigger.attributes.description.catchupSpeed=How fast the wind changes from the previous value. Default is 1.
 triggers.vitellary/customwindtrigger.attributes.description.activationType=Special condition for the wind to activate.
 triggers.vitellary/customwindtrigger.attributes.description.loop=Whether the wind should loop or just stop at the last values when going through a list of speeds.
 triggers.vitellary/customwindtrigger.attributes.description.persist=If true, the wind created will stay after transitioning to a different room or dying. It will still be replaced by other wind triggers.
 triggers.vitellary/customwindtrigger.attributes.description.oneUse=Whether the wind trigger should disappear after being used.
 triggers.vitellary/customwindtrigger.attributes.description.onRoomEnter=Whether the wind trigger should activate immediately when the player enters its room, regardless of the player position.
+triggers.vitellary/customwindtrigger.attributes.description.fixUpdateDepth=Whether the wind should always update before the player. If unchecked, whether it updates before or after the player is able to change depending on load order, resulting in inconsistent behavior.
 
 # Custom Wind Snow
 effects.CrystallineHelper/CustomWindSnow.attributes.description.colors=List of possible colors the wind particles can have, separated by commas.

Loenn/triggers/custom_wind_trigger.lua

@@ -1,6 +1,6 @@
 local activationTypes = {
     "",
-    "Seed",
+    "Seeds",
     "Strawberry",
     "Keyberry",
     "Locked Door",
@@ -35,7 +35,8 @@ customWindTrigger.placements = {
             loop = true,
             persist = false,
             oneUse = false,
-            onRoomEnter = false
+            onRoomEnter = false,
+            fixUpdateDepth = true
         }
     }
 }