Package konquest.api.event.player

Class KonquestPlayerExileEvent

java.lang.Object

org.bukkit.event.Event

konquest.api.event.KonquestEvent

konquest.api.event.player.KonquestPlayerExileEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class KonquestPlayerExileEvent
extends KonquestEvent
implements org.bukkit.event.Cancellable

Called before the given player has been exiled from their current kingdom and made into a barbarian.

Canceling this event will prevent the player from being exiled.

Author:

Rumsfield

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
KonquestPlayerExileEvent(KonquestAPI konquest, KonquestOfflinePlayer offlinePlayer, KonquestKingdom oldKingdom)	Default constructor

Method Summary

Modifier and Type	Method	Description
KonquestKingdom	getOldKingdom()	Gets the kingdom that the player is leaving
KonquestOfflinePlayer	getPlayer()	Gets the player that is being exiled.
boolean	isCancelled()
void	setCancelled(boolean val)

Methods inherited from class konquest.api.event.KonquestEvent

getHandlerList, getHandlers, getKonquest

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

KonquestPlayerExileEvent

public KonquestPlayerExileEvent(KonquestAPI konquest,
 KonquestOfflinePlayer offlinePlayer,
 KonquestKingdom oldKingdom)

Default constructor

Parameters:

konquest - The API instance

offlinePlayer - The player

oldKingdom - The kingdom

Method Details

getPlayer

public KonquestOfflinePlayer getPlayer()

Gets the player that is being exiled. This player can be online or offline.

Returns:

The player

getOldKingdom

public KonquestKingdom getOldKingdom()

Gets the kingdom that the player is leaving

Returns:

The old kingdom

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean val)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable