PlayerDataSaveEvent
extends Event
in package
implements
Cancellable
Uses
CancellableTrait
Called when a player's data is about to be saved to disk.
Interfaces, Classes, Traits and Enums
- Cancellable
- This interface is implemented by an Event subclass if and only if it can be cancelled.
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $data : CompoundTag
- $eventName : string|null
- $playerName : string
- $eventCallDepth : int
- $isCancelled : bool
- $player : Player|null
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getEventName() : string
- getPlayer() : Player|null
- Returns the player whose data is being saved, if online.
- getPlayerName() : string
- Returns the username of the player whose data is being saved. This is not necessarily an online player.
- getSaveData() : CompoundTag
- Returns the data to be written to disk as a CompoundTag
- isCancelled() : bool
- setSaveData() : void
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$data
protected
CompoundTag
$data
$eventName
protected
string|null
$eventName
= null
$playerName
protected
string
$playerName
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$player
private
Player|null
$player
Methods
__construct()
public
__construct(CompoundTag $nbt, string $playerName, Player|null $player) : mixed
Parameters
- $nbt : CompoundTag
- $playerName : string
- $player : Player|null
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —cancel()
public
cancel() : void
Return values
void —getEventName()
public
final getEventName() : string
Return values
string —getPlayer()
Returns the player whose data is being saved, if online.
public
getPlayer() : Player|null
If null, this data is for an offline player (possibly just disconnected).
Return values
Player|null —getPlayerName()
Returns the username of the player whose data is being saved. This is not necessarily an online player.
public
getPlayerName() : string
Return values
string —getSaveData()
Returns the data to be written to disk as a CompoundTag
public
getSaveData() : CompoundTag
Return values
CompoundTag —isCancelled()
public
isCancelled() : bool
Return values
bool —setSaveData()
public
setSaveData(CompoundTag $data) : void
Parameters
- $data : CompoundTag
Return values
void —uncancel()
public
uncancel() : void