Species (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.pokemon.species.Species

All Implemented Interfaces:

ITranslatable, java.lang.Comparable<Species>
```
public class Species
extends java.lang.Object
implements ITranslatable, java.lang.Comparable<Species>
```
A class representing each unique Pokemon

Field Summary

Fields
Modifier and Type Field and Description

static com.google.gson.Gson GSON

Fields
Modifier and Type	Field and Description
`static com.google.gson.Gson`	`GSON`

Constructor Summary

Constructors
Constructor and Description
`Species(java.lang.String name, java.lang.String translationKey, int dex, int generation, java.util.Collection<java.lang.String> defaultForms, java.util.Collection<Stats> forms, java.lang.String json)` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Species species)`
`void`	`decode(net.minecraft.network.PacketBuffer buf)`
`void`	`encode(net.minecraft.network.PacketBuffer buf)`
`boolean`	`equals(java.lang.Object o)`
`Stats`	`getDefaultForm()` Gets a `Stats` for a random default form of the Pokémon
`Stats`	`getDefaultFormExcluding(java.lang.String... forms)` Gets a `Stats` for a random default form of the Pokémon
`java.util.List<java.lang.String>`	`getDefaultFormNames()` Gets the name of the default form
`java.util.List<Stats>`	`getDefaultForms()` Gets the name of the default form
`net.minecraft.util.text.TranslationTextComponent`	`getDescTranslation()`
`java.lang.String`	`getDescTranslationKey()`
`int`	`getDex()` Gets the national Pokédex number for the pokemon
`Stats`	`getFirstForm()` Gets the `Stats` for the first default form of the Pokémon
`PaletteProperties`	`getFirstPaletteProperties()` Gets the `Stats` for the first default form of the Pokémon
`Stats`	`getForm(java.lang.String formName)` Gets the form of the species from the given name.
`java.lang.String`	`getFormattedDex()` Gets the formatted national dex number (i.e.
`java.util.List<Stats>`	`getForms()` Gets the list of all potential forms of the Pokémon
`java.util.List<Stats>`	`getForms(boolean temporary)` Gets all the forms of a species excluding, or including, temporary forms
`java.util.List<Stats>`	`getForms(java.util.function.Predicate<Stats> predicate)` Gets forms that match the given predicate
`java.util.List<Stats>`	`getForms(java.lang.String... tags)`
`int`	`getGeneration()` Gets the Pokémon's generation
`java.lang.String`	`getJson()`
`java.lang.String`	`getName()` Gets the English name for the Pokémon
`net.minecraft.util.text.TranslationTextComponent`	`getNameTranslation()`
`java.lang.String`	`getNameTranslationKey()`
`RegistryValue<Species>`	`getRegistryValue()` Gets the registry value for this species
`java.lang.String`	`getTranslationKey()`
`boolean`	`hasFlaggedForm(boolean temporary, java.lang.String... flags)` Checks if any of the forms of the species contain the given flags
`boolean`	`hasForm(java.lang.String form)` Checks if the `Species` has a form
`boolean`	`hasFormWithType(Element type)` Checks if any of the forms of the species contain the type specified
`int`	`hashCode()`
`boolean`	`is(java.util.Optional<Species>... species)` Checks if any of the species registry objects provided in the array are equal to this species (checks by national dex number)
`boolean`	`is(RegistryValue<Species>... species)`
`boolean`	`is(Species... species)` Checks if any of the species provided in the array are equal to this species (checks by national dex number)
`boolean`	`isDefaultForm(Stats form)`
`boolean`	`isDefaultForm(java.lang.String form)`
`boolean`	`isLegendary()` Checks if this species is legendary
`boolean`	`isMythical()` Checks if this species is mythical
`boolean`	`isUltraBeast()` Checks if this species is ultrabeast

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pixelmonmod.pixelmon.api.util.ITranslatable
getLocalizedName, getTranslatedName

- Field Detail
  - GSON
```
public static final com.google.gson.Gson GSON
```
- Constructor Detail
  - Species
```
public Species(java.lang.String name,
               java.lang.String translationKey,
               int dex,
               int generation,
               java.util.Collection<java.lang.String> defaultForms,
               java.util.Collection<Stats> forms,
               java.lang.String json)
