me.armar.plugins.autorank.api.events
Class PlayerPromoteEvent

java.lang.Object
  org.bukkit.event.Event
      me.armar.plugins.autorank.api.events.PlayerPromoteEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class PlayerPromoteEvent
extends org.bukkit.event.Event
implements org.bukkit.event.Cancellable

This event is called when a player is going to be promoted to a new group

Author:

Staartvin

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

private java.lang.String	groupFrom
private java.lang.String	groupTo
private static org.bukkit.event.HandlerList	handlers
private boolean	isCancelled
private org.bukkit.entity.Player	player
private java.lang.String	worldName

Constructor Summary

PlayerPromoteEvent(org.bukkit.entity.Player player, java.lang.String worldName, java.lang.String groupFrom, java.lang.String groupTo)

Method Summary

java.lang.String	getGroupFrom() Gets the group a player is grouped from
java.lang.String	getGroupTo() Gets the group a player is promoted to
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
org.bukkit.entity.Player	getPlayer()
java.lang.String	getWorld() Gets the world a player is ranked upon.
boolean	isCancelled()
void	setCancelled(boolean cancel)

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handlers

private static final org.bukkit.event.HandlerList handlers

player

private org.bukkit.entity.Player player

worldName

private java.lang.String worldName

groupFrom

private java.lang.String groupFrom

groupTo

private java.lang.String groupTo

isCancelled

private boolean isCancelled

Constructor Detail

PlayerPromoteEvent

public PlayerPromoteEvent(org.bukkit.entity.Player player,
                          java.lang.String worldName,
                          java.lang.String groupFrom,
                          java.lang.String groupTo)

Parameters:

player - Player

worldName - World

groupFrom - GroupFrom

groupTo - GroupTo

Method Detail

getPlayer

public org.bukkit.entity.Player getPlayer()

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

getWorld

public java.lang.String getWorld()

Gets the world a player is ranked upon. If world is null, player will be ranked globally.

Returns:

worldName or null if ranked globally

getGroupFrom

public java.lang.String getGroupFrom()

Gets the group a player is grouped from

Returns:

group a player was in

getGroupTo

public java.lang.String getGroupTo()

Gets the group a player is promoted to

Returns:

group where player will be promoted to

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable