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

Class LureExpiringEvent

java.lang.Object

net.neoforged.bus.api.Event

com.pixelmonmod.pixelmon.api.events.lures.LureExpiringEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

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

Event fired as a lure is degraded over time. This event allows developers to change the amount of damage that will be applied to the lure, or prevent damage from occurring in the first place.

Cancelling this event will prevent any damage from being done to the lure.

Since:

January 12, 2020

Field Summary

Fields

Modifier and Type	Field	Description
int	damage	The amount of damage that will be done to the lure.
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 is degrading.

Constructor Summary

Constructors

Constructor	Description
LureExpiringEvent(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 is degrading.

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.

damage

public int damage

The amount of damage that will be done to the lure. This can be changed.

Constructor Details

LureExpiringEvent

public LureExpiringEvent(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.