com.pixelmonmod.pixelmon.api.pokemon

Class PokemonBuilder

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

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)
PokemonBuilder	abilitySlot(com.mojang.datafixers.util.Pair<java.lang.Integer,java.lang.Boolean> abilitySlot) Sets the ability slots of the Pokemon, overriding .ability() Leaving null will allow the Pokemon initialize algorithm to calculate the relevant one for the form/gender (etc)
PokemonBuilder	bonusStats(BonusStats stats) Adds additional stats on top of normal battle stats.
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	displayedRibbon(Ribbon ribbon) Specifies the selected ribbon on the Pokemon
PokemonBuilder	dynamaxLevel(int dynamaxLevel) Sets the Pokemon to have the provided Dynamax level
PokemonBuilder	egg(boolean egg) Makes the Pokemon an egg
PokemonBuilder	eggSteps(java.lang.Integer eggSteps) Sets the progress towards hatching
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()
BonusStats	getBonusStats()
PokeBall	getCaughtBall()
Ribbon	getDisplayedRibbon()
int	getDynamaxLevel()
java.lang.Integer	getEggSteps()
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()
boolean[]	getHyperTrained()
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()
net.minecraft.nbt.CompoundNBT	getPersistentData()
java.util.List<java.lang.String>	getPokemonSpecs()
Pokerus	getPokerus()
java.util.List<ImmutableAttack>	getReminderMoves()
java.util.List<Ribbon>	getRibbons()
Species	getSpecies()
StatusPersist	getStatus()
java.lang.String	getTempAbility()
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
PokemonBuilder	hyperTrained(boolean[] hypertrainedArray) Sets the hyper-trained status for the IVs 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	moveReminderMoves(@NonNull java.util.List<ImmutableAttack> reminderMoves) Sets the moves this Pokémon gets from the Move Reminder
PokemonBuilder	moveReminderMoves(RegistryValue<ImmutableAttack>... reminderMoves) Sets the moves this Pokémon gets from the Move Reminder
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	persistentData(net.minecraft.nbt.CompoundNBT data) Adds the persistent nbt data for the pokemon
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	ribbons(java.util.Collection<Ribbon> ribbons) Adds ribbons to the Pokemon
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	tempAbility(java.lang.String ability) Sets the temp ability of the Pokémon, stored in Moveset
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

eggSteps

public PokemonBuilder eggSteps(java.lang.Integer eggSteps)

Sets the progress towards hatching

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

abilitySlot

public PokemonBuilder abilitySlot(com.mojang.datafixers.util.Pair<java.lang.Integer,java.lang.Boolean> abilitySlot)

Sets the ability slots of the Pokemon, overriding .ability() Leaving null will allow the Pokemon initialize algorithm to calculate the relevant one for the form/gender (etc)

Parameters:

abilitySlot - The index of the ability

usesHidden - Whether the ability should be the hidden ability

Returns:

The builder instance

tempAbility

public PokemonBuilder tempAbility(java.lang.String ability)

Sets the temp ability of the Pokémon, stored in Moveset

Parameters:

ability - The name of 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

hyperTrained

public PokemonBuilder hyperTrained(boolean[] hypertrainedArray)

Sets the hyper-trained status for the IVs of the Pokemon

Parameters:

hypertrainedArray - Whether each IV is hyper-trained

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

moveReminderMoves

public PokemonBuilder moveReminderMoves(RegistryValue<ImmutableAttack>... reminderMoves)

Sets the moves this Pokémon gets from the Move Reminder

Parameters:

reminderMoves - The moves to apply

Returns:

The builder instance

moveReminderMoves

public PokemonBuilder moveReminderMoves(@NonNull java.util.List<ImmutableAttack> reminderMoves)

Sets the moves this Pokémon gets from the Move Reminder

Parameters:

reminderMoves - The moves to apply

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

dynamaxLevel

public PokemonBuilder dynamaxLevel(int dynamaxLevel)

Sets the Pokemon to have the provided Dynamax level

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

ribbons

public PokemonBuilder ribbons(java.util.Collection<Ribbon> ribbons)

Adds ribbons to the Pokemon

Parameters:

flags - The ribbons

Returns:

The builder instance

displayedRibbon

public PokemonBuilder displayedRibbon(Ribbon ribbon)

Specifies the selected ribbon on the Pokemon

Parameters:

ribbon - The ribbon

Returns:

The builder instance

bonusStats

public PokemonBuilder bonusStats(BonusStats stats)

Adds additional stats on top of normal battle stats.

Parameters:

stats - The stats to be added

Returns:

The builder instance

persistentData

public PokemonBuilder persistentData(net.minecraft.nbt.CompoundNBT data)

Adds the persistent nbt data for the pokemon

Parameters:

data - The nbt data

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()

getEggSteps

public java.lang.Integer getEggSteps()

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()

getHyperTrained

public boolean[] getHyperTrained()

getEvs

public int[] getEvs()

getMoves

public Attack[] getMoves()

getReminderMoves

public java.util.List<ImmutableAttack> getReminderMoves()

getTempAbility

public java.lang.String getTempAbility()

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()

getDynamaxLevel

public int getDynamaxLevel()

getDisplayedRibbon

public Ribbon getDisplayedRibbon()

getRibbons

public java.util.List<Ribbon> getRibbons()

getFlags

public java.util.List<java.lang.String> getFlags()

getPokemonSpecs

public java.util.List<java.lang.String> getPokemonSpecs()

getBonusStats

public BonusStats getBonusStats()

getPersistentData

public net.minecraft.nbt.CompoundNBT getPersistentData()

build

public Pokemon build()

Creates the Pokemon instance using the provided information

Returns:

The new Pokemon