Package com.github.rumsfield.konquest.api.event.player

Class KonquestPlayerSettleEvent

java.lang.Object

org.bukkit.event.Event

com.github.rumsfield.konquest.api.event.KonquestEvent

com.github.rumsfield.konquest.api.event.player.KonquestPlayerEvent

com.github.rumsfield.konquest.api.event.player.KonquestPlayerSettleEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class KonquestPlayerSettleEvent
extends KonquestPlayerEvent
implements org.bukkit.event.Cancellable

Called before a player settles a new town using the "/k settle" command.

This event is called before the town is created. Canceling this event will prevent the town from being settled.

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
KonquestPlayerSettleEvent(KonquestAPI konquest, KonquestPlayer player, KonquestKingdom kingdom, org.bukkit.Location location, String name)	Default constructor

Method Summary

Modifier and Type	Method	Description
KonquestKingdom	getKingdom()	A convenience method to get the kingdom of the player settling the new town.
org.bukkit.Location	getLocation()	Gets the location where the new town will be created.
String	getName()	Gets the name of the new town.
boolean	isCancelled()
void	setCancelled(boolean val)

Methods inherited from class com.github.rumsfield.konquest.api.event.player.KonquestPlayerEvent

getPlayer

Methods inherited from class com.github.rumsfield.konquest.api.event.KonquestEvent

getHandlerList, getHandlers, getKonquest

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

Constructor Details

KonquestPlayerSettleEvent

public KonquestPlayerSettleEvent(KonquestAPI konquest,
 KonquestPlayer player,
 KonquestKingdom kingdom,
 org.bukkit.Location location,
 String name)

Default constructor

Parameters:

konquest - The API instance

player - The player

kingdom - The kingdom

location - The location

name - The name of the town

Method Details

getKingdom

public KonquestKingdom getKingdom()

A convenience method to get the kingdom of the player settling the new town.

Returns:

The kingdom

getLocation

public org.bukkit.Location getLocation()

Gets the location where the new town will be created.

Returns:

The center location of the new town

getName

public String getName()

Gets the name of the new town.

Returns:

The name

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