com.pixelmonmod.pixelmon.api.events

Class PokedexEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

com.pixelmonmod.pixelmon.api.events.PokedexEvent

public class PokedexEvent
extends net.minecraftforge.fml.common.eventhandler.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.

Created by Hiroku

Since:

February 27, 2019 (Pixelmon 7.0.4)

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPTURE Constant representing the Pokémon capture cause.
java.lang.String	cause The cause of this update.
static java.lang.String	COMMAND_GIVEN Constant representing the command given cause.
static java.lang.String	EGG Constant representing the egg hatching cause.
static java.lang.String	EVOLUTION Constant representing the Pokémon evolution cause.
EnumPokedexRegisterStatus	newStatus What the Pokédex status is about to be.
EnumPokedexRegisterStatus	oldStatus What the Pokédex status was before.
static java.lang.String	POKEDEX_KEY Constant representing the Pokédex key cause for marking a species as seen.
Pokemon	pokemon The Pokémon that is prompting this Pokédex update.
static java.lang.String	STORAGE_MOVEMENT Constant representing the storage movements cause.
static java.lang.String	TRADE_NPC Constant representing the NPC-trade cause.
static java.lang.String	TRADE_PLAYER Constant representing the player-trade cause.
java.util.UUID	uuid The UUID of the player whose Pokédex is being updated.

Constructor Summary

Constructors

Constructor and Description
PokedexEvent(java.util.UUID uuid, Pokemon pokemon, EnumPokedexRegisterStatus newStatus, java.lang.String cause)

Method Summary

Modifier and Type	Method and Description
EnumSpecies	getSpecies()
boolean	isBeingSeenByPokedexKey()
boolean	isCausedByCapture()
boolean	isCausedByEggHatching()
boolean	isCausedByEvolution()
boolean	isCausedByNPCTrade()
boolean	isCausedByPlayerTrade()
boolean	isCausedBySidemod()
boolean	isCausedByStorageMovement()

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, 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

CAPTURE

public static final java.lang.String CAPTURE

Constant representing the Pokémon capture cause.

See Also:

Constant Field Values

TRADE_PLAYER

public static final java.lang.String TRADE_PLAYER

Constant representing the player-trade cause.

See Also:

Constant Field Values

TRADE_NPC

public static final java.lang.String TRADE_NPC

Constant representing the NPC-trade cause.

See Also:

Constant Field Values

EVOLUTION

public static final java.lang.String EVOLUTION

Constant representing the Pokémon evolution cause.

See Also:

Constant Field Values

EGG

public static final java.lang.String EGG

Constant representing the egg hatching cause.

See Also:

Constant Field Values

STORAGE_MOVEMENT

public static final java.lang.String STORAGE_MOVEMENT

Constant representing the storage movements cause.

See Also:

Constant Field Values

COMMAND_GIVEN

public static final java.lang.String COMMAND_GIVEN

Constant representing the command given cause.

See Also:

Constant Field Values

POKEDEX_KEY

public static final java.lang.String POKEDEX_KEY

Constant representing the Pokédex key cause for marking a species as seen.

See Also:

Constant Field Values

uuid

public final java.util.UUID uuid

The UUID of the player whose Pokédex is being updated.

pokemon

public final Pokemon pokemon

The Pokémon that is prompting this Pokédex update.

oldStatus

public final EnumPokedexRegisterStatus oldStatus

What the Pokédex status was before.

newStatus

public final EnumPokedexRegisterStatus newStatus

What the Pokédex status is about to be.

cause

public final java.lang.String cause

The cause of this update. This is usually one of the string constants defined in this class, but sidemods might use different strings.

Constructor Detail

PokedexEvent

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

Method Detail

getSpecies

public EnumSpecies getSpecies()

isCausedByCapture

public boolean isCausedByCapture()

isCausedByPlayerTrade

public boolean isCausedByPlayerTrade()

isCausedByNPCTrade

public boolean isCausedByNPCTrade()

isCausedByEvolution

public boolean isCausedByEvolution()

isCausedByEggHatching

public boolean isCausedByEggHatching()

isCausedByStorageMovement

public boolean isCausedByStorageMovement()

isCausedBySidemod

public boolean isCausedBySidemod()

isBeingSeenByPokedexKey

public boolean isBeingSeenByPokedexKey()