Package org.purpurmc.purpur.event

Class PlayerAFKEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.purpurmc.purpur.event.PlayerAFKEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class PlayerAFKEvent
extends PlayerEvent
implements Cancellable

Nested Class Summary

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

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerAFKEvent(Player player, boolean setAfk, boolean shouldKick, @Nullable String broadcast, boolean async)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getBroadcastMsg()
static HandlerList	getHandlerList()
HandlerList	getHandlers()
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isGoingAfk()	Whether player is going afk or coming back
void	setBroadcastMsg(@Nullable String broadcast)
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setShouldKick(boolean shouldKick)
boolean	shouldKick()

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

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 Details

PlayerAFKEvent

@Internal
public PlayerAFKEvent(Player player,
 boolean setAfk,
 boolean shouldKick,
 @Nullable String broadcast,
 boolean async)

Method Details

isGoingAfk

public boolean isGoingAfk()

Whether player is going afk or coming back

Returns:

True if going afk. False is coming back

shouldKick

public boolean shouldKick()

setShouldKick

public void setShouldKick(boolean shouldKick)

getBroadcastMsg

public @Nullable String getBroadcastMsg()

setBroadcastMsg

public void setBroadcastMsg(@Nullable String broadcast)

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()