Guilds/me.glaremasters.guilds.api.events/GuildRemoveEvent

GuildRemoveEvent

class GuildRemoveEvent(player: Player, val guild: Guild, val cause: GuildRemoveEvent.Cause) : GuildEvent(source)

Class representing an event that occurs when a player leaves a guild.

Constructors

Link copied to clipboard
fun GuildRemoveEvent(player: Player, guild: Guild, cause: GuildRemoveEvent.Cause)

Creates a new GuildRemoveEvent.

Types

Link copied to clipboard
enum Cause : Enum<GuildRemoveEvent.Cause>

Enumeration class representing the possible reasons a player may leave a guild.

Functions

Link copied to clipboard
@NotNull
open fun getEventName(): String
Link copied to clipboard
open override fun getHandlers(): HandlerList

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

Link copied to clipboard
@NotNull
fun getPlayer(): Player
Link copied to clipboard
Link copied to clipboard
open override fun isCancelled(): Boolean

Returns whether this event is cancelled or not.

Link copied to clipboard
open override fun setCancelled(cancelled: Boolean)

Sets whether this event is cancelled or not.

Properties

Link copied to clipboard
val cause: GuildRemoveEvent.Cause

the reason for the player leaving the guild

Link copied to clipboard
val guild: Guild

the guild that is involved in the event