Package me.thehandsomeyoni.persistentdataapi.events.player

Class PlayerPersistentDataDeleteEvent

java.lang.Object

org.bukkit.event.Event

me.thehandsomeyoni.persistentdataapi.events.manager.PersistentDataEvent

me.thehandsomeyoni.persistentdataapi.events.player.PlayerPersistentDataDeleteEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class PlayerPersistentDataDeleteEvent
extends PersistentDataEvent

A custom event that is called when a player's persistent data is written.

Since:

1.2.0

Author:

TheHandsomeYoni

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
PlayerPersistentDataDeleteEvent(org.bukkit.entity.Player player, String dataName)	Initializes the PlayerPersistentDataDeleteEvent.
PlayerPersistentDataDeleteEvent(org.bukkit.entity.Player player, AbstractPersistentData persistentData)	Initializes the PlayerPersistentDataDeleteEvent.

Method Summary

Modifier and Type	Method	Description
String	getDataName()	Gets the data name of the persistent data.
Serializable	getDataValue()	Gets the value of the persistent data.
static org.bukkit.event.HandlerList	getHandlerList()	Gets the handlers.
org.bukkit.event.HandlerList	getHandlers()	Gets the handlers.
AbstractPersistentData	getPersistentData()	Gets the persistent data that is being deleted.
org.bukkit.entity.Player	getPlayer()	Gets the player that the persistent data is being deleted from.
boolean	isCancelled()	Checks if the event is cancelled.
void	setCancelled(boolean cancel)	Sets the event to cancel.

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerPersistentDataDeleteEvent

public PlayerPersistentDataDeleteEvent(org.bukkit.entity.Player player,
 AbstractPersistentData persistentData)

Initializes the PlayerPersistentDataDeleteEvent.

Parameters:

player - The player that the persistent data is being deleted from.

persistentData - The persistent data that is being removed.

PlayerPersistentDataDeleteEvent

public PlayerPersistentDataDeleteEvent(org.bukkit.entity.Player player,
 String dataName)

Initializes the PlayerPersistentDataDeleteEvent.

Parameters:

player - The player that the persistent data is being deleted from.

dataName - The name of the persistent data.

Method Details

isCancelled

public boolean isCancelled()

Checks if the event is cancelled.

Returns:

true if the event is cancelled, false otherwise.

setCancelled

public void setCancelled(boolean cancel)

Sets the event to cancel.

Parameters:

cancel - true to cancel the event, false otherwise.

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Gets the handlers.

Specified by:

getHandlers in class org.bukkit.event.Event

Returns:

The handlers.

getHandlerList

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

Gets the handlers.

Returns:

The handlers.

getPersistentData

public AbstractPersistentData getPersistentData()

Gets the persistent data that is being deleted.

Specified by:

getPersistentData in class PersistentDataEvent

Returns:

The persistent data.

getDataName

public String getDataName()

Gets the data name of the persistent data.

Specified by:

getDataName in class PersistentDataEvent

Returns:

The data name.

getDataValue

public Serializable getDataValue()

Gets the value of the persistent data.

Specified by:

getDataValue in class PersistentDataEvent

Returns:

The value.

getPlayer

public org.bukkit.entity.Player getPlayer()

Gets the player that the persistent data is being deleted from.

Returns:

The player.