PokemonBuilder (Pixelmon 1.16.5-9.1.7-pipe20926 API)

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

public class PokemonBuilder
extends java.lang.Object

Builder class for creating a new Pokemon instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PokemonBuilder`	`ability(@Nullable Ability ability)` Sets the ability of the Pokemon Leaving null will allow the Pokemon initialize algorithm to calculate the relevant one for the form/gender (etc)
`Pokemon`	`build()` Creates the Pokemon instance using the provided information
`static PokemonBuilder`	`builder()` Creates a new instance of a PokemonBuilder object
`PokemonBuilder`	`caughtBall(@NonNull PokeBall caughtBall)` Sets the ball of the Pokemon
`static PokemonBuilder`	`copy(Pokemon pokemon)`
`PokemonBuilder`	`egg(boolean egg)` Makes the Pokemon an egg
`PokemonBuilder`	`ev(@NonNull BattleStatsType type, int level)` Sets the value of the EV
`PokemonBuilder`	`evs(int... evs)` Sets the EVs of the Pokemon
`PokemonBuilder`	`experience(int experience)` Sets the experience of the Pokemon
`PokemonBuilder`	`extraStats(@NonNull ExtraStats extraStats)` Sets the extra stats of the Pokemon
`PokemonBuilder`	`flags(java.util.Collection<java.lang.String> flags)` Adds flags to the Pokemon
`PokemonBuilder`	`flags(java.lang.String... flags)` Adds flags to the Pokemon
`PokemonBuilder`	`form(@NonNull Stats form)` Sets the form of the Pokemon Setting to null selects a random default form from the species
`PokemonBuilder`	`form(@Nullable java.lang.String form)` Sets the form of the Pokemon Setting to null selects a random default form from the species
`PokemonBuilder`	`friendship(int friendship)` Sets the friendship of the Pokemon
`PokemonBuilder`	`gender(@NonNull Gender gender)` Sets the gender of the Pokemon
`Ability`	`getAbility()`
`PokeBall`	`getCaughtBall()`
`int[]`	`getEvs()`
`int`	`getExperience()`
`ExtraStats`	`getExtraStats()`
`java.util.List<java.lang.String>`	`getFlags()`
`java.lang.String`	`getForm()`
`int`	`getFriendship()`
`Gender`	`getGender()`
`EnumGrowth`	`getGrowth()`
`net.minecraft.item.ItemStack`	`getHeldItem()`
`int[]`	`getIvs()`
`int`	`getLevel()`
`Nature`	`getMintNature()`
`Attack[]`	`getMoves()`
`Nature`	`getNature()`
`net.minecraft.util.text.ITextComponent`	`getNickname()`
`java.util.UUID`	`getOriginalTrainer()`
`java.lang.String`	`getOriginalTrainerName()`
`java.lang.String`	`getPalette()`
`java.util.List<java.lang.String>`	`getPokemonSpecs()`
`Pokerus`	`getPokerus()`
`Species`	`getSpecies()`
`StatusPersist`	`getStatus()`
`java.util.UUID`	`getUuid()`
`PokemonBuilder`	`gigantamaxFactor()` Sets the Pokemon to have the Gigantamax Factor
`PokemonBuilder`	`gigantamaxFactor(boolean gigantamaxFactor)` Sets the Pokemon to have the Gigantamax Factor if true, or not if false
`PokemonBuilder`	`growth(@Nullable EnumGrowth growth)` Sets the growth of the Pokemon
`PokemonBuilder`	`heldItem(@NonNull HeldItem heldItem)` Sets the held item of the Pokemon
`PokemonBuilder`	`heldItem(@NonNull net.minecraft.item.ItemStack heldItem)` Sets the held item of the Pokemon
`boolean`	`isEgg()`
`boolean`	`isGigantamaxFactor()`
`PokemonBuilder`	`iv(@NonNull BattleStatsType type, int level)` Sets the value of the EV
`PokemonBuilder`	`ivs(int... ivs)` Sets the IVs of the Pokemon
`PokemonBuilder`	`level(int level)` Sets the level of the Pokemon
`PokemonBuilder`	`makeEgg()` Makes the Pokemon an egg
`PokemonBuilder`	`mintNature(@Nullable Nature nature)` Sets the mint nature of the Pokemon
`PokemonBuilder`	`move(int index, @Nullable Attack attack)` Sets the move to the `Attack` at the given index
`PokemonBuilder`	`move(int index, @Nullable ImmutableAttack attack)` Sets the move to the `ImmutableAttack` at the given index
`PokemonBuilder`	`moves(Attack... moves)` Sets the moves of the Pokemon
`PokemonBuilder`	`nature(@Nullable Nature nature)` Sets the nature of the Pokemon
`PokemonBuilder`	`nickname(@Nullable net.minecraft.util.text.ITextComponent nickname)` Sets the nickname of the Pokemon Leaving null means no nickname
`PokemonBuilder`	`nickname(@Nullable java.lang.String nickname)` Sets the nickname of the Pokemon Leaving null means no nickname
`PokemonBuilder`	`originalTrainer(@Nullable net.minecraft.entity.player.PlayerEntity player)` Sets the original trainer UUID of the Pokemon
`PokemonBuilder`	`originalTrainer(@Nullable java.util.UUID originalTrainer, @Nullable java.lang.String originalTrainerName)` Sets the original trainer UUID of the Pokemon
`PokemonBuilder`	`palette(@Nullable java.lang.String palette)` Sets the palette of the Pokemon Setting to null selects a random default palette from the form
`PokemonBuilder`	`pokerus(@NonNull Pokerus pokerus)` Sets the pokerus status of the Pokemon
`PokemonBuilder`	`randomSpecies()` Sets the species to a randomly selected species using `PixelmonSpecies.getRandomSpecies()`
`PokemonBuilder`	`randomSpecies(boolean excludeLegendaries, boolean excludeMythicals, boolean excludeUltraBeasts)` Sets the species to a randomly selected species using `PixelmonSpecies.getRandomSpecies(boolean, boolean, boolean)`}
`PokemonBuilder`	`randomSpecies(java.util.Collection<RegistryValue<Species>> excluded)` Sets the species to a random species excluding those given
`PokemonBuilder`	`randomSpecies(java.util.function.Predicate<Species> excluded)` Sets the species to a random species excluding those set to be excluded in the predicate
`PokemonBuilder`	`randomSpecies(RegistryValue<Species>... excluded)` Sets the species to a random species excluding those given
`PokemonBuilder`	`shiny()` Sets the Pokemon palette to be shiny
`PokemonBuilder`	`shiny(boolean shiny)` Sets the Pokemon palette to be shiny if true, null if false
`PokemonBuilder`	`species(int ndex)` Sets the species
`PokemonBuilder`	`species(@NonNull java.util.Optional<Species> species)` Sets the species
`PokemonBuilder`	`species(@NonNull RegistryValue<Species> species)` Sets the species
`PokemonBuilder`	`species(@NonNull Species species)` Sets the species
`PokemonBuilder`	`species(@NonNull java.lang.String speciesName)` Sets the species
`PokemonBuilder`	`specs(java.util.Collection<java.lang.String> specs)` Adds post-creation specs to apply
`PokemonBuilder`	`specs(PokemonSpecification... specs)` Adds post-creation specs to apply
`PokemonBuilder`	`specs(java.lang.String... specs)` Adds post-creation specs to apply
`PokemonBuilder`	`status(@NonNull StatusPersist status)` Sets the status of the Pokemon
`PokemonBuilder`	`uuid(@Nullable java.util.UUID uuid)` Sets the UUID Setting to null selects a random UUID

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

- Method Detail
  - copy
```
public static PokemonBuilder copy(Pokemon pokemon)
```
  - builder
```
public static PokemonBuilder builder()
```
    Creates a new instance of a PokemonBuilder object
    
    Returns:
    
    The builder object
  - uuid
```
public PokemonBuilder uuid(@Nullable java.util.UUID uuid)
```
    Sets the UUID Setting to null selects a random UUID
    
    Parameters:
    
    uuid - The new UUID
    
    Returns:
    
    The builder instance
  - randomSpecies
```
public PokemonBuilder randomSpecies()
```
    Sets the species to a randomly selected species using PixelmonSpecies.getRandomSpecies()
    
    Returns:
    
    The builder instance
  - randomSpecies
```
public PokemonBuilder randomSpecies(boolean excludeLegendaries,
                                    boolean excludeMythicals,
                                    boolean excludeUltraBeasts)
