PokemonSpec (Pixelmon 1.12.2-8.4.0 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.pokemon.PokemonSpec

```
public class PokemonSpec
extends java.lang.Object
```
An object representation of the basic data specifications associated with a Pokémon. This object is designed for loading from command arguments and then creating or applying to Pokémon (in EntityPixelmon or NBT form) these characteristics.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PokemonSpec.Adapter

Nested Classes
Modifier and Type	Class and Description
`static class`	`PokemonSpec.Adapter`

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`ability` The name of the `AbilityBase` of the Pokémon
`java.lang.String[]`	`args` The original strings used to create the spec.
`java.lang.Byte`	`ball` The PokéBall shown as that used to catch the Pokémon
`java.lang.Byte`	`boss` The index of the `EnumBossMode` of the Pokémon
`java.lang.Boolean`	`egg` Whether or not the Pokémon should be an egg or not.
`java.util.ArrayList<SpecValue<?>>`	`extraSpecs`
`static java.util.List<ISpecType>`	`extraSpecTypes` The extra types of spec values that should be interpreted.
`java.lang.Byte`	`form` The form number of the Pokémon
`java.lang.Boolean`	`formInvert` Whether we should invert the search for form index
`java.lang.String`	`formString`
`java.lang.Byte`	`gender` The index of `Gender` gender of the Pokémon
`java.lang.Boolean`	`gmaxFactor` Whether or not the Pokémon has the Gigantamax Factor.
`java.lang.Byte`	`growth` The index of the `EnumGrowth` of the Pokémon
`java.lang.Integer`	`level` The level of the Pokémon
`java.lang.String`	`name` The name of the Pokémon
`java.lang.Byte`	`nature` The index of the `EnumNature` of the Pokémon.
`java.lang.Byte`	`pokerusSpread`
`java.lang.Byte`	`pokerusType` The index of the `EnumPokerusType` of the Pokémon, if any.
`java.util.ArrayList<EnumRibbonType>`	`ribbons`
`java.lang.Boolean`	`shiny` Whether the Pokémon must be shiny or must not be shiny.
`static PokemonSpec.Adapter`	`SPEC_ADAPTER` Type adapter for PokemonSpecs which supports object form or simple string forms of specs.
`static SpecValueTypeAdapter`	`SPEC_VALUE_TYPE_ADAPTER` Type adapter for JSON deserializing additional spec values added by sidemods.

Constructor Summary

Constructors
Constructor and Description

PokemonSpec(io.netty.buffer.ByteBuf buf)

PokemonSpec(java.lang.String... args)

PokemonSpec(java.lang.String arg)

Constructors
Constructor and Description
`PokemonSpec(io.netty.buffer.ByteBuf buf)`
`PokemonSpec(java.lang.String... args)`
`PokemonSpec(java.lang.String arg)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`apply(EntityPixelmon pokemon)` Applies the data from this `PokemonSpec` onto the given `EntityPixelmon`
`void`	`apply(net.minecraft.nbt.NBTTagCompound nbt)` Deprecated.
`void`	`apply(Pokemon pokemon)`
`PokemonSpec`	`copy()`
`Pokemon`	`create()`
`EntityPixelmon`	`create(net.minecraft.world.World world)` Creates an `EntityPixelmon` in the given world based on this specification.
`boolean`	`equals(java.lang.Object o)`
`static PokemonSpec`	`from(java.lang.String... args)` Creates a `PokemonSpec` based on a collection of String arguments, generally from a command.
`static PokemonSpec`	`from(java.lang.String arg)` Creates a `PokemonSpec` from the collection of argument represented as a String where each argument is seperated by a space.
`void`	`fromBytes(io.netty.buffer.ByteBuf buf)`
`static ISpecType`	`getSpecForKey(java.lang.String key)`
`int`	`hashCode()`
`boolean`	`matches(EntityPixelmon pokemon)` Determines whether the given EntityPixelmon matches the specification
`boolean`	`matches(net.minecraft.nbt.NBTTagCompound nbt)` Deprecated.
`boolean`	`matches(Pokemon pokemon)`
`PokemonSpec`	`readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)`
`static void`	`registerDefaultExtraSpecs()`
`void`	`toBytes(io.netty.buffer.ByteBuf buf)`
`java.lang.String`	`toString()`
`net.minecraft.nbt.NBTTagCompound`	`writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)`

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

- Field Detail
  - SPEC_VALUE_TYPE_ADAPTER
```
public static final SpecValueTypeAdapter SPEC_VALUE_TYPE_ADAPTER
```
    Type adapter for JSON deserializing additional spec values added by sidemods.
  - SPEC_ADAPTER
```
public static final PokemonSpec.Adapter SPEC_ADAPTER
```
    Type adapter for PokemonSpecs which supports object form or simple string forms of specs.
  - extraSpecTypes
```
public static final java.util.List<ISpecType> extraSpecTypes
```
    The extra types of spec values that should be interpreted. Sidemods should add to this list during pre-initialization.
  - args
```
public java.lang.String[] args
```
    The original strings used to create the spec. Might contain junk and artifacts.
  - name
```
public java.lang.String name
```
    The name of the Pokémon
  - level
```
public java.lang.Integer level
```
    The level of the Pokémon
  - gender
```
public java.lang.Byte gender
```
    The index of Gender gender of the Pokémon
  - growth
```
public java.lang.Byte growth
```
    The index of the EnumGrowth of the Pokémon
  - nature
```
public java.lang.Byte nature
```
    The index of the EnumNature of the Pokémon.
  - ability
```
public java.lang.String ability
```
    The name of the AbilityBase of the Pokémon
  - boss
```
public java.lang.Byte boss
```
    The index of the EnumBossMode of the Pokémon
  - shiny
```
public java.lang.Boolean shiny
```
    Whether the Pokémon must be shiny or must not be shiny. Null is no preference; not necessarily one or the other.
  - formInvert
```
public java.lang.Boolean formInvert
```
    Whether we should invert the search for form index
  - form
```
public java.lang.Byte form
```
    The form number of the Pokémon
  - formString
```
public java.lang.String formString
```
  - ball
```
public java.lang.Byte ball
```
    The PokéBall shown as that used to catch the Pokémon
  - pokerusType
```
public java.lang.Byte pokerusType
```
    The index of the EnumPokerusType of the Pokémon, if any.
  - pokerusSpread
```
public java.lang.Byte pokerusSpread
```
  - egg
```
public java.lang.Boolean egg
```
    Whether or not the Pokémon should be an egg or not. Note: the default is null, not false, false will actually change the output of #matches(). ServerQueryPC.search(PokemonStorage, String)
  - gmaxFactor
```
public java.lang.Boolean gmaxFactor
```
    Whether or not the Pokémon has the Gigantamax Factor. Only works on species that can have it.
  - ribbons
```
public java.util.ArrayList<EnumRibbonType> ribbons
```
  - extraSpecs
```
public java.util.ArrayList<SpecValue<?>> extraSpecs
```
- Constructor Detail
  - PokemonSpec
```
public PokemonSpec(io.netty.buffer.ByteBuf buf)
```
  - PokemonSpec
```
public PokemonSpec(java.lang.String arg)
```
  - PokemonSpec
```
public PokemonSpec(java.lang.String... args)
```
- Method Detail
  - getSpecForKey
```
public static ISpecType getSpecForKey(java.lang.String key)
```
  - from
```
public static PokemonSpec from(java.lang.String arg)
```
    Creates a PokemonSpec from the collection of argument represented as a String where each argument is seperated by a space. Once split it uses from(String...) to parse them into a PokemonSpec
    
    Parameters:
    
    arg - The pokemon args
    
    Returns:
    
    - The PokemonSpec representation of the given characteristics
  - from
```
public static PokemonSpec from(java.lang.String... args)
```
    Creates a PokemonSpec based on a collection of String arguments, generally from a command. Badly formatted arguments are ignored. All arguments bar ability are case insensitive. Additionally, the nature, growth, and boss arguments may be replaced with numerical equivalents.
    
    Parameters:
    
    args - - The String array with each arg. An example of the format for each piece of data:
    Example command: /pokespawn Kingdra lvl:5 gr:Enormous n:Modest ab:Sniper b:Legendary !s
    
    Kingdra - A Kingdra
    
    lvl:5 - Kingdra of level 5
    
    gr:Enormous - Kingdra with the Enormous growth level
    
    n:Modest - Kingdra with a Modest nature
    
    ab:Sniper - Kingdra with the Sniper ability
    
    boss:Legendary - Kingdra with a boss mode of Legendary
    
    !s - Kingdra that must not be shiny
    
    f:1 - Kingdra that is of the imaginary second form. Think Burmy.
    
    ba:dive - Kingdra that is in a Dive Ball
    
    Returns:
    
    - The PokemonSpec representation of the given characteristics
  - copy
```
public PokemonSpec copy()
```
  - fromBytes
```
public void fromBytes(io.netty.buffer.ByteBuf buf)
```
  - toBytes
```
public void toBytes(io.netty.buffer.ByteBuf buf)
```
  - matches
```
@Deprecated
public boolean matches(net.minecraft.nbt.NBTTagCompound nbt)
```
    Deprecated.
    
    Determines whether the given NBTTagCompound for a Pokémon matches the specification
    
    Parameters:
    
    nbt - - The NBTTagCompound representation of a Pokémon
    
    Returns:
    
    - true if they match the criteria, false otherwise
  - matches
```
public boolean matches(EntityPixelmon pokemon)
```
    Determines whether the given EntityPixelmon matches the specification
    
    Parameters:
    
    pokemon - - The EntityPixelmon representation of a Pokémon
    
    Returns:
    
    - true if they match the criteria, false otherwise
  - matches
```
public boolean matches(Pokemon pokemon)
```
  - create
```
public EntityPixelmon create(net.minecraft.world.World world)
```
    Creates an EntityPixelmon in the given world based on this specification. This will fail if the PokemonSpec does not define a name.
    
    Parameters:
    
    world - - The world in which to base this Pokémon. Often this is unimportant, but it must never be null
    
    Returns:
    
    - the EntityPixelmon instance for this specification, or null if the name was not defined
  - create
```
public Pokemon create()
```
  - apply
```
@Deprecated
public void apply(net.minecraft.nbt.NBTTagCompound nbt)
```
    Deprecated.
    
    Applies the data from this PokemonSpec onto the given NBTTagCompound
    
    Parameters:
    
    nbt - - The NBTTagCompound into which to input the specifications
  - apply
```
public void apply(EntityPixelmon pokemon)
```
    Applies the data from this PokemonSpec onto the given EntityPixelmon
    
    Parameters:
    
    pokemon - - The EntityPixelmon into which to input the specifications
  - apply
```
public void apply(Pokemon pokemon)
```
  - writeToNBT
```
public net.minecraft.nbt.NBTTagCompound writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)
```
  - readFromNBT
```
public PokemonSpec readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - registerDefaultExtraSpecs
```
public static void registerDefaultExtraSpecs()
```
  - 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

Class PokemonSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPEC_VALUE_TYPE_ADAPTER

SPEC_ADAPTER

extraSpecTypes

args

name

level

gender

growth

nature

ability

boss

shiny

formInvert

form

formString

ball

pokerusType

pokerusSpread

egg

gmaxFactor

ribbons

extraSpecs

Constructor Detail

PokemonSpec

PokemonSpec

PokemonSpec

Method Detail

getSpecForKey

from

from

copy

fromBytes

toBytes

matches

matches

matches

create

create

apply

apply

apply

writeToNBT

readFromNBT

toString

registerDefaultExtraSpecs

equals

hashCode