com.pixelmonmod.pixelmon.api.events.lures

Class LureExpiringEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

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

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

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

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
int	damage The amount of damage that will be done to the lure.
LureItem	lure The specific lure item.
net.minecraft.item.ItemStack	lureStack The item stack representing the lure.
PlayerPartyStorage	party The PlayerPartyStorage that the lure is housed in.
net.minecraft.entity.player.ServerPlayerEntity	player The player whose lure is degrading.

Constructor Summary

Constructors

Constructor and Description
LureExpiringEvent(net.minecraft.entity.player.ServerPlayerEntity player)

Method Summary

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

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 whose lure is degrading.

party

public final PlayerPartyStorage party

The PlayerPartyStorage that the lure is housed in.

lureStack

public final net.minecraft.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 Detail

LureExpiringEvent

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

Method Detail

getType

public LureItem.LureType getType()

Gets the lure type.

getStrength

public LureItem.LureStrength getStrength()

Gets the lure strength.