com.pixelmonmod.pixelmon.api.events

Class HeldItemChangedEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

com.pixelmonmod.pixelmon.api.events.HeldItemChangedEvent

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

Event fired whenever a Pokémon's held item is changed. As of the time of creation, this captures all Pixelmon-handled out-of-battle held item changes. However, it is possible for sidemods to modify the held item without triggering this event, and in-battle held item changes are ignored.

Cancelling this event will prevent the held item from being changed and, if the change was triggered via the inventory party GUI, prevents any associated changes from being performed on the player's inventory.

Nested Class Summary

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
net.minecraft.item.ItemStack	newHeldItem The held item to use.
net.minecraft.entity.player.ServerPlayerEntity	player The player owner of the Pokémon, if there is a player owner.
Pokemon	pokemon The Pokémon who is getting the new item.

Constructor Summary

Constructors

Constructor and Description
HeldItemChangedEvent(net.minecraft.entity.player.ServerPlayerEntity player, Pokemon pokemon, net.minecraft.item.ItemStack newHeldItem)

Method Summary

Modifier and Type	Method and Description
Species	getSpecies() Gets the type of Pokémon whose held item was changed, as an Species

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

player

public final net.minecraft.entity.player.ServerPlayerEntity player

The player owner of the Pokémon, if there is a player owner.

pokemon

public final Pokemon pokemon

The Pokémon who is getting the new item.

newHeldItem

@Nonnull
public net.minecraft.item.ItemStack newHeldItem

The held item to use. This may be modified.

Constructor Detail

HeldItemChangedEvent

public HeldItemChangedEvent(@Nullable
                            net.minecraft.entity.player.ServerPlayerEntity player,
                            Pokemon pokemon,
                            net.minecraft.item.ItemStack newHeldItem)

Method Detail

getSpecies

public Species getSpecies()

Gets the type of Pokémon whose held item was changed, as an Species