Package com.destroystokyo.paper.event.profile

Class ProfileWhitelistVerifyEvent

java.lang.Object

org.bukkit.event.Event

com.destroystokyo.paper.event.profile.ProfileWhitelistVerifyEvent

public class ProfileWhitelistVerifyEvent
extends Event

Fires when the server needs to verify if a player is whitelisted. Plugins may override/control the servers whitelist with this event, and dynamically change the kick message.

Nested Class Summary

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

Event.Result

Constructor Summary

Constructors

Constructor	Description
ProfileWhitelistVerifyEvent(PlayerProfile profile, boolean whitelistEnabled, boolean whitelisted, boolean isOp, java.lang.String kickMessage)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
java.lang.String	getKickMessage()	Gets the currently planned message to send to the user if they are not whitelisted
PlayerProfile	getPlayerProfile()
boolean	isOp()	Returns if the player obtained whitelist status by having op
boolean	isWhitelisted()	Whether the player is whitelisted to play on this server (whitelist may be off is why its true)
boolean	isWhitelistEnabled()	Returns if the server even has whitelist on
void	setKickMessage(java.lang.String kickMessage)
void	setWhitelisted(boolean whitelisted)	Changes the players whitelisted state.

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

ProfileWhitelistVerifyEvent

public ProfileWhitelistVerifyEvent(PlayerProfile profile,
                                   boolean whitelistEnabled,
                                   boolean whitelisted,
                                   boolean isOp,
                                   java.lang.String kickMessage)

Method Detail

getKickMessage

public java.lang.String getKickMessage()

Gets the currently planned message to send to the user if they are not whitelisted

setKickMessage

public void setKickMessage(java.lang.String kickMessage)

Parameters:

kickMessage - The message to send to the player on kick if not whitelisted. May set to null to use the server configured default

getPlayerProfile

public PlayerProfile getPlayerProfile()

Returns:

The profile of the player trying to connect

isWhitelisted

public boolean isWhitelisted()

Whether the player is whitelisted to play on this server (whitelist may be off is why its true)

setWhitelisted

public void setWhitelisted(boolean whitelisted)

Changes the players whitelisted state. false will deny the login

isOp

public boolean isOp()

Returns if the player obtained whitelist status by having op

isWhitelistEnabled

public boolean isWhitelistEnabled()

Returns if the server even has whitelist on

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()