mirror of
https://github.com/plexusorg/Plex.git
synced 2025-07-05 00:56:42 +00:00
Add documentation to custom Plex events + config
This commit is contained in:
@ -8,13 +8,28 @@ import org.bukkit.Bukkit;
|
||||
import org.bukkit.event.Cancellable;
|
||||
import org.bukkit.event.player.PlayerEvent;
|
||||
|
||||
/**
|
||||
* Superclass for punishment events
|
||||
*/
|
||||
@Getter
|
||||
public abstract class PunishedPlayerEvent extends PlayerEvent implements Cancellable
|
||||
{
|
||||
/**
|
||||
* The player who was punished
|
||||
*/
|
||||
protected PunishedPlayer punishedPlayer;
|
||||
@Setter
|
||||
protected boolean cancelled;
|
||||
|
||||
/**
|
||||
* Whether the event was cancelled
|
||||
*/
|
||||
@Setter
|
||||
protected boolean cancelled; //TODO: unsure if cancelling the event does anything
|
||||
|
||||
/**
|
||||
* Creates an event object
|
||||
* @param punishedPlayer The player who was punished
|
||||
* @see PunishedPlayer
|
||||
*/
|
||||
protected PunishedPlayerEvent(PunishedPlayer punishedPlayer)
|
||||
{
|
||||
super(Bukkit.getPlayer(UUID.fromString(punishedPlayer.getUuid())));
|
||||
|
Reference in New Issue
Block a user