Package dev.majek.pc.api

Class PartyLeaveEvent

java.lang.Object

org.bukkit.event.Event

dev.majek.pc.api.PartyLeaveEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class PartyLeaveEvent
extends org.bukkit.event.Event
implements org.bukkit.event.Cancellable

Handles the event fired when a player leaves a party.

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
PartyLeaveEvent(org.bukkit.OfflinePlayer player, Party party, @Nullable User newLeader)	Fires when an in-game player leaves a party.

Method Summary

Modifier and Type	Method	Description
static org.bukkit.event.HandlerList	getHandlerList()
@NotNull org.bukkit.event.HandlerList	getHandlers()
@Nullable User	getNewLeader()	The randomly chosen player who will be the new party leader.
Party	getParty()	Get the party the player is leaving.
org.bukkit.OfflinePlayer	getPlayer()	Get the player who is leaving the party.
boolean	isCancelled()
boolean	isLeader()	Whether or not the player leaving the party is currently the leader.
void	setCancelled(boolean cancel)
void	setNewLeader(User player)	Set a different player to be the new party leader.

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartyLeaveEvent

public PartyLeaveEvent(org.bukkit.OfflinePlayer player,
                       Party party,
                       @Nullable
                       @Nullable User newLeader)

Fires when an in-game player leaves a party.

Parameters:

player - The in-game player leaving the party.

party - The party the player is leaving.

newLeader - The new leader of the party if there is one.

Method Detail

getPlayer

public org.bukkit.OfflinePlayer getPlayer()

Get the player who is leaving the party.

Returns:

Leaving player.

getParty

public Party getParty()

Get the party the player is leaving.

Returns:

Party player is leaving.

isLeader

public boolean isLeader()

Whether or not the player leaving the party is currently the leader.

Returns:

Whether or not player is leader.

getNewLeader

@Nullable
public @Nullable User getNewLeader()

The randomly chosen player who will be the new party leader. Can be null if the leader is the only player in the party or the player leaving is not the leader.

Returns:

The new party leader.

setNewLeader

public void setNewLeader(User player)

Set a different player to be the new party leader.

Parameters:

player - New leader.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancel)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getHandlers

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

Specified by:

getHandlers in class org.bukkit.event.Event

getHandlerList

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