Package io.github.thebusybiscuit.slimefun4.api.events

Class TalismanActivateEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.github.thebusybiscuit.slimefun4.api.events.TalismanActivateEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class TalismanActivateEvent
extends org.bukkit.event.player.PlayerEvent
implements org.bukkit.event.Cancellable

This PlayerEvent is called when a Player activates a Talisman

Author:

cworldstar

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
TalismanActivateEvent(org.bukkit.entity.Player player, Talisman talisman, org.bukkit.inventory.ItemStack talismanItem)

Method Summary

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
Talisman	getTalisman()
org.bukkit.inventory.ItemStack	getTalismanItem()
boolean	isCancelled()
boolean	preventsConsumption()	Only applies if Talisman.isConsumable() is true.
void	setCancelled(boolean cancel)
void	setPreventConsumption(boolean preventConsumption)	Only applies if Talisman.isConsumable() is true.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

TalismanActivateEvent

@ParametersAreNonnullByDefault
public TalismanActivateEvent(org.bukkit.entity.Player player,
 Talisman talisman,
 org.bukkit.inventory.ItemStack talismanItem)

Parameters:

player - The Player who activated the talisman.

talisman - The Talisman that was activated.

talismanItem - The ItemStack corresponding to the Talisman.

Method Details

getTalisman

@Nonnull
public Talisman getTalisman()

Returns:

The Talisman used.

getTalismanItem

@Nonnull
public org.bukkit.inventory.ItemStack getTalismanItem()

Returns:

The ItemStack of the used Talisman.

preventsConsumption

public boolean preventsConsumption()

Only applies if Talisman.isConsumable() is true. Defaults to false.

Returns:

Whether the ItemStack should not be consumed.

setPreventConsumption

public void setPreventConsumption(boolean preventConsumption)

Only applies if Talisman.isConsumable() is true.

Parameters:

preventConsumption - Whether the ItemStack should not be consumed.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getHandlers

@Nonnull
public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

@Nonnull
public static org.bukkit.event.HandlerList getHandlerList()