Class EffectManager

java.lang.Object
studio.magemonkey.fabled.api.particle.EffectManager

public class EffectManager extends Object
Handles the management of particle effects and related components
  • Constructor Details

    • EffectManager

      public EffectManager()
  • Method Details

    • init

      public static void init()
      Initializes the utility, loading formulas from the config file
    • cleanUp

      public static void cleanUp()
    • register

      public static void register(IParticleEffect effect)
      Registers a new particle effect, replacing any conflicting effects already registered under the key
      Parameters:
      effect - effect to register
    • register

      public static void register(String key, PolarSettings formula)
      Registers a new formula for effects
      Parameters:
      key - key to register under
      formula - formula to register
    • getFormula

      public static PolarSettings getFormula(String key)
      Gets a formula by key
      Parameters:
      key - formula key
      Returns:
      formula
    • getEffect

      public static IParticleEffect getEffect(String name)
      Fetches an effect by key
      Parameters:
      name - name of the effect
      Returns:
      particle effect
    • clear

      public static void clear(EffectTarget target)
      Clears effects for a given target
      Parameters:
      target - target to clear for
    • clear

      public static void clear(org.bukkit.entity.LivingEntity target)
      Clears effects for a given target
      Parameters:
      target - target to clear for
    • getEffectData

      public static EffectData getEffectData(EffectTarget target)
      Gets the effect data for the given target
      Parameters:
      target - target to get the data for
      Returns:
      effect data for the target or null if it doesn't exist
    • getEffect

      public static EffectInstance getEffect(EffectTarget target, String key)
      Fetches an active effect for a given target
      Parameters:
      target - target to get the effect for
      key - effect key
      Returns:
      active effect or null if not found
    • runEffect

      public static void runEffect(IParticleEffect effect, EffectTarget target, int ticks, int level)
      Starts running an effect for a target. If the effect is already running for the target, the running effect will be stopped before the new one is started.
      Parameters:
      effect - effect to run
      target - target to run for
      ticks - ticks to run for
      level - effect level
    • tick

      public static void tick()
      Ticks all active effects