Pokemon (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.pokemon.PokemonBase
- - com.pixelmonmod.pixelmon.api.pokemon.Pokemon

All Implemented Interfaces:

ITranslatable
```
public class Pokemon
extends PokemonBase
```
Default implementation of a Pokemon

Field Summary

Fields
Modifier and Type	Field and Description
`static EnumUpdateType[]`	`ABILITY`
`protected BonusStats`	`bonusStats`
`protected net.minecraft.util.RegistryKey<net.minecraft.world.World>`	`dimension`
`protected Ribbon`	`displayedRibbon`
`protected boolean`	`doesLevel`
`protected int`	`dynamaxLevel`
`static net.minecraft.util.text.ITextComponent`	`EGG`
`protected java.lang.Integer`	`eggSteps`
`static EnumUpdateType[]`	`EMPTY`
`protected int`	`entityID`
`protected int`	`experience`
`protected ExtraStats`	`extraStats`
`protected java.util.ArrayList<java.lang.String>`	`flags`
`static EnumUpdateType[]`	`FORM`
`protected int`	`friendship`
`protected boolean`	`gigantamaxFactor`
`protected EnumGrowth`	`growth`
`protected int`	`health`
`protected net.minecraft.item.ItemStack`	`heldItem`
`int`	`lastBattleCrits`
`protected int`	`level`
`protected Nature`	`mintNature`
`protected Moveset`	`moveset`
`protected java.util.HashMap<java.lang.String,net.minecraft.util.Tuple<java.lang.Long,java.lang.Long>>`	`moveSkillCooldownData`
`protected Nature`	`nature`
`protected net.minecraft.util.text.ITextComponent`	`nickname`
`protected java.lang.String`	`originalTrainerName`
`protected java.util.UUID`	`originalTrainerUUID`
`protected PermanentStats`	`permanentStats`
`protected net.minecraft.nbt.CompoundNBT`	`persistentData`
`protected PokemonLevel`	`pokemonLevelContainer`
`protected Pokerus`	`pokerus`
`protected StoragePosition`	`position`
`protected java.util.List<Ribbon>`	`ribbons`
`static EnumUpdateType[]`	`STATS`
`protected StatusPersist`	`status`
`protected PokemonStorage`	`storage`
`static DataSync<? extends AbstractBaseEntity,java.util.Optional<java.util.UUID>>`	`SYNC_ENTITY_UUID`
`static DataSync<? extends AbstractBaseEntity,java.lang.Integer>`	`SYNC_EXP`
`static DataSync<? extends AbstractBaseEntity,EnumGrowth>`	`SYNC_GROWTH`
`static DataSync<? extends AbstractBaseEntity,java.lang.Float>`	`SYNC_HEALTH`
`static DataSync<? extends AbstractBaseEntity,java.lang.Integer>`	`SYNC_LEVEL`
`static DataSync<? extends AbstractBaseEntity,net.minecraft.util.text.ITextComponent>`	`SYNC_NICK_NAME`
`static DataSync<? extends AbstractBaseEntity,Ribbon>`	`SYNC_RIBBON`
`protected java.util.UUID`	`uuid`

Fields inherited from class com.pixelmonmod.pixelmon.api.pokemon.PokemonBase
ball, eggCycles, form, gender, palette, species, SYNC_POKEMON_BASE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Pokemon()` This constructor is STRONGLY discouraged, and exists only for JSON deserialization.
`protected`	`Pokemon(java.util.UUID uuid)`
`protected`	`Pokemon(java.util.UUID uuid, Species species)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEggSteps(int steps, int cycleMultiplier)`
`void`	`addFlag(java.lang.String key)`
`boolean`	`addRibbon(Ribbon ribbon)` Adds a ribbon to this Pokémon and sets it as the displayed ribbon.
`boolean`	`addRibbon(Ribbon ribbon, boolean shouldDisplayRibbon)` Adds a ribbon to this Pokémon.
`boolean`	`addRibbon(RibbonType ribbonType)`
`boolean`	`addRibbon(RibbonType ribbonType, boolean displayRibbon)`
`boolean`	`canBattle()`
`boolean`	`canGigantamax()`
`void`	`changeDynamaxLevel(int dynamaxLevel)`
`void`	`decreaseFriendship(int amount)`
`boolean`	`doesLevel()`
`void`	`evolve(PokemonSpecification to)`
`Ability`	`getAbility()`
`java.lang.String`	`getAbilityName()`
`Nature`	`getBaseNature()`
`BonusStats`	`getBonusStats()`
`Ribbon`	`getDisplayedRibbon()` Gets the Pokemon's selected (displayed) ribbon If this returns null it means there is no displayed ribbon
`java.lang.String`	`getDisplayName()` Deprecated.
`net.minecraft.util.text.ITextComponent`	`getDisplayNameWithRibbon()`
`int`	`getDynamaxLevel()`
`java.lang.String`	`getEggDescription()` Gets the PokéChecker description translation key of an Egg.
`int`	`getEggSteps()`
`int`	`getEntityID()`
`<T extends Evolution> java.util.ArrayList<T>`	`getEvolutions(java.lang.Class<T> type)`
`EVStore`	`getEVs()`
`int`	`getExperience()`
`float`	`getExperienceFraction()`
`int`	`getExperienceToLevelUp()`
`ExtraStats`	`getExtraStats()`
`<T extends ExtraStats> java.util.Optional<T>`	`getExtraStats(java.lang.Class<T> type)`
`net.minecraft.util.text.ITextComponent`	`getFormattedDisplayName()`
`net.minecraft.util.text.ITextComponent`	`getFormattedNickname()` Gets the formatted nickname of the Pokemon
`int`	`getFriendship()`
`EnumGrowth`	`getGrowth()`
`int`	`getHealth()`
`float`	`getHealthPercentage()`
`net.minecraft.item.ItemStack`	`getHeldItem()`
`HeldItem`	`getHeldItemAsItemHeld()` Gets the ItemHeld type of the item the Pokémon is holding.
`int`	`getHighestOffensiveStat()`
`IVStore`	`getIVs()`
`int`	`getMaxHealth()`
`Nature`	`getMintNature()`
`Moveset`	`getMoveset()`
`double`	`getMoveSkillCooldownRatio(MoveSkill moveSkill)`
`int`	`getMoveSkillCooldownTicks(MoveSkill moveSkill)`
`Nature`	`getNature()` Gives the active nature of this pokemon, Use either `getBaseNature()` or `getMintNature()` if you need a specific value.
`java.lang.String`	`getNickname()` Deprecated. Use `getFormattedNickname()`
`PixelmonEntity`	`getOrCreatePixelmon()`
`PixelmonEntity`	`getOrCreatePixelmon(net.minecraft.entity.Entity parent)`
`PixelmonEntity`	`getOrCreatePixelmon(net.minecraft.world.World world, double x, double y, double z)`
`PixelmonEntity`	`getOrCreatePixelmon(net.minecraft.world.World world, double x, double y, double z, float rotationYaw, float rotationPitch)` Gets the entity attached to this Pokémon, or spawns it if it does not exist in the given world.
`java.lang.String`	`getOriginalTrainer()`
`java.util.UUID`	`getOriginalTrainerUUID()`
`PixelmonEntity`	`getOrSpawnPixelmon(net.minecraft.entity.Entity parent)`
`PixelmonEntity`	`getOrSpawnPixelmon(net.minecraft.world.World world, double x, double y, double z)`
`PixelmonEntity`	`getOrSpawnPixelmon(net.minecraft.world.World world, double x, double y, double z, float rotationYaw, float rotationPitch)` Gets the entity attached to this Pokémon, or spawns it if it does not exist in the given world.
`java.lang.String`	`getOwnerName()`
`net.minecraft.entity.player.ServerPlayerEntity`	`getOwnerPlayer()`
`java.util.UUID`	`getOwnerPlayerUUID()`
`NPCTrainer`	`getOwnerTrainer()`
`java.util.UUID`	`getOwnerTrainerUUID()`
`PaletteProperties`	`getPalette()` Gets the palette of the pokemon
`net.minecraft.nbt.CompoundNBT`	`getPersistentData()`
`java.util.Optional<PixelmonEntity>`	`getPixelmonEntity()`
`java.util.Optional<PixelmonWrapper>`	`getPixelmonWrapper()`
`java.util.Optional<PixelmonWrapper>`	`getPixelmonWrapperFromPlayerEntity()` Deprecated. Use `this#getPixelmonWrapper()`
`int`	`getPokemonLevel()`
`PokemonLevel`	`getPokemonLevelContainer()`
`Pokerus`	`getPokerus()`
`StoragePosition`	`getPosition()`
`java.util.List<ImmutableAttack>`	`getRelearnableMoves()`
`java.util.List<Ribbon>`	`getRibbons()` Gets an unmodifiable list of the ribbons that this pokemon has managed to collect
`net.minecraft.util.ResourceLocation`	`getSprite()` Gets the relevant sprite for the `PokemonBase`
`int`	`getStat(BattleStatsType stat)`
`PermanentStats`	`getStats()`
`StatusPersist`	`getStatus()`
`PokemonStorage`	`getStorage()`
`net.minecraft.util.Tuple<PokemonStorage,StoragePosition>`	`getStorageAndPosition()`
`java.util.UUID`	`getUUID()`
`net.minecraft.world.World`	`getWorld()`
`boolean`	`hasFlag(java.lang.String key)`
`boolean`	`hasGigantamaxFactor()`
`boolean`	`hasHiddenAbility()`
`boolean`	`hasNoDrops()` Checks if the Pokemon has no drops
`void`	`hatchEgg()`
`void`	`hatchEgg(boolean force)`
`void`	`heal()`
`boolean`	`ifEntityExists(java.util.function.Consumer<PixelmonEntity> action)` Executes code if the entity representing this Pokémon exists.
`void`	`increaseFriendship(int amount)`
`Pokemon`	`initialize(InitializeCategory... initializeCategories)`
`boolean`	`isFainted()` Checks if the Pokemon has fainted
`boolean`	`isFriendshipHighEnoughToEvolve()`
`boolean`	`isLegendary()`
`boolean`	`isLegendary(boolean excludeMythicals)`
`boolean`	`isMega()`
`boolean`	`isMoveSkillCoolingDown(MoveSkill moveSkill)`
`boolean`	`isMythical()`
`boolean`	`isOriginalTrainer(net.minecraft.entity.player.PlayerEntity player)`
`boolean`	`isUltraBeast()`
`boolean`	`isUnbreedable()` Checks if the Pokemon is unbreedable Quick redirect for `hasFlag(String)`
`boolean`	`isUncatchable()` Checks if the Pokemon is uncatchable Quick redirect for `hasFlag(String)`
`boolean`	`isUntradeable()` Checks if the Pokemon is untradeable Quick redirect for `hasFlag(String)`
`Pokemon`	`makeEgg()` Turns the pokemon into an egg
`void`	`markDirty(EnumUpdateType... dataTypes)`
`Pokemon`	`readFromByteBuffer(net.minecraft.network.PacketBuffer buf, EnumUpdateType... data)`
`void`	`readFromNBT(net.minecraft.nbt.CompoundNBT nbt)`
`void`	`removeFlag(java.lang.String key)`
`void`	`removeNickname()` Removes the Pokemon's current nickname
`boolean`	`removeRibbon(Ribbon ribbon)` Removes a ribbon from this Pokémon.
`void`	`rerollMoveset()`
`void`	`retrieve(java.lang.String pokemonRetrievedEventReason)`
`void`	`setAbility(Ability ability)`
`void`	`setAbility(java.util.Optional<Ability> ability)`
`void`	`setBall(PokeBall caughtBall)` Sets the ball the pokemon is in
`void`	`setBonusStats(BonusStats bonusStats)`
`void`	`setDisplayedRibbon(Ribbon ribbon)` Sets the ribbon that will be displayed on this Pokemon.
`void`	`setDoesLevel(boolean doesLevel)`
`void`	`setDynamaxLevel(int dynamaxLevel)`
`void`	`setEggCycles(java.lang.Integer eggCycles, boolean event)` Sets the egg cycles of the pokemon
`void`	`setEggSteps(java.lang.Integer eggSteps)`
`void`	`setExperience(int experience)`
`void`	`setForm(Stats form)`
`boolean`	`setForm(java.lang.String form)`
`void`	`setFriendship(int friendship)`
`void`	`setGender(Gender gender)`
`void`	`setGigantamaxFactor(boolean gigantamaxFactor)`
`void`	`setGrowth(EnumGrowth growth)`
`void`	`setHealth(int health)`
`void`	`setHealthCache(int health)`
`void`	`setHealthPercentage(float healthPercentage)`
`void`	`setHeldItem(net.minecraft.item.ItemStack stack)` Sets the Pokémon's held item after firing `HeldItemChangedEvent`.
`void`	`setLevel(int level)`
`void`	`setLevelNum(int level)`
`void`	`setMintNature(Nature nature)`
`void`	`setMoveset(Moveset moveset)`
`void`	`setMoveSkillCooldown(MoveSkill moveSkill, int cooldownTicks)`
`void`	`setNature(Nature nature)`
`void`	`setNickname(net.minecraft.util.text.ITextComponent nickname)` Sets the Pokemon's nickname to the new `ITextComponent`
`void`	`setNickname(java.lang.String nickname)` Deprecated. Use `setNickname(ITextComponent)`
`void`	`setOriginalTrainer(net.minecraft.entity.player.PlayerEntity player)`
`void`	`setOriginalTrainer(java.util.UUID originalTrainerUUID, java.lang.String originalTrainerName)`
`boolean`	`setPalette(PaletteProperties paletteProperties)` Sets the palette properties for the Pokemon
`boolean`	`setPalette(java.lang.String palette)`
`boolean`	`setPalette(java.lang.String palette, boolean sync)`
`void`	`setPokerus(Pokerus pokerus)`
`boolean`	`setShiny()`
`boolean`	`setShiny(boolean shiny)`
`void`	`setSpecies(RegistryValue<Species> species, boolean doSpeciesInitialization)`
`void`	`setSpecies(Species species, boolean doSpeciesInitialization)`
`void`	`setStatus(StatusPersist status)`
`void`	`setStorage(PokemonStorage storage, StoragePosition position)`
`Pokemon`	`setUUID(java.util.UUID uuid)`
`java.lang.String`	`toString()`
`void`	`tryEvolution()` Attempts to evolve the Pokémon if possible.
`void`	`updateDimensionAndEntityID(net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension, int entityID)`
`void`	`writeToByteBuffer(net.minecraft.network.PacketBuffer buf, EnumUpdateType... data)`
`net.minecraft.nbt.CompoundNBT`	`writeToNBT(net.minecraft.nbt.CompoundNBT nbt)` Writes the values of this class into an `CompoundNBT`

Methods inherited from class com.pixelmonmod.pixelmon.api.pokemon.PokemonBase
fromNBT, getBall, getEggCycles, getForm, getGender, getGenderProperties, getSpecies, getTranslationKey, hasChild, hasPalette, invalidate, isDefaultForm, isDefaultPalette, isEgg, isPalette, isPokemon, isPokemon, isPokemonOptional, isPokemonOptional, isPokemonOptional, isPokemonValue, isShiny, setEggCycles, toPokemon

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

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

Field Detail

SYNC_GROWTH

public static final DataSync<? extends AbstractBaseEntity,EnumGrowth> SYNC_GROWTH

SYNC_LEVEL

public static final DataSync<? extends AbstractBaseEntity,java.lang.Integer> SYNC_LEVEL

SYNC_EXP

public static final DataSync<? extends AbstractBaseEntity,java.lang.Integer> SYNC_EXP

SYNC_ENTITY_UUID

public static final DataSync<? extends AbstractBaseEntity,java.util.Optional<java.util.UUID>> SYNC_ENTITY_UUID

SYNC_NICK_NAME

public static final DataSync<? extends AbstractBaseEntity,net.minecraft.util.text.ITextComponent> SYNC_NICK_NAME

SYNC_RIBBON

public static final DataSync<? extends AbstractBaseEntity,Ribbon> SYNC_RIBBON

SYNC_HEALTH

public static final DataSync<? extends AbstractBaseEntity,java.lang.Float> SYNC_HEALTH

STATS

public static final EnumUpdateType[] STATS

ABILITY

public static final EnumUpdateType[] ABILITY

FORM

public static final EnumUpdateType[] FORM

EMPTY

public static final EnumUpdateType[] EMPTY

EGG

public static final net.minecraft.util.text.ITextComponent EGG

uuid
```
protected java.util.UUID uuid
```

moveset
```
protected Moveset moveset
```

nature
```
protected Nature nature
```

mintNature
```
protected Nature mintNature
```

growth
```
protected EnumGrowth growth
```

friendship
```
protected int friendship
```

pokemonLevelContainer

protected PokemonLevel pokemonLevelContainer

level
```
protected int level
```

experience
```
protected int experience
```

dynamaxLevel
```
protected int dynamaxLevel
```

gigantamaxFactor
```
protected boolean gigantamaxFactor
```

permanentStats

protected PermanentStats permanentStats

bonusStats
```
protected BonusStats bonusStats
```

eggSteps
```
protected java.lang.Integer eggSteps
```

heldItem

protected net.minecraft.item.ItemStack heldItem

status
```
protected StatusPersist status
```

extraStats
```
protected ExtraStats extraStats
```

nickname

protected net.minecraft.util.text.ITextComponent nickname

originalTrainerName

protected java.lang.String originalTrainerName

originalTrainerUUID

protected java.util.UUID originalTrainerUUID

pokerus
```
protected Pokerus pokerus
```

health
```
protected int health
```

doesLevel
```
protected boolean doesLevel
```

moveSkillCooldownData

protected volatile java.util.HashMap<java.lang.String,net.minecraft.util.Tuple<java.lang.Long,java.lang.Long>> moveSkillCooldownData

flags

protected java.util.ArrayList<java.lang.String> flags

ribbons

protected java.util.List<Ribbon> ribbons

displayedRibbon
```
protected Ribbon displayedRibbon
```

persistentData

protected net.minecraft.nbt.CompoundNBT persistentData

lastBattleCrits
```
public int lastBattleCrits
```

dimension

protected transient net.minecraft.util.RegistryKey<net.minecraft.world.World> dimension

entityID
```
protected transient int entityID
```

storage

protected transient PokemonStorage storage

position

protected transient StoragePosition position

Constructor Detail

Pokemon
```
protected Pokemon()
```
This constructor is STRONGLY discouraged, and exists only for JSON deserialization.

Pokemon

protected Pokemon(java.util.UUID uuid)

Pokemon

protected Pokemon(java.util.UUID uuid,
                  Species species)

Method Detail
- getPixelmonEntity
```
public java.util.Optional<PixelmonEntity> getPixelmonEntity()
```
- getPixelmonWrapper
```
public java.util.Optional<PixelmonWrapper> getPixelmonWrapper()
```
  Returns:
  
  The battle wrapper for the entity, if one exists
- getPixelmonWrapperFromPlayerEntity
```
@Deprecated
public java.util.Optional<PixelmonWrapper> getPixelmonWrapperFromPlayerEntity()
```
  Deprecated. Use this#getPixelmonWrapper()
  
  Returns:
  
  The battle wrapper for the entity, if one exists via the owner
- getOrSpawnPixelmon
```
public PixelmonEntity getOrSpawnPixelmon(net.minecraft.world.World world,
                                         double x,
                                         double y,
                                         double z,
                                         float rotationYaw,
                                         float rotationPitch)
```
  Gets the entity attached to this Pokémon, or spawns it if it does not exist in the given world.
  Caveats:
- If the entity exists but in a different world to that given, it will be killed and a new entity will be spawned in the appropriate world.
- If the given world is null, then it won't do the above and instead just return the Pokémon wherever it may be.
- In addition to the previous behaviour, a null world argument and nonexistent entity will result in the new entity being created in the zero dimension world.

Parameters:: world - The world the entity is needed in.
Returns:: An entity in the given world, or in the overworld if world is null.

getOrSpawnPixelmon

public PixelmonEntity getOrSpawnPixelmon(net.minecraft.world.World world,
                                         double x,
                                         double y,
                                         double z)

getOrSpawnPixelmon

public PixelmonEntity getOrSpawnPixelmon(net.minecraft.entity.Entity parent)

getOrCreatePixelmon

public PixelmonEntity getOrCreatePixelmon(net.minecraft.world.World world,
                                          double x,
                                          double y,
                                          double z,
                                          float rotationYaw,
                                          float rotationPitch)

Gets the entity attached to this Pokémon, or spawns it if it does not exist in the given world.

Caveats:

If the entity exists but in a different world to that given, it will be killed and a new entity will be spawned in the appropriate world.
If the given world is null, then it won't do the above and instead just return the Pokémon wherever it may be.
In addition to the previous behaviour, a null world argument and nonexistent entity will result in the new entity being created in the zero dimension world.

Class Pokemon

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.api.pokemon.PokemonBase

Constructor Summary

Method Summary

Methods inherited from class com.pixelmonmod.pixelmon.api.pokemon.PokemonBase

Methods inherited from class java.lang.Object

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

Field Detail

SYNC_GROWTH

SYNC_LEVEL

SYNC_EXP

SYNC_ENTITY_UUID

SYNC_NICK_NAME

SYNC_RIBBON

SYNC_HEALTH

STATS

ABILITY

FORM

EMPTY

EGG

uuid

moveset

nature

mintNature

growth

friendship

pokemonLevelContainer

level

experience

dynamaxLevel

gigantamaxFactor

permanentStats

bonusStats

eggSteps

heldItem

status

extraStats

nickname

originalTrainerName

originalTrainerUUID

pokerus

health

doesLevel

moveSkillCooldownData

flags

ribbons

displayedRibbon

persistentData

lastBattleCrits

dimension

entityID

storage

position

Constructor Detail

Pokemon

Pokemon

Pokemon

Method Detail

getPixelmonEntity

getPixelmonWrapper

getPixelmonWrapperFromPlayerEntity

getOrSpawnPixelmon

getOrSpawnPixelmon

getOrSpawnPixelmon

getOrCreatePixelmon

getOrCreatePixelmon

getOrCreatePixelmon

getOrCreatePixelmon

updateDimensionAndEntityID

getEntityID

getWorld

ifEntityExists

initialize

makeEgg

evolve

getUUID

setUUID

getOwnerTrainerUUID

getOwnerTrainer