Add missing javadocs.

This commit is contained in:
drtshock
2014-07-09 14:01:53 -05:00
parent 4d5278b079
commit 3298183fdf
14 changed files with 165 additions and 24 deletions

View File

@@ -4,9 +4,10 @@ import com.massivecraft.factions.FPlayer;
import com.massivecraft.factions.Faction;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;
/**
* Event called when a player loses power.
*/
public class PowerLossEvent extends FactionPlayerEvent implements Cancellable {
private boolean cancelled = false;
@@ -16,25 +17,56 @@ public class PowerLossEvent extends FactionPlayerEvent implements Cancellable {
super(f, p);
}
/**
* Get the id of the faction.
*
* @return id of faction as String
*
* @deprecated use getFaction().getId() instead.
*/
@Deprecated
public String getFactionId() {
return getFaction().getId();
}
/**
* Get the tag of the faction.
*
* @return tag of faction as String
*
* @deprecated use getFaction().getTag() instead.
*/
@Deprecated
public String getFactionTag() {
return getFaction().getTag();
}
/**
* Get the Player involved in the event.
*
* @return Player from FPlayer.
*
* @deprecated use getfPlayer().getPlayer() instead.
*/
@Deprecated
public Player getPlayer() {
return getfPlayer().getPlayer();
}
/**
* Get the power loss message.
*
* @return power loss message as String.
*/
public String getMessage() {
return message;
}
/**
* Set the power loss message.
*
* @param message
*/
public void setMessage(String message) {
this.message = message;
}