com.alessiodp.parties.api.events.bukkit.player

Class BukkitPartiesPlayerPreLeaveEvent

java.lang.Object

org.bukkit.event.Event

com.alessiodp.parties.api.events.bukkit.BukkitPartiesEvent

com.alessiodp.parties.api.events.bukkit.player.BukkitPartiesPlayerPreLeaveEvent

All Implemented Interfaces:

IPlayerPreLeaveEvent, PartiesEvent, org.bukkit.event.Cancellable

public class BukkitPartiesPlayerPreLeaveEvent
extends BukkitPartiesEvent
implements IPlayerPreLeaveEvent, org.bukkit.event.Cancellable

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor and Description
BukkitPartiesPlayerPreLeaveEvent(PartyPlayer player, Party party, LeaveCause cause, PartyPlayer kicker)

Method Summary

Modifier and Type	Method and Description
@NotNull LeaveCause	getCause() Get the leave cause
@Nullable PartyPlayer	getKicker() Get the kicker
@NotNull Party	getParty() Get the party
@NotNull PartyPlayer	getPartyPlayer() Get the player that is leaveing the party
boolean	isCancelled() Is the event cancelled?
void	setCancelled(boolean cancel) Set the event as cancelled

Methods inherited from class com.alessiodp.parties.api.events.bukkit.BukkitPartiesEvent

getApi, getHandlerList, getHandlers, setApi

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

Methods inherited from interface com.alessiodp.parties.api.events.common.player.IPlayerPreLeaveEvent

isKicked

Methods inherited from interface com.alessiodp.parties.api.events.PartiesEvent

getApi, setApi

Constructor Detail

BukkitPartiesPlayerPreLeaveEvent

public BukkitPartiesPlayerPreLeaveEvent(PartyPlayer player,
                                        Party party,
                                        LeaveCause cause,
                                        PartyPlayer kicker)

Method Detail

getPartyPlayer

@NotNull
public @NotNull PartyPlayer getPartyPlayer()

Description copied from interface: IPlayerPreLeaveEvent

Get the player that is leaveing the party

Specified by:

getPartyPlayer in interface IPlayerPreLeaveEvent

Returns:

the PartyPlayer

getParty

@NotNull
public @NotNull Party getParty()

Description copied from interface: IPlayerPreLeaveEvent

Get the party

Specified by:

getParty in interface IPlayerPreLeaveEvent

Returns:

the Party

getCause

@NotNull
public @NotNull LeaveCause getCause()

Description copied from interface: IPlayerPreLeaveEvent

Get the leave cause

Specified by:

getCause in interface IPlayerPreLeaveEvent

Returns:

the LeaveCause of the event

getKicker

@Nullable
public @Nullable PartyPlayer getKicker()

Description copied from interface: IPlayerPreLeaveEvent

Get the kicker

Specified by:

getKicker in interface IPlayerPreLeaveEvent

Returns:

the PartyPlayer that has kicked the player, returns null if IPlayerPreLeaveEvent.isKicked() returns false

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Is the event cancelled?

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

Returns:

true if the event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Set the event as cancelled

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

Parameters:

cancel - true to cancel