Package com.palmergames.bukkit.towny.event.town

Class TownPreInvitePlayerEvent

java.lang.Object

org.bukkit.event.Event

com.palmergames.bukkit.towny.event.CancellableTownyEvent

com.palmergames.bukkit.towny.event.town.TownPreInvitePlayerEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class TownPreInvitePlayerEvent
extends CancellableTownyEvent

Cancellable event that gets fired before a resident is invited to a town.

Since:

0.96.7.12

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
TownPreInvitePlayerEvent(Invite invite)

Method Summary

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
@NotNull org.bukkit.event.HandlerList	getHandlers()
Invite	getInvite()
Resident	getInvitedResident()	Convenience method for getting the resident that was invited.
Town	getTown()	Convenience method for getting the town that sent the invite.

Methods inherited from class com.palmergames.bukkit.towny.event.CancellableTownyEvent

getCancelMessage, isCancelled, setCancelled, setCancelMessage

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

TownPreInvitePlayerEvent

public TownPreInvitePlayerEvent(Invite invite)

Method Details

getInvite

public Invite getInvite()

getInvitedResident

public Resident getInvitedResident()

Convenience method for getting the resident that was invited.

Returns:

The Resident that was invited.

getTown

public Town getTown()

Convenience method for getting the town that sent the invite.

Returns:

The Town that the resident is invited to join.

getHandlerList

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

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event