From 7a75de5fb82160da2b27ce2efe9dee104b1cfe18 Mon Sep 17 00:00:00 2001 From: Byteflux Date: Thu, 23 Jul 2015 21:41:35 -0700 Subject: [PATCH] Add javadocs to BeaconEffectEvent --- .../Add-BeaconEffectEvent.patch | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/Spigot-API-Patches/Add-BeaconEffectEvent.patch b/Spigot-API-Patches/Add-BeaconEffectEvent.patch index 42d36b7ce..6c9630221 100644 --- a/Spigot-API-Patches/Add-BeaconEffectEvent.patch +++ b/Spigot-API-Patches/Add-BeaconEffectEvent.patch @@ -19,6 +19,9 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000 +import org.bukkit.event.block.BlockEvent; +import org.bukkit.potion.PotionEffect; + ++/** ++ * Called when a beacon effect is being applied to a player. ++ */ +public class BeaconEffectEvent extends BlockEvent implements Cancellable { + private static final HandlerList handlers = new HandlerList(); + private boolean cancelled; @@ -43,18 +46,38 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000 + this.cancelled = cancelled; + } + ++ /** ++ * Gets the potion effect being applied. ++ * ++ * @return Potion effect ++ */ + public PotionEffect getEffect() { + return effect; + } + ++ /** ++ * Sets the potion effect that will be applied. ++ * ++ * @param effect Potion effect ++ */ + public void setEffect(PotionEffect effect) { + this.effect = effect; + } + ++ /** ++ * Gets the player who the potion effect is being applied to. ++ * ++ * @return Affected player ++ */ + public Player getPlayer() { + return player; + } + ++ /** ++ * Gets whether the effect is a primary beacon effect. ++ * ++ * @return true if this event represents a primary effect ++ */ + public boolean isPrimary() { + return primary; + }