Adds comments to all custom events

Adds full comments to every class implementing StarGateEvent
Adds another abstract event StargatePlayerEvent which reduces code duplication
This commit is contained in:
2021-02-19 12:06:23 +01:00
parent 5b7f5649b1
commit c912624df1
10 changed files with 344 additions and 173 deletions

View File

@ -3,24 +3,18 @@ package net.knarcraft.stargate.event;
import net.knarcraft.stargate.Portal;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.NotNull;
/**
* This event should be called whenever a player attempts to access a stargate
*/
@SuppressWarnings("unused")
public class StargateAccessEvent extends StargateEvent {
public class StargateAccessEvent extends StargatePlayerEvent {
private final Player player;
private boolean deny;
private static final HandlerList handlers = new HandlerList();
/**
* Gets a handler-list containing all event handlers
* @return <p>A handler-list with all event handlers</p>
*/
public static HandlerList getHandlerList() {
return handlers;
}
/**
* Instantiates a new stargate access event
* @param player <p>The player involved in the vent</p>
@ -28,9 +22,8 @@ public class StargateAccessEvent extends StargateEvent {
* @param deny <p>Whether the event should be denied</p>
*/
public StargateAccessEvent(Player player, Portal portal, boolean deny) {
super("StargateAccessEvent", portal);
this.player = player;
super("StargateAccessEvent", portal, player);
this.deny = deny;
}
@ -51,15 +44,17 @@ public class StargateAccessEvent extends StargateEvent {
}
/**
* Gets the player involved in this stargate access event
* @return <p>The player involved in this event</p>
* Gets a handler-list containing all event handlers
* @return <p>A handler-list with all event handlers</p>
*/
public Player getPlayer() {
return this.player;
}
@Override
public @org.jetbrains.annotations.NotNull HandlerList getHandlers() {
public static HandlerList getHandlerList() {
return handlers;
}
@Override
@NotNull
public HandlerList getHandlers() {
return handlers;
}
}