Package net.luckperms.api.event.player.lookup

Interface UsernameValidityCheckEvent

All Superinterfaces:

LuckPermsEvent

public interface UsernameValidityCheckEvent
extends LuckPermsEvent

Called when the validity of a username is being tested.

Since:

5.3

Method Summary

Modifier and Type	Method	Description
@NonNull String	getUsername()	Gets the username being tested.
default boolean	isValid()	Gets if the username is currently considered to be valid.
default void	setValid(boolean valid)	Sets if the username should be considered valid or not.
@NonNull AtomicBoolean	validityState()	Gets the current validity state for the username.

Methods inherited from interface net.luckperms.api.event.LuckPermsEvent

getEventType, getLuckPerms

Method Details

getUsername

@NonNull String getUsername()

Gets the username being tested.

Returns:

the username

validityState

@NonNull AtomicBoolean validityState()

Gets the current validity state for the username.

Returns:

the validity state

isValid

default boolean isValid()

Gets if the username is currently considered to be valid.

Returns:

if the username is valid

setValid

default void setValid(boolean valid)

Sets if the username should be considered valid or not.

Parameters:

valid - whether the username is valid