Package com.pixelmonmod.pixelmon.api.events.lures

Class LureExpiredEvent

java.lang.Object

net.neoforged.bus.api.Event

com.pixelmonmod.pixelmon.api.events.lures.LureExpiredEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class LureExpiredEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

Event fired when a lure has completely expired. This occurs when the item damage of a lure reaches 128. A lure casing will be returned to the player if this event fires without being cancelled. The casing item stack can be modified in this event.

Cancelling this event will prevent the lure from being destroyed and will set the remaining item durability to 1. It will also prevent a lure casing from being given to the player.

Since:

January 12, 2020

Field Summary

Fields

Modifier and Type	Field	Description
net.minecraft.world.item.ItemStack	casingStack	The item stack representing the casing that will be returned to the player afterwards.
final LureItem	lure	The specific lure item.
final net.minecraft.world.item.ItemStack	lureStack	The item stack representing the lure.
final PlayerPartyStorage	party	The PlayerPartyStorage that the lure is housed in.
final net.minecraft.server.level.ServerPlayer	player	The player whose lure has expired.

Constructor Summary

Constructors

Constructor	Description
LureExpiredEvent(net.minecraft.server.level.ServerPlayer player)

Method Summary

Modifier and Type	Method	Description
LureItem.LureStrength	getStrength()	Gets the lure strength.
LureItem.LureType	getType()	Gets the lure type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

player

public final net.minecraft.server.level.ServerPlayer player

The player whose lure has expired.

party

public final PlayerPartyStorage party

The PlayerPartyStorage that the lure is housed in.

lureStack

public final net.minecraft.world.item.ItemStack lureStack

The item stack representing the lure.

lure

public final LureItem lure

The specific lure item.

casingStack

public net.minecraft.world.item.ItemStack casingStack

The item stack representing the casing that will be returned to the player afterwards. This can be modified.

Constructor Details

LureExpiredEvent

public LureExpiredEvent(net.minecraft.server.level.ServerPlayer player)

Method Details

getType

public LureItem.LureType getType()

Gets the lure type.

getStrength

public LureItem.LureStrength getStrength()

Gets the lure strength.