```
    Sets the species to a randomly selected species using PixelmonSpecies.getRandomSpecies(boolean, boolean, boolean)}
    
    Parameters:
    
    excludeLegendaries - - Whether or not Legendaries are included
    
    excludeMythicals - - Whether or not Mythicals are included
    
    excludeUltraBeasts - - Whether or not Ultra Beasts are included
    
    Returns:
    
    The builder instance
  - randomSpecies
```
public PokemonBuilder randomSpecies(java.util.Collection<RegistryValue<Species>> excluded)
```
    Sets the species to a random species excluding those given
    
    Parameters:
    
    excluded - The pokemon to exclude
    
    Returns:
    
    The builder instance
  - randomSpecies
```
public PokemonBuilder randomSpecies(RegistryValue<Species>... excluded)
```
    Sets the species to a random species excluding those given
    
    Parameters:
    
    excluded - The pokemon to exclude
    
    Returns:
    
    The builder instance
  - randomSpecies
```
public PokemonBuilder randomSpecies(java.util.function.Predicate<Species> excluded)
```
    Sets the species to a random species excluding those set to be excluded in the predicate
    
    Parameters:
    
    excluded - The pokemon to exclude (returning true means it will be excluded - false means it will be accepted)
    
    Returns:
    
    The builder instance
  - species
```
public PokemonBuilder species(@NonNull java.lang.String speciesName)
```
    Sets the species
    
    Parameters:
    
    speciesName - The name of the species
    
    Returns:
    
    The builder instance
  - species
```
public PokemonBuilder species(@NonNull RegistryValue<Species> species)
```
    Sets the species
    
    Parameters:
    
    species - The species registry value
    
    Returns:
    
    The builder instance
  - species
```
public PokemonBuilder species(@NonNull java.util.Optional<Species> species)
```
    Sets the species
    
    Parameters:
    
    species - The species optional
    
    Returns:
    
    The builder instance
  - species
```
public PokemonBuilder species(int ndex)
```
    Sets the species
    
    Parameters:
    
    ndex - The species national dex ID
    
    Returns:
    
    The builder instance
  - species
```
public PokemonBuilder species(@NonNull Species species)
```
    Sets the species
    
    Parameters:
    
    species - The species
    
    Returns:
    
    The builder instance
  - makeEgg
```
public PokemonBuilder makeEgg()
```
    Makes the Pokemon an egg
    
    Returns:
    
    The builder instance
  - egg
```
public PokemonBuilder egg(boolean egg)
```
    Makes the Pokemon an egg
    
    Returns:
    
    The builder instance
  - gender
```
public PokemonBuilder gender(@NonNull Gender gender)
```
    Sets the gender of the Pokemon
    
    Parameters:
    
    gender - The gender
    
    Returns:
    
    The builder instance
  - shiny
```
public PokemonBuilder shiny()
```
    Sets the Pokemon palette to be shiny
    
    Returns:
    
    The builder instance
  - shiny
```
public PokemonBuilder shiny(boolean shiny)
```
    Sets the Pokemon palette to be shiny if true, null if false
    
    Returns:
    
    The builder instance
  - palette
```
public PokemonBuilder palette(@Nullable java.lang.String palette)
```
    Sets the palette of the Pokemon Setting to null selects a random default palette from the form
    
    Parameters:
    
    palette - The palette
    
    Returns:
    
    The builder instance
  - form
```
public PokemonBuilder form(@NonNull Stats form)
```
    Sets the form of the Pokemon Setting to null selects a random default form from the species
    
    Parameters:
    
    form - The form
    
    Returns:
    
    The builder instance
  - form
```
public PokemonBuilder form(@Nullable java.lang.String form)
```
    Sets the form of the Pokemon Setting to null selects a random default form from the species
    
    Parameters:
    
    form - The form
    
    Returns:
    
    The builder instance
  - ability
```
public PokemonBuilder ability(@Nullable Ability ability)
```
    Sets the ability of the Pokemon Leaving null will allow the Pokemon initialize algorithm to calculate the relevant one for the form/gender (etc)
    
    Parameters:
    
    ability - The ability
    
    Returns:
    
    The builder instance
  - nickname
```
public PokemonBuilder nickname(@Nullable java.lang.String nickname)
```
    Sets the nickname of the Pokemon Leaving null means no nickname
    
    Parameters:
    
    nickname - The nickname
    
    Returns:
    
    The builder instance
  - nickname
```
public PokemonBuilder nickname(@Nullable net.minecraft.util.text.ITextComponent nickname)
```
    Sets the nickname of the Pokemon Leaving null means no nickname
    
    Parameters:
    
    nickname - The nickname
    
    Returns:
    
    The builder instance
  - heldItem
```
public PokemonBuilder heldItem(@NonNull HeldItem heldItem)
```
    Sets the held item of the Pokemon
    
    Parameters:
    
    heldItem - The held item type
    
    Returns:
    
    The builder instance
  - heldItem
```
public PokemonBuilder heldItem(@NonNull net.minecraft.item.ItemStack heldItem)
```
    Sets the held item of the Pokemon
    
    Parameters:
    
    heldItem - The held itemstack
    
    Returns:
    
    The builder instance
  - friendship
```
public PokemonBuilder friendship(int friendship)
```
    Sets the friendship of the Pokemon
    
    Parameters:
    
    friendship - The new friendship
    
    Returns:
    
    The builder instance
  - experience
```
public PokemonBuilder experience(int experience)
```
    Sets the experience of the Pokemon
    
    Parameters:
    
    experience - The new experience
    
    Returns:
    
    The builder instance
  - ev
```
public PokemonBuilder ev(@NonNull BattleStatsType type,
                         int level)
