Package com.minecolonies.api.eventbus.events.colony.permissions

Class PlayerLeavingModEvent

java.lang.Object

com.minecolonies.api.eventbus.events.AbstractModEvent

com.minecolonies.api.eventbus.events.colony.AbstractColonyModEvent

com.minecolonies.api.eventbus.events.colony.permissions.PlayerLeavingModEvent

All Implemented Interfaces:

IModEvent

public final class PlayerLeavingModEvent
extends AbstractColonyModEvent

Player leaving colony mod event.

Constructor Summary

Constructors

Constructor	Description
PlayerLeavingModEvent(@NotNull IColony colony, net.minecraft.world.entity.player.Player player)	Constructs a colony-based event.

Method Summary

Modifier and Type	Method	Description
void	allowForSpectators()	Disable the anti spectator check, allowing you to add custom logic under which to disable the notifications.
void	disableNotification()	Disable sending out the notifications.
net.minecraft.world.entity.player.Player	getPlayer()	Get the player that is leaving the colony.
boolean	shouldShowNotification()	Whether we should show the notification for the player leaving.

Methods inherited from class com.minecolonies.api.eventbus.events.colony.AbstractColonyModEvent

getColony

Methods inherited from class com.minecolonies.api.eventbus.events.AbstractModEvent

getEventId

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerLeavingModEvent

public PlayerLeavingModEvent(@NotNull
 @NotNull IColony colony,
 net.minecraft.world.entity.player.Player player)

Constructs a colony-based event.

Parameters:

colony - the colony related to the event.

player - the player that is leaving the colony.

Method Details

getPlayer

public net.minecraft.world.entity.player.Player getPlayer()

Get the player that is leaving the colony.

shouldShowNotification

public boolean shouldShowNotification()

Whether we should show the notification for the player leaving.

Returns:

true if so.

disableNotification

public void disableNotification()

Disable sending out the notifications.

allowForSpectators

public void allowForSpectators()

Disable the anti spectator check, allowing you to add custom logic under which to disable the notifications.