```
    Default constructor
    
    Parameters:
    
    name - The English name of the species.
    
    dex - The national Pokédex number.
    
    defaultForms - The Pokémon's default forms.
    
    forms - All potential forms of the Pokémon.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the English name for the Pokémon
    
    Returns:
    
    The English name
  - getDex
```
public int getDex()
```
    Gets the national Pokédex number for the pokemon
    
    Returns:
    
    The national dex number
  - getFormattedDex
```
public java.lang.String getFormattedDex()
```
    Gets the formatted national dex number (i.e. 001)
    
    Returns:
    
    The formatted dex number
  - getRegistryValue
```
public RegistryValue<Species> getRegistryValue()
```
    Gets the registry value for this species
    
    Returns:
    
    The registry value
  - getDefaultFormNames
```
public java.util.List<java.lang.String> getDefaultFormNames()
```
    Gets the name of the default form
    
    Returns:
    
    The name
  - isDefaultForm
```
public boolean isDefaultForm(java.lang.String form)
```
  - isDefaultForm
```
public boolean isDefaultForm(Stats form)
```
  - getDefaultForms
```
public java.util.List<Stats> getDefaultForms()
```
    Gets the name of the default form
    
    Returns:
    
    The name
  - getDefaultForm
```
public Stats getDefaultForm()
```
    Gets a Stats for a random default form of the Pokémon
    
    Returns:
    
    A default form
  - getFirstForm
```
public Stats getFirstForm()
```
    Gets the Stats for the first default form of the Pokémon
    
    Returns:
    
    The first form
  - getDefaultFormExcluding
```
public Stats getDefaultFormExcluding(java.lang.String... forms)
```
    Gets a Stats for a random default form of the Pokémon
    
    Returns:
    
    A default form
  - getForms
```
public java.util.List<Stats> getForms()
```
    Gets the list of all potential forms of the Pokémon
    
    Returns:
    
    All forms
  - getForm
```
public Stats getForm(java.lang.String formName)
```
    Gets the form of the species from the given name. Will return null if not found
    
    Parameters:
    
    formName - The name of the form
    
    Returns:
    
    The found form
  - getForms
```
public java.util.List<Stats> getForms(boolean temporary)
```
    Gets all the forms of a species excluding, or including, temporary forms
    
    Parameters:
    
    temporary - If temporary forms should be included
    
    Returns:
    
    All forms for the species
  - getForms
```
public java.util.List<Stats> getForms(java.lang.String... tags)
```
  - hasFlaggedForm
```
public boolean hasFlaggedForm(boolean temporary,
                              java.lang.String... flags)
```
    Checks if any of the forms of the species contain the given flags
    
    Parameters:
    
    temporary - If it should also include temporary forms in the search
    
    flags - The flags to search for
    
    Returns:
    
    True if a form has one of the flags
  - hasFormWithType
```
public boolean hasFormWithType(Element type)
```
    Checks if any of the forms of the species contain the type specified
    
    Parameters:
    
    type - The type to search against
    
    Returns:
    
    True if a form has the specified type
  - getForms
```
public java.util.List<Stats> getForms(java.util.function.Predicate<Stats> predicate)
```
    Gets forms that match the given predicate
    
    Parameters:
    
    predicate - The test case
    
    Returns:
    
    The forms that match the test
  - getFirstPaletteProperties
```
public PaletteProperties getFirstPaletteProperties()
```
    Gets the Stats for the first default form of the Pokémon
    
    Returns:
    
    The first form
  - getGeneration
```
public int getGeneration()
```
    Gets the Pokémon's generation
    
    Returns:
    
    The generation
  - getTranslationKey
```
public java.lang.String getTranslationKey()
```
    Specified by:
    
    getTranslationKey in interface ITranslatable
  - getNameTranslationKey
```
public java.lang.String getNameTranslationKey()
```
  - getDescTranslationKey
```
public java.lang.String getDescTranslationKey()
```
  - getNameTranslation
```
public net.minecraft.util.text.TranslationTextComponent getNameTranslation()
```
  - getDescTranslation
```
public net.minecraft.util.text.TranslationTextComponent getDescTranslation()
```
  - is
```
public boolean is(Species... species)
```
    Checks if any of the species provided in the array are equal to this species (checks by national dex number)
    
    Parameters:
    
    species - The species to check
    
    Returns:
    
    Whether a match was found
  - is
```
@SafeVarargs
public final boolean is(java.util.Optional<Species>... species)
```
    Checks if any of the species registry objects provided in the array are equal to this species (checks by national dex number)
    
    Parameters:
    
    species - The species to check
    
    Returns:
    
    Whether a match was found
  - is
```
@SafeVarargs
public final boolean is(RegistryValue<Species>... species)
```
  - hasForm
```
public boolean hasForm(java.lang.String form)
```
    Checks if the Species has a form
    
    Returns:
    
    True if the form is present
  - isLegendary
```
public boolean isLegendary()
```
    Checks if this species is legendary
    
    Returns:
    
    True if legendary
  - isUltraBeast
```
public boolean isUltraBeast()
```
    Checks if this species is ultrabeast
    
    Returns:
    
    True if ultrabeast
  - isMythical
```
public boolean isMythical()
```
    Checks if this species is mythical
    
    Returns:
    
    True if mythical
  - decode
```
public void decode(net.minecraft.network.PacketBuffer buf)
```
  - encode
```
public void encode(net.minecraft.network.PacketBuffer buf)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getJson
```
public java.lang.String getJson()
```
  - compareTo
```
public int compareTo(Species species)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Species>

Class Species

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

GSON

Constructor Detail

Species

Method Detail

getName

getDex

getFormattedDex

getRegistryValue

getDefaultFormNames

isDefaultForm

isDefaultForm

getDefaultForms

getDefaultForm

getFirstForm

getDefaultFormExcluding

getForms

getForm

getForms

getForms

hasFlaggedForm

hasFormWithType

getForms

getFirstPaletteProperties

getGeneration

getTranslationKey

getNameTranslationKey

getDescTranslationKey

getNameTranslation

getDescTranslation

is

is

is

hasForm

isLegendary

isUltraBeast

isMythical

decode

encode

equals

hashCode

getJson

compareTo