PlayerPokedex (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- com.pixelmonmod.pixelmon.api.pokedex.PlayerPokedex

Direct Known Subclasses:

ClientPlayerPokedex
```
public class PlayerPokedex
extends java.lang.Object
```
Displays Pokémon data for seen and caught Pokémon.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PlayerPokedex.PokedexSpawnData

Nested Classes
Modifier and Type	Class and Description
`static class`	`PlayerPokedex.PokedexSpawnData`

Field Summary

Fields
Modifier and Type	Field and Description
`com.google.common.collect.Table<java.lang.Integer,java.lang.Short,java.lang.Short>`	`formDex` Tracker for unique forms seen by the player.
`java.util.UUID`	`uuid` The player who this Pokédex keeps track of.

Constructor Summary

Constructors
Constructor and Description

PlayerPokedex()
Initializes a Pokédex with no owner.

PlayerPokedex(java.util.UUID uuid)
Registers a Pokédex to its owner.

Constructors
Constructor and Description
`PlayerPokedex()` Initializes a Pokédex with no owner.
`PlayerPokedex(java.util.UUID uuid)` Registers a Pokédex to its owner.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkForCharms()`
`void`	`checkForOvalCharm()`
`void`	`checkForShinyCharm()`
`int`	`countCaught()` Counts the number of Pokémon the player has caught.
`int`	`countCaught(int generation)` Counts the number of Pokémon the player has caught.
`int`	`countSeen()` Counts the number of Pokémon the player has seen.
`int`	`countSeen(int generation)` Counts the number of Pokémon the player has seen.
`PokedexRegistrationStatus`	`get(int id)` Gets the register status of a Pokémon.
`float`	`getCaughtCompletionPercentage()` Gets the caught completion percentage of the player
`PokedexEntry`	`getEntry(int id)` Gets the entry through the registry status of the Pokemon
`float`	`getSeenCompletionPercentage()` Gets the seen completion percentage of the player
`java.util.Map<java.lang.Integer,PokedexRegistrationStatus>`	`getSeenMap()` Gets the register status map for the Pokédex.
`boolean`	`hasCaught(Species species)` Checks if a Pokémon has been caught.
`boolean`	`hasSeen(Species species)` Checks if a Pokémon has been seen.
`boolean`	`isRegistered(Species species)` Checks if a Pokémon has been seen or caught.
`net.minecraft.nbt.CompoundNBT`	`readFromNBT(net.minecraft.nbt.CompoundNBT nbt)` Reads Pokédex register status from NBT.
`java.util.Map<java.lang.Short,java.lang.Short>`	`seenForms(Species species)`
`boolean`	`set(int id, PokedexRegistrationStatus drs)` Sets an entry in the register status map.
`boolean`	`set(Pokemon pokemon, PokedexRegistrationStatus drs)` Sets an entry in the register status map.
`static boolean`	`set(java.util.UUID playerUUID, Pokemon id, PokedexRegistrationStatus drs)`
`void`	`setSeenList(java.util.HashMap<java.lang.Integer,PokedexRegistrationStatus> data)` Sets the Pokédex's register status map.
`void`	`setSeenMap(java.util.Map<java.lang.Integer,PokedexRegistrationStatus> seenMap)` Don't use this
`PlayerPokedex`	`setUUID(java.util.UUID uuid)`
`void`	`update()` Sends Pokédex data to the client player.
`void`	`wipe()`
`net.minecraft.nbt.CompoundNBT`	`writeToNBT(net.minecraft.nbt.CompoundNBT nbt)` Writes the register status map to NBT.

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

- Field Detail
  - uuid
```
public java.util.UUID uuid
```
    The player who this Pokédex keeps track of.
  - formDex
```
public com.google.common.collect.Table<java.lang.Integer,java.lang.Short,java.lang.Short> formDex
```
    Tracker for unique forms seen by the player. Key is nat number, array index is form number, array value is number encountered
- Constructor Detail
  - PlayerPokedex
```
public PlayerPokedex()
```
    Initializes a Pokédex with no owner.
  - PlayerPokedex
```
public PlayerPokedex(java.util.UUID uuid)
```
    Registers a Pokédex to its owner.
    
    Parameters:
    
    uuid - The UUID of the player who this Pokédex keeps track of.
- Method Detail
  - setUUID
```
public PlayerPokedex setUUID(java.util.UUID uuid)
```
  - readFromNBT
```
public net.minecraft.nbt.CompoundNBT readFromNBT(net.minecraft.nbt.CompoundNBT nbt)
```
    Reads Pokédex register status from NBT.
    
    Parameters:
    
    nbt - The NBT tag to read from.
    
    Returns:
    
    The NBT tag that was read from.
  - getSeenMap
```
public java.util.Map<java.lang.Integer,PokedexRegistrationStatus> getSeenMap()
```
    Gets the register status map for the Pokédex. HIGHLY recommended to use other methods to edit this
    
    Returns:
    
    The register status map for the Pokédex.
  - getSeenCompletionPercentage
```
public float getSeenCompletionPercentage()
```
    Gets the seen completion percentage of the player
    
    Returns:
    
    The completion percentage
  - getCaughtCompletionPercentage
```
public float getCaughtCompletionPercentage()
```
    Gets the caught completion percentage of the player
    
    Returns:
    
    The completion percentage
  - writeToNBT
```
public net.minecraft.nbt.CompoundNBT writeToNBT(net.minecraft.nbt.CompoundNBT nbt)
```
    Writes the register status map to NBT.
    
    Parameters:
    
    nbt - The NBT tag to write to.
    
    Returns:
    
    The NBT tag that was written to.
  - update
```
public void update()
```
    Sends Pokédex data to the client player.
  - set
```
public boolean set(Pokemon pokemon,
                   PokedexRegistrationStatus drs)
```
    Sets an entry in the register status map.
    
    Parameters:
    
    pokemon - The Pokémon to modify register status for.
    
    drs - The new register status to assign to the Pokémon.
    
    Returns:
    
    if the value has been updated to the given one.
  - set
```
public boolean set(int id,
                   PokedexRegistrationStatus drs)
```
    Sets an entry in the register status map.
    
    Parameters:
    
    id - The National Pokédex number of the Pokémon to modify register status for.
    
    drs - The new register status to assign to the Pokémon.
    
    Returns:
    
    if the value has been updated to the given one.
  - set
```
public static boolean set(java.util.UUID playerUUID,
                          Pokemon id,
                          PokedexRegistrationStatus drs)
```
  - wipe
```
public void wipe()
```
  - get
```
public PokedexRegistrationStatus get(int id)
```
    Gets the register status of a Pokémon.
    
    Parameters:
    
    id - The National Pokédex number of the Pokémon.
    
    Returns:
    
    The register status of the Pokémon.
  - getEntry
```
public PokedexEntry getEntry(int id)
```
    Gets the entry through the registry status of the Pokemon
    
    Parameters:
    
    id - The National Pokédex number of the Pokémon.
    
    Returns:
    
    The per-player entry for the Pokemon
  - isRegistered
```
public boolean isRegistered(Species species)
```
    Checks if a Pokémon has been seen or caught.
    
    Parameters:
    
    species - The species to check.
    
    Returns:
    
    true if the Pokémon has been seen or caught, false otherwise.
  - hasSeen
```
public boolean hasSeen(Species species)
```
    Checks if a Pokémon has been seen.
    
    Parameters:
    
    species - The species to check.
    
    Returns:
    
    true if the Pokémon has been seen or caught, false otherwise.
  - hasCaught
```
public boolean hasCaught(Species species)
```
    Checks if a Pokémon has been caught.
    
    Parameters:
    
    species - The species to check.
    
    Returns:
    
    true if the Pokémon has been caught, false otherwise.
  - countCaught
```
public int countCaught()
```
    Counts the number of Pokémon the player has caught.
    
    Returns:
    
    The number of Pokémon the player has caught.
  - countCaught
```
public int countCaught(int generation)
```
    Counts the number of Pokémon the player has caught.
    
    Parameters:
    
    generation - The generation to check
    
    Returns:
    
    The number of Pokémon the player has caught.
  - countSeen
```
public int countSeen()
```
    Counts the number of Pokémon the player has seen.
    
    Returns:
    
    The number of Pokémon the player has seen.
  - countSeen
```
public int countSeen(int generation)
```
    Counts the number of Pokémon the player has seen.
    
    Parameters:
    
    generation - The generation to check
    
    Returns:
    
    The number of Pokémon the player has seen.
  - setSeenMap
```
public void setSeenMap(java.util.Map<java.lang.Integer,PokedexRegistrationStatus> seenMap)
```
    Don't use this
  - seenForms
```
public java.util.Map<java.lang.Short,java.lang.Short> seenForms(Species species)
```
  - checkForOvalCharm
```
public void checkForOvalCharm()
```
  - checkForCharms
```
public void checkForCharms()
```
  - checkForShinyCharm
```
public void checkForShinyCharm()
```
  - setSeenList
```
public void setSeenList(java.util.HashMap<java.lang.Integer,PokedexRegistrationStatus> data)
```
    Sets the Pokédex's register status map.
    
    Parameters:
    
    data - The new register status map.

Class PlayerPokedex

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uuid

formDex

Constructor Detail

PlayerPokedex

PlayerPokedex

Method Detail

setUUID

readFromNBT

getSeenMap

getSeenCompletionPercentage

getCaughtCompletionPercentage

writeToNBT

update

set

set

set

wipe

get

getEntry

isRegistered

hasSeen

hasCaught

countCaught

countCaught

countSeen

countSeen

setSeenMap

seenForms

checkForOvalCharm

checkForCharms

checkForShinyCharm

setSeenList