Package com.pixelmonmod.pixelmon.api.pokemon.egg

Interface EggGroup

All Superinterfaces:
ITranslatable
All Known Implementing Classes:
AbstractEggGroup, BasicEggGroup, UndiscoveredEggGroup, UniversalEggGroup
public interface EggGroup extends ITranslatable
Interface representing a type of egg group
Since:
24/06/2022

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canBreed(Gender first, Gender second)
    Checks if the two Gender
    boolean
    canBreedWith(EggGroup other)
    Checks if the other egg group can breed with this egg group Make sure it is consistent in both directions (i.e.
    boolean
    canBreedWith(EggGroup... others)
    Checks if this egg group can breed with any of the given other egg groups Will return true if a single one works
    boolean
    canBreedWith(List<EggGroup> others)
    Checks if this egg group can breed with any of the given other egg groups Will return true if a single one works
    int
    getIndex()
    Gets the index of the egg group from the game's index
    String
    getKey()
    Gets the unique identifying key of the egg

    Methods inherited from interface com.pixelmonmod.pixelmon.api.util.ITranslatable

    getLocalizedName, getTranslatedName, getTranslationKey

  • Method Details

    • getIndex

      int getIndex()
      Gets the index of the egg group from the game's index
      Returns:
      The game index

    • getKey

      String getKey()
      Gets the unique identifying key of the egg
      Returns:
      The identifying key

    • canBreed

      boolean canBreed(Gender first, Gender second)
      Checks if the two Gender
      Parameters:
      first - The first gender
      second - The second gender
      Returns:
      True if they can breed

    • canBreedWith

      boolean canBreedWith(List<EggGroup> others)
      Checks if this egg group can breed with any of the given other egg groups Will return true if a single one works
      Parameters:
      others - The egg groups being checked
      Returns:
      True if it works

    • canBreedWith

      boolean canBreedWith(EggGroup... others)
      Checks if this egg group can breed with any of the given other egg groups Will return true if a single one works
      Parameters:
      others - The egg groups being checked
      Returns:
      True if it works

    • canBreedWith

      boolean canBreedWith(EggGroup other)
      Checks if the other egg group can breed with this egg group Make sure it is consistent in both directions (i.e. if it returns true in this one, it should return true in the other one)
      Parameters:
      other - The other egg group to check
      Returns:
      True if they can breed together, false if not