Package net.godlycow.org.essc.api.rtp.event

Class RtpFailEvent

java.lang.Object

org.bukkit.event.Event

net.godlycow.org.essc.api.rtp.event.RtpFailEvent

public class RtpFailEvent
extends org.bukkit.event.Event

Fired when an RTP request fails.

Observe-only: the request already failed, so this event cannot be cancelled. Inspect getReason() to react precisely.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RtpFailEvent.FailureReason	Why an RTP request failed.

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
RtpFailEvent(org.bukkit.entity.Player player, org.bukkit.World world, RtpFailEvent.FailureReason reason)	Creates a new RTP fail event without a detail message.
RtpFailEvent(org.bukkit.entity.Player player, org.bukkit.World world, RtpFailEvent.FailureReason reason, String detailMessage)	Creates a new RTP fail event.

Method Summary

Modifier and Type	Method	Description
String	getDetailMessage()	Returns extra failure detail, or an empty string if none.
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
org.bukkit.entity.Player	getPlayer()	Returns the requesting player.
RtpFailEvent.FailureReason	getReason()	Returns why the request failed.
org.bukkit.World	getWorld()	Returns the world.

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

RtpFailEvent

public RtpFailEvent(org.bukkit.entity.Player player,
 org.bukkit.World world,
 RtpFailEvent.FailureReason reason)

Creates a new RTP fail event without a detail message.

Parameters:

player - the requesting player

world - the world

reason - why the request failed

RtpFailEvent

public RtpFailEvent(org.bukkit.entity.Player player,
 org.bukkit.World world,
 RtpFailEvent.FailureReason reason,
 String detailMessage)

Creates a new RTP fail event.

Parameters:

player - the requesting player

world - the world

reason - why the request failed

detailMessage - extra detail, or an empty string

Method Details

getPlayer

public org.bukkit.entity.Player getPlayer()

Returns the requesting player.

Returns:

the player

getWorld

public org.bukkit.World getWorld()

Returns the world.

Returns:

the world

getReason

public RtpFailEvent.FailureReason getReason()

Returns why the request failed.

Returns:

the failure reason

getDetailMessage

public String getDetailMessage()

Returns extra failure detail, or an empty string if none.

Returns:

the detail message

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

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