Package me.thehandsomeyoni.persistentdataapi.events.player

Class PlayerPersistentDataWriteEvent

java.lang.Object

org.bukkit.event.Event

me.thehandsomeyoni.persistentdataapi.events.manager.PersistentDataEvent

me.thehandsomeyoni.persistentdataapi.events.player.PlayerPersistentDataWriteEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class PlayerPersistentDataWriteEvent
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
PlayerPersistentDataWriteEvent(org.bukkit.entity.Player player, String dataName, Serializable dataValue)	Initializes the PlayerPersistentDataWriteEvent.
PlayerPersistentDataWriteEvent(org.bukkit.entity.Player player, AbstractPersistentData persistentData)	Initializes the PlayerPersistentDataWriteEvent.

Method Summary

Modifier and Type	Method	Description
String	getDataName()	Gets the data name of the persistent data.
Serializable	getDataValue()	Gets the data value of the persistent data.
static org.bukkit.event.HandlerList	getHandlerList()	Static method to get the handlers.
org.bukkit.event.HandlerList	getHandlers()	Gets the handlers.
AbstractPersistentData	getPersistentData()	Gets the persistent data written in the event.
org.bukkit.persistence.PersistentDataContainer	getPersistentDataContainer()	Gets the player's persistent data.
org.bukkit.entity.Player	getPlayer()	Gets the player that the persistent data is being written to.
boolean	isCancelled()	Checks if the event is cancelled.
void	setCancelled(boolean cancel)	Cancels the event.

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

PlayerPersistentDataWriteEvent

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

Initializes the PlayerPersistentDataWriteEvent.

Parameters:

player - The player that the persistent data is being written to.

persistentData - The persistent data that is being written.

PlayerPersistentDataWriteEvent

public PlayerPersistentDataWriteEvent(org.bukkit.entity.Player player,
 String dataName,
 Serializable dataValue)

Initializes the PlayerPersistentDataWriteEvent.

Parameters:

player - The player that the persistent data is being written to.

dataName - The name of the persistent data.

dataValue - The value 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)

Cancels the event.

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()

Static method to get the handlers.

Returns:

The handlers.

getPersistentData

public AbstractPersistentData getPersistentData()

Gets the persistent data written in the event.

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 data value of the persistent data.

Specified by:

getDataValue in class PersistentDataEvent

Returns:

The data value.

getPersistentDataContainer

public org.bukkit.persistence.PersistentDataContainer getPersistentDataContainer()

Gets the player's persistent data.

Returns:

The player's persistent data.

getPlayer

public org.bukkit.entity.Player getPlayer()

Gets the player that the persistent data is being written to.

Returns:

The player.