Merge pull request #113 from EverestAPI/bubble_field_flag_control

Add flag activation options to Bubble Push Fields

Author: 0x0ade

Ahorn/entities/bubblePushField.jl

@@ -2,7 +2,8 @@
 
 using ..Ahorn, Maple
 
-@mapdef Entity "SpringCollab2020/bubblePushField" BubblePushField(x::Integer, y::Integer, width::Integer=Maple.defaultBlockWidth, height::Integer=Maple.defaultBlockHeight, strength::Number=1, upwardStrength::Number=1, direction::String="Right", water::Bool=true)
+@mapdef Entity "SpringCollab2020/bubblePushField" BubblePushField(x::Integer, y::Integer, width::Integer=Maple.defaultBlockWidth, height::Integer=Maple.defaultBlockHeight,
+	strength::Number=1, upwardStrength::Number=1, direction::String="Right", water::Bool=true, flag::String="bubble_push_field", activationMode::String="Always")
 
 const placements = Ahorn.PlacementDict(
 	"Bubble Column (Spring Collab 2020)" => Ahorn.EntityPlacement(
@@ -12,7 +13,8 @@ const placements = Ahorn.PlacementDict(
 )
 
 Ahorn.editingOptions(entity::BubblePushField) = Dict{String,Any}(
-	"direction" => ["Up", "Down", "Left", "Right"]
+	"direction" => ["Up", "Down", "Left", "Right"],
+	"activationMode" => ["Always", "OnlyWhenFlagActive", "OnlyWhenFlagInactive"]
 )
 
 Ahorn.minimumSize(entity::BubblePushField) = 8, 8

Ahorn/lang/en_gb.lang

@@ -47,6 +47,8 @@ placements.entities.SpringCollab2020/bubblePushField.tooltips.strength=The stren
 placements.entities.SpringCollab2020/bubblePushField.tooltips.upwardStrength=How much the bubbles push the player up to compensate for gravity.
 placements.entities.SpringCollab2020/bubblePushField.tooltips.direction=The direction the bubbles push the player.
 placements.entities.SpringCollab2020/bubblePushField.tooltips.water=If the bubble field will create a Water entity to make its presence visible.
+placements.entities.SpringCollab2020/bubblePushField.tooltips.activationMode=Determines on which condition the bubble column activates.
+placements.entities.SpringCollab2020/bubblePushField.tooltips.flag=The session flag this bubble push field reacts to (when Activation Mode is "only if flag (in)active").
 
 # Upside Down Jump Thru
 placements.entities.SpringCollab2020/UpsideDownJumpThru.tooltips.texture=Changes the appearance of the platform.

Entities/BubblePushField.cs

@@ -7,6 +7,10 @@
 namespace Celeste.Mod.SpringCollab2020.Entities {
     [CustomEntity("SpringCollab2020/bubblePushField")]
     class BubblePushField : Entity {
+        public enum ActivationMode {
+            Always, OnlyWhenFlagActive, OnlyWhenFlagInactive
+        }
+
         public float Strength;
 
         public float UpwardStrength;
@@ -26,21 +30,28 @@ class BubblePushField : Entity {
 
         public PushDirection Direction;
 
+        private ActivationMode activationMode;
+        private string flag;
+
         public BubblePushField(EntityData data, Vector2 offset) : this(
             data.Position + offset,
             data.Width,
             data.Height,
             data.Float("strength", 1f),
             data.Float("upwardStrength", 1f),
             data.Attr("direction", "right"),
-            data.Bool("water", true)
+            data.Bool("water", true),
+            data.Enum("activationMode", ActivationMode.Always),
+            data.Attr("flag", "bubble_push_field")
             ) { }
 
-        public BubblePushField(Vector2 position, int width, int height, float strength, float upwardStrength, string direction, bool water) {
+        public BubblePushField(Vector2 position, int width, int height, float strength, float upwardStrength, string direction, bool water, ActivationMode activationMode, string flag) {
             Position = position;
             Strength = strength;
             UpwardStrength = upwardStrength;
             _water = water;
+            this.activationMode = activationMode;
+            this.flag = flag;
 
             Rand = new Random();
 
@@ -70,6 +81,14 @@ public override void Render() {
         public override void Update() {
             base.Update();
 
+            Session session = SceneAs<Level>().Session;
+            if ((activationMode == ActivationMode.OnlyWhenFlagActive && !session.GetFlag(flag)) 
+                || (activationMode == ActivationMode.OnlyWhenFlagInactive && session.GetFlag(flag))) {
+
+                // the bubble push field is currently turned off by a session flag.
+                return;
+            }
+
             FramesSinceSpawn++;
             if (FramesSinceSpawn == SpawnFrame) {
                 FramesSinceSpawn = 0;