Add documentation to custom Plex events + config

This commit is contained in:
Taahh
2022-02-07 09:07:48 -08:00
committed by GitHub
parent 917775e7e7
commit bd8c772228
9 changed files with 100 additions and 4 deletions

View File

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