```
    Sets the value of the EV
    
    Parameters:
    
    type - The type of EV
    
    level - the level
    
    Returns:
    
    The builder instance
  - iv
```
public PokemonBuilder iv(@NonNull BattleStatsType type,
                         int level)
```
    Sets the value of the EV
    
    Parameters:
    
    type - The type of EV
    
    level - the level
    
    Returns:
    
    The builder instance
  - evs
```
public PokemonBuilder evs(int... evs)
```
    Sets the EVs of the Pokemon
    
    Parameters:
    
    evs - The evs
    
    Returns:
    
    The builder instance
  - ivs
```
public PokemonBuilder ivs(int... ivs)
```
    Sets the IVs of the Pokemon
    
    Parameters:
    
    ivs - The ivs
    
    Returns:
    
    The builder instance
  - move
```
public PokemonBuilder move(int index,
                           @Nullable ImmutableAttack attack)
```
    Sets the move to the ImmutableAttack at the given index
    
    Parameters:
    
    index - The index of the move in the party (0-3)
    
    attack - The attack
    
    Returns:
    
    The builder instance
  - move
```
public PokemonBuilder move(int index,
                           @Nullable Attack attack)
```
    Sets the move to the Attack at the given index
    
    Parameters:
    
    index - The index of the move in the party (0-3)
    
    attack - The attack
    
    Returns:
    
    The builder instance
  - moves
```
public PokemonBuilder moves(Attack... moves)
```
    Sets the moves of the Pokemon
    
    Parameters:
    
    moves - The moves
    
    Returns:
    
    The builder instance
  - nature
```
public PokemonBuilder nature(@Nullable Nature nature)
```
    Sets the nature of the Pokemon
    
    Parameters:
    
    nature - The nature
    
    Returns:
    
    The builder instance
  - growth
```
public PokemonBuilder growth(@Nullable EnumGrowth growth)
```
    Sets the growth of the Pokemon
    
    Parameters:
    
    growth - The growth
    
    Returns:
    
    The builder instance
  - mintNature
```
public PokemonBuilder mintNature(@Nullable Nature nature)
```
    Sets the mint nature of the Pokemon
    
    Parameters:
    
    nature - The mint nature
    
    Returns:
    
    The builder instance
  - level
```
public PokemonBuilder level(int level)
```
    Sets the level of the Pokemon
    
    Parameters:
    
    level - The level
    
    Returns:
    
    The builder instance
  - caughtBall
```
public PokemonBuilder caughtBall(@NonNull PokeBall caughtBall)
```
    Sets the ball of the Pokemon
    
    Parameters:
    
    caughtBall - The ball
    
    Returns:
    
    The builder instance
  - extraStats
```
public PokemonBuilder extraStats(@NonNull ExtraStats extraStats)
```
    Sets the extra stats of the Pokemon
    
    Parameters:
    
    extraStats - The extra stats for the species
    
    Returns:
    
    The builder instance
  - originalTrainer
```
public PokemonBuilder originalTrainer(@Nullable java.util.UUID originalTrainer,
                                      @Nullable java.lang.String originalTrainerName)
