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

Interface BattleRequirement

All Known Implementing Classes:
ItemBanBattleRequirement, LogicalANDBattleRequirement, LogicalORBattleRequirement, NoDuplicateItemBattleRequirement, NoDuplicateSpecBattleRequirement, NoDuplicateSpeciesBattleRequirement, SpecBasedAllowListBattleRequirement, SpecBasedBanBattleRequirement, SpeedBattleRequirement
public interface BattleRequirement
Represents a requirement that must be met for the battle to be able to start.
This will check the Pokémon in the party against the requirement and return true if the requirement is met, and false if it is not.

  • Field Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.mojang.serialization.MapCodec<? extends BattleRequirement>
    codec()
    Returns the codec for this requirement.
    BattleRequirementType<? extends BattleRequirement>
    type()
    Returns the type of this requirement.
    boolean
    validate(Pokemon... party)
    Validates the requirement against the given Pokémon party.

  • Field Details

  • Method Details

    • codec

      com.mojang.serialization.MapCodec<? extends BattleRequirement> codec()
      Returns the codec for this requirement.
      Returns:
      The codec for this requirement.

    • type

      BattleRequirementType<? extends BattleRequirement> type()
      Returns the type of this requirement.
      Returns:
      The type of this requirement.

    • validate

      boolean validate(Pokemon... party)
      Validates the requirement against the given Pokémon party.
      Parameters:
      party - The Pokémon party to validate against this requirement.
      Returns:
      True if the requirement is met, false otherwise.