Package com.pixelmonmod.pixelmon.battles.api.rules.modifier

Interface BattleModifier

All Known Implementing Classes:
ContextBattleModifier, SyncContextBattleModifier
public interface BattleModifier
Represents a modifier that can be applied to a battle.
The intention is for these to be used at the start of the battle to set up any properties that will affect the battle.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<BattleModifier>
    CODEC
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    apply(BattleController controller)
    Applies this battle modifier to the given battle controller.
    com.mojang.serialization.MapCodec<? extends BattleModifier>
    codec()
    Returns the codec for this battle modifier.
    BattleModifierType<? extends BattleModifier>
    type()
    Returns the type of this battle modifier.

  • Field Details

    • CODEC

      static final com.mojang.serialization.Codec<BattleModifier> CODEC

  • Method Details

    • codec

      com.mojang.serialization.MapCodec<? extends BattleModifier> codec()
      Returns the codec for this battle modifier.
      Returns:
      The codec for this battle modifier.

    • type

      BattleModifierType<? extends BattleModifier> type()
      Returns the type of this battle modifier.
      Returns:
      The type of this battle modifier.

    • apply

      void apply(BattleController controller)
      Applies this battle modifier to the given battle controller.
      Parameters:
      controller - The battle controller to apply the modifier to.