```
    Sets the original trainer UUID of the Pokemon
    
    Parameters:
    
    originalTrainer - The original trainer
    
    originalTrainerName - The original trainer's name
    
    Returns:
    
    The builder instance
  - originalTrainer
```
public PokemonBuilder originalTrainer(@Nullable net.minecraft.entity.player.PlayerEntity player)
```
    Sets the original trainer UUID of the Pokemon
    
    Parameters:
    
    player - The original trainer
    
    Returns:
    
    The builder instance
  - specs
```
public PokemonBuilder specs(java.lang.String... specs)
```
    Adds post-creation specs to apply
    
    Parameters:
    
    specs - The specs to apply
    
    Returns:
    
    The builder instance
  - specs
```
public PokemonBuilder specs(java.util.Collection<java.lang.String> specs)
```
    Adds post-creation specs to apply
    
    Parameters:
    
    specs - The specs to apply
    
    Returns:
    
    The builder instance
  - specs
```
public PokemonBuilder specs(PokemonSpecification... specs)
```
    Adds post-creation specs to apply
    
    Parameters:
    
    specs - The specs to apply
    
    Returns:
    
    The builder instance
  - pokerus
```
public PokemonBuilder pokerus(@NonNull Pokerus pokerus)
```
    Sets the pokerus status of the Pokemon
    
    Parameters:
    
    pokerus - The pokerus
    
    Returns:
    
    The builder instance
  - status
```
public PokemonBuilder status(@NonNull StatusPersist status)
```
    Sets the status of the Pokemon
    
    Parameters:
    
    status - The status
    
    Returns:
    
    The builder instance
  - gigantamaxFactor
```
public PokemonBuilder gigantamaxFactor()
```
    Sets the Pokemon to have the Gigantamax Factor
    
    Returns:
    
    The builder instance
  - gigantamaxFactor
```
public PokemonBuilder gigantamaxFactor(boolean gigantamaxFactor)
```
    Sets the Pokemon to have the Gigantamax Factor if true, or not if false
    
    Returns:
    
    The builder instance
  - flags
```
public PokemonBuilder flags(java.lang.String... flags)
```
    Adds flags to the Pokemon
    
    Parameters:
    
    flags - The flags
    
    Returns:
    
    The builder instance
  - flags
```
public PokemonBuilder flags(java.util.Collection<java.lang.String> flags)
```
    Adds flags to the Pokemon
    
    Parameters:
    
    flags - The flags
    
    Returns:
    
    The builder instance
  - getUuid
```
public java.util.UUID getUuid()
```
  - getSpecies
```
public Species getSpecies()
```
  - getPalette
```
public java.lang.String getPalette()
```
  - getForm
```
public java.lang.String getForm()
```
  - isEgg
```
public boolean isEgg()
```
  - getGender
```
public Gender getGender()
```
  - getAbility
```
public Ability getAbility()
```
  - getNickname
```
public net.minecraft.util.text.ITextComponent getNickname()
```
  - getHeldItem
```
public net.minecraft.item.ItemStack getHeldItem()
```
  - getFriendship
```
public int getFriendship()
```
  - getIvs
```
public int[] getIvs()
```
  - getEvs
```
public int[] getEvs()
```
  - getMoves
```
public Attack[] getMoves()
```
  - getNature
```
public Nature getNature()
```
  - getMintNature
```
public Nature getMintNature()
```
  - getLevel
```
public int getLevel()
```
  - getExperience
```
public int getExperience()
```
  - getGrowth
```
public EnumGrowth getGrowth()
```
  - getCaughtBall
```
public PokeBall getCaughtBall()
```
  - getExtraStats
```
public ExtraStats getExtraStats()
```
  - getOriginalTrainer
```
public java.util.UUID getOriginalTrainer()
```
  - getOriginalTrainerName
```
public java.lang.String getOriginalTrainerName()
```
  - getPokerus
```
public Pokerus getPokerus()
```
  - getStatus
```
public StatusPersist getStatus()
```
  - isGigantamaxFactor
```
public boolean isGigantamaxFactor()
```
  - getFlags
```
public java.util.List<java.lang.String> getFlags()
```
  - getPokemonSpecs
```
public java.util.List<java.lang.String> getPokemonSpecs()
```
  - build
```
public Pokemon build()
```
    Creates the Pokemon instance using the provided information
    
    Returns:
    
    The new Pokemon

Class PokemonBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copy

builder

uuid

randomSpecies

randomSpecies

randomSpecies

randomSpecies

randomSpecies

species

species

species

species

species

makeEgg

egg

gender

shiny

shiny

palette

form

form

ability

nickname

nickname

heldItem

heldItem

friendship

experience

ev

iv

evs

ivs

move

move

moves

nature

growth

mintNature

level

caughtBall

extraStats

originalTrainer

originalTrainer

specs

specs

specs

pokerus

status

gigantamaxFactor

gigantamaxFactor

flags

flags

getUuid

getSpecies

getPalette

getForm

isEgg

getGender

getAbility

getNickname

getHeldItem

getFriendship

getIvs

getEvs

getMoves

getNature

getMintNature

getLevel

getExperience

getGrowth

getCaughtBall

getExtraStats

getOriginalTrainer

getOriginalTrainerName

getPokerus

getStatus