How do I simplify this if-else purgatory?

Unity Engine
1

I’m trying to work up a generic method which I can use to manage all of my buffs: temporary status effects, permanent status effects, and effects over time (like DoTs or trickle heals). To this end, I have a base class StatusEffect, which has two public virtual functions: Apply, and Remove. Apply adds the specified effect to the player’s list of effects, while Remove removes the effect from the list.

Each buff has its own class, which extends StatusEffect and uses a public override void of the Apply and Remove classes to add stat changes, which is the central utility I need. This works perfectly for passive effects (“Strength + 5 until buff wears off”), but where I’m running into trouble is with active effects (“Lose 1HP every second”). I initially tried creating a bool activeEffect to indicate whether the buff’s effect should be applied once or every tick, but since Apply() includes a line that adds the effect to a list of effects, this produced an infinite loop. The way I’ve gotten around this is by using a separate version of Apply(), called Proc(), which contains all of Apply() except for the invocation of base.Apply() that adds the effect to the list. This works as desired, but it’s messy and full of conditionals and re-used code, which is bugging the heck out of me- is there a massively simpler way to refactor this that I’m not hitting on?

Base Effect class:

public int duration; //Measured in in-game minutes

public bool permanent;
public bool activeEffect = false;

public virtual void Apply(Character target){
     if (activeEffect) {
       target.activeEffects.Add(this);
     }
     else{
       target.passiveEffects.Add(this);
     }
}

     public virtual void Proc(Character target){
     }

public virtual void Remove (Character target){

     if (activeEffect) {
       target.activeEffects.Remove(this);
     }
     else{
       target.passiveEffects.Remove(this);
     }
   }
}

Extension in a specific buff (Heal.cs, Poison.cs, etc)

 public override void Apply(Character target){
         base.Apply (target);
         //Apply effects AND add to list
       }

       public override void Remove(Character target){
         base.Remove (target);
         //remove target from list, and remove effects
       }

       public override void Proc(Character target){
       //Apply effects, but do not add to list
       }

Processing active and passive buffs each tick:

  void ApplyBuffs(Character character){
     //Iterate through buffs/debuffs, and apply them
     for (int i = 0; i < character.passiveEffects.Count; i++) {   //Iterate through list of passive effects, decrement timer, and remove effects that have expired
       if (character.passiveEffects[i].permanent == false && character.passiveEffects[i].duration > 0)
         character.passiveEffects[i].duration -= 1;
       else
         character.passiveEffects[i].Remove(character);
     }
   }

   void ApplyActiveEffects(Character character){
     //Apply active effects
     for (int i = 0; i < character.activeEffects.Count; i++) {
       character.activeEffects[i].Proc(character);
     }
   
   }
2

Have you tried using events handlers?

using UnityEngine;

public class Character
{
    public delegate void UpdateBuffs(Character character);
    public event UpdateBuffs OnUpdateBuff;

    void UpdateCharacter()
    {
        OnUpdateBuff(this);
    }
}

public class Buff
{
    public void Apply(Character character)
    {
        character.OnUpdateBuff += UpdateBuff;
    }

    public void Remove(Character character)
    {
        character.OnUpdateBuff -= UpdateBuff;
    }

    public void UpdateBuff(Character character)
    {
        //  Apply the tick effect to the character here.
    }
}

That way, if your buff is not tick-orientented, you dont need to add its updatebuff fuction the the OnUpdateBuff event of the character. Or do it as you like, you can use multiple events, one for permanent buffs, other for tick buffs

Take a look at this : https://unity3d.com/pt/learn/tutorials/modules/intermediate/scripting/events

1 Like
3

Oh this is great, I didn’t even know that events were a thing, thank you! If you don’t mind two quick clarifications, though, I have one silly question and one logical problem: first off, does using events here remove the need to curate a list for active buffs? It appears to, as everything listening for the UpdateBuffs event means I don’t need to iterate through my list. However, if that’s the case, where does each Buff “live”? Most of the time, I’m not applying a permanent class, I’m doing something like running a function that reads

PoisonSpell(Character character){
Buff poisonBuff = new Buff();
//set all of poisonBuff's desired properties here
character.ActiveEffects.Add(poisonBuff);
}

That being the case, wouldn’t I want a second line in the Add and Remove functions in the base class in order to curate the list of buffs?

Second, I’m struggling a bit to figure out the most logical way to organize my events: there are three classes that need to interact here, a Timer class (whose only job is to keep time), a Simulator class (whose job is to know what time it is, and curate the character and NPC data), and a whole boatload of Character classes that belong to the player and NPCs, and that need to be edited by Simulator. Am I correct that the most logical way to approach this would be to declare a MinuteTick event in Timer, listen for that in Simulator, and declare a second event, UpdateBuff, that gets run by Simulator and listened for by each individual buff?

4

I think you want something like this.

using UnityEngine;
using System.Collections;
using System.Collections.Generic;

public class Simulator : MonoBehaviour
{

