Guilds/me.glaremasters.guilds.api.events.base/GuildEvent

GuildEvent

open class GuildEvent(player: Player, val guild: Guild) : PlayerEvent, Cancellable(source)

A base class for guild related events that occur in the game.

Constructors

GuildEvent

fun GuildEvent(player: Player, guild: Guild)

Creates a new GuildEvent with the given player and guild.

Types

Companion

object Companion

Functions

getEventName

@NotNull

open fun getEventName(): String

getHandlers

open override fun getHandlers(): HandlerList

Returns the list of handlers, through which this event is passed.

getPlayer

@NotNull

fun getPlayer(): Player

isAsynchronous

fun isAsynchronous(): Boolean

isCancelled

open override fun isCancelled(): Boolean

Returns whether this event is cancelled or not.

setCancelled

open override fun setCancelled(cancelled: Boolean)

Sets whether this event is cancelled or not.

Properties

guild

val guild: Guild

the guild that is involved in the event

Inheritors

GuildAddAllyEvent

GuildBuffEvent

GuildCreateEvent

GuildDepositMoneyEvent

GuildWithdrawMoneyEvent

GuildWarAcceptEvent

GuildWarChallengeEvent

GuildWarDeclineEvent