com.pixelmonmod.pixelmon.api.events

Class PokedexEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

com.pixelmonmod.pixelmon.api.events.PokedexEvent

Direct Known Subclasses:

PokedexEvent.Post, PokedexEvent.Pre

public class PokedexEvent
extends net.minecraftforge.eventbus.api.Event

Fired when a new Pokémon is being added to the Pokédex as seen or caught. The cause of the addition (trade, capture, etc.) is not calculated here, but is left to the handler.

Important notes about the details of this event:

• A Pokédex update is fired for every movement of a Pokémon in a party/PC.
• At the time of writing, Pokédex updates are also called for capture, trades, evolution, and eggs hatching.
• The player whose Pokédex is being updated might not be online during event firing

Cancelling this event will prevent the Pokédex from accepting this change. If you do block a specific cause of Pokédex update then you also will need to block the storage movement cause, otherwise you're wasting your time. Alternatively, you could 'tag' Pokémon that were received through the causes you want to block and block only the storage movement Pokédex events that are tagged.

Since:

February 27, 2019 (Pixelmon 7.0.4)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PokedexEvent.Constants Class used for storing constants relating to the cause of the PokedexEvent
static class	PokedexEvent.Post Fired after the player's pokedex is updated
static class	PokedexEvent.Pre Event fired just before the player's pokedex is updated Cancelling will mean the pokemon doesn't get modified in their pokedex

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cause
protected PokedexRegistrationStatus	newStatus
protected PokedexRegistrationStatus	oldStatus
protected Pokemon	pokemon
protected java.util.UUID	uuid

Constructor Summary

Constructors

Modifier	Constructor and Description
	PokedexEvent(java.util.UUID uuid, PokedexRegistrationStatus oldStatus, Pokemon pokemon, PokedexRegistrationStatus newStatus, java.lang.String cause)
protected	PokedexEvent(java.util.UUID uuid, Pokemon pokemon, PokedexRegistrationStatus newStatus, java.lang.String cause)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCause() Gets the cause of the event
PokedexRegistrationStatus	getNewStatus() Gets the registration status it's transitioning to
PokedexRegistrationStatus	getOldStatus() Gets the registration status it's transitioning from
net.minecraft.entity.player.ServerPlayerEntity	getPlayer() Gets the player relating to the event
java.util.UUID	getPlayerUUID() Gets the UUID of the player for the event
PlayerPokedex	getPokedex()
Pokemon	getPokemon() Gets the Pokemon relevant to the dex event
boolean	isBeingSeenByPokedexKey()
boolean	isCausedBy(java.lang.String... causes) Checks if the event was caused by one of the given causes
boolean	isCausedByCapture()
boolean	isCausedByEggHatching()
boolean	isCausedByEvolution()
boolean	isCausedByNPCTrade()
boolean	isCausedByPlayerTrade()
boolean	isCausedBySidemod()
boolean	isCausedByStorageMovement()
boolean	isInternal()

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getParentListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uuid

protected final java.util.UUID uuid

oldStatus

protected final PokedexRegistrationStatus oldStatus

pokemon

protected Pokemon pokemon

newStatus

protected PokedexRegistrationStatus newStatus

cause

protected java.lang.String cause

Constructor Detail

PokedexEvent

protected PokedexEvent(java.util.UUID uuid,
                       Pokemon pokemon,
                       PokedexRegistrationStatus newStatus,
                       java.lang.String cause)

PokedexEvent

public PokedexEvent(java.util.UUID uuid,
                    PokedexRegistrationStatus oldStatus,
                    Pokemon pokemon,
                    PokedexRegistrationStatus newStatus,
                    java.lang.String cause)

Method Detail

getPlayerUUID

public java.util.UUID getPlayerUUID()

Gets the UUID of the player for the event

Returns:

The UUID

getPlayer

public net.minecraft.entity.player.ServerPlayerEntity getPlayer()

Gets the player relating to the event

Returns:

The player

getPokemon

public Pokemon getPokemon()

Gets the Pokemon relevant to the dex event

Returns:

The Pokemon causing the event

getPokedex

public PlayerPokedex getPokedex()

getNewStatus

public PokedexRegistrationStatus getNewStatus()

Gets the registration status it's transitioning to

Returns:

The new registration status

getOldStatus

public PokedexRegistrationStatus getOldStatus()

Gets the registration status it's transitioning from

Returns:

The old registration status

getCause

public java.lang.String getCause()

Gets the cause of the event

Returns:

The cause

isCausedBy

public boolean isCausedBy(java.lang.String... causes)

Checks if the event was caused by one of the given causes

Parameters:

causes - The cause

Returns:

True if it was caused by one of them

isCausedByCapture

public boolean isCausedByCapture()

isCausedByPlayerTrade

public boolean isCausedByPlayerTrade()

isCausedByNPCTrade

public boolean isCausedByNPCTrade()

isCausedByEvolution

public boolean isCausedByEvolution()

isCausedByEggHatching

public boolean isCausedByEggHatching()

isCausedByStorageMovement

public boolean isCausedByStorageMovement()

isBeingSeenByPokedexKey

public boolean isBeingSeenByPokedexKey()

isCausedBySidemod

public boolean isCausedBySidemod()

isInternal

public boolean isInternal()