    public IList<Character> characters = new List<Character>();     //  A list of all the characters in your game.
    public delegate void UpdateSimulator(Simulator simulator);
    public event UpdateSimulator OnSimulatorUpdate;

    // Update is called once per frame
    void Update()
    {
        OnSimulatorUpdate(this);
        //  Additional simulator update goes here.
    }
}

public class Character
{
    public IList<IBuff> buffs = new List<IBuff>();        //  A list of the buffs the character has. You want to keep track of them to know whether or not a character has a specified buff.
    public delegate void CharacterUpdate(Character character);
    public event CharacterUpdate OncharacterUpdate;

    public void Add(Simulator simulator)
    {
        simulator.characters.Add(this);
        simulator.OnSimulatorUpdate += UpdateCharacter;
    }

    public void Remove(Simulator simulator)
    {
        simulator.characters.Remove(this);
        simulator.OnSimulatorUpdate -= UpdateCharacter;
    }

    public void UpdateCharacter(Simulator simulator)
    {
        OncharacterUpdate(this);
        //  Additional individual character updates would go here.
    }

}

public interface IBuff
{
    public string name;
    public Texture2D icon;

    public void Add(Character target);

    public void Remove(Character target);

    public void UpdateBuff(Character target);
}

public class PermanentBuff : IBuff
{
    public string name;
    public Texture2D icon;

    public void Add(Character target)
    {
        target.buffs.Add(this);
        target.OncharacterUpdate += UpdateBuff;     //  Permanent buffs dont really need this, but they could have just in case you want to change something in them over time. Example, a permanent buff that heals the character by a % of his life every second. It is permanent and wont be removed ever, but has effects over time.
        //  Apply permanent buff effects here.
    }

    public void Remove(Character target)
    {
        target.buffs.Remove(this);
        target.OncharacterUpdate -= UpdateBuff;
        //  Remove permanent buff effects here.
    }

    public void UpdateBuff(Character target)
    {
    }
}

public class TemporaryBuff : IBuff
{
    public string name;
    public Texture2D icon;
    public float duration;      //  This is a unique value for the temporary buffs

    public void Add(Character target)
    {
        target.buffs.Add(this);
        target.OncharacterUpdate += UpdateBuff;
        //  Maybe the temporary buff has some special effect upon activation?
    }

    public void Remove(Character target)
    {
        target.buffs.Remove(this);
        target.OncharacterUpdate -= UpdateBuff;
        //  Maybe the temporary buff has some special effect upon deactivation?
    }

    public void UpdateBuff(Character target)
    {
        UpdateDuration(target);
        //  Over tim effects go here.
    }

    private void UpdateDuration(Character target)   //  This is a unique method for the temporary buffs.
    {
        duration -= Time.deltaTime;
        if (duration < 0)
        {
            Remove(target);
        }
    }
}

You could also add more events to the simulator, such as OnGUI and assign characters OnGUI to those, i think unity supports that for GUI, not sure.

5

And for the spells :

public interface IActiveSpell : ISpell
{
    public string name;
    public Texture2D icon;

    public void Activate(Character target);
}

public class PoisonSpell : IActiveSpell
{
    public string name;
    public Texture2D icon;

    public void Activate(Character target)
    {
        PoisonBuff b = new PoisonBuff();    //  You could pass the level of the buff and other information to it.
        b.Add(target);
    }
}

public class PoisonBuff : TemporaryBuff     //  In this case, Temporary buff could also be a interface.
{
    public string name;
    public Texture2D icon;
    public float duration;

    public void Add(Character target)
    {
        target.buffs.Add(this);
        target.OncharacterUpdate += UpdateBuff;
    }

    public void Remove(Character target)
    {
        target.buffs.Remove(this);
        target.OncharacterUpdate -= UpdateBuff;
    }

    public void UpdateBuff(Character target)
    {
        UpdateDuration(target);
        //  target.health -= 1.0f;
    }

    private void UpdateDuration(Character target)
    {
        duration -= Time.deltaTime;
        if (duration < 0)
        {
            Remove(target);
        }
    }
}

There are lots of ways of doing this, this one uses unique buffs and unique spell scripts for each spell or buff.
You could use generic buff scripts, and use events to these buffs and use the spell to apply the desired effect over time using the buff events, that way each spell would use a generic buff script and a unique spell script.

EDIT : Oh, you actually cant use fields on the interfaces, so you would need an abstract class for each interface i guess.

6

Holy cow, that’s a heck of a piece of work Mathias, thank you! :slight_smile: between this and your suggestion of looking at event handlers, I’m getting a pretty nifty system assembled: right now I’m handling the duration issue with inheritance, although now that I’ve seen this, I think that interfaces might be more efficient… the way I do it right now, the inheritance chain goes Buff > TimedBuff > . The only difference between them is that TimedBuff overrides UpdateBuff with an extra three lines to check the duration and reduce the timer if it’s >0, or call Buff.Remove(this) if it’s expired. Buffs that proc once are added and removed in Apply/Remove, buffs that proc every tick do so in UpdateBuff. It’s a tiny bit more work to create, but it’s pretty fast.