Interface WhitelistModule

All Superinterfaces:

org.incendo.cloud.execution.CommandExecutionHandler<FPlayer>, ModuleCommand, ModuleLocalization, ModuleSimple

public interface WhitelistModule
extends ModuleCommand

The /whitelist command, which controls who may join.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	WhitelistModule.Action	What was done to the whitelist.

Nested classes/interfaces inherited from interface org.incendo.cloud.execution.CommandExecutionHandler

org.incendo.cloud.execution.CommandExecutionHandler.FutureCommandExecutionHandler<C>

Method Summary

Modifier and Type	Method	Description
@Nullable Moderation	add(@NonNull FPlayer fModerator, @NonNull FPlayer fTarget, long time, @Nullable String reason)
Command.Whitelist	config()	The config section for this command, which also holds its aliases.
boolean	isTurnedOn()	Whether the whitelist is enforced.
boolean	isWhitelisted(FPlayer fPlayer)	Whether a player is on the whitelist.
void	kickOnlinePlayers(@NonNull Moderation moderation)	Disconnects everyone who is no longer whitelisted.
void	kickPlayer(FEntity fModerator, FPlayer fTarget)	Disconnects one player removed from the whitelist.
Localization.Command.Whitelist	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Command.Whitelist	permission()	The permission that gates this module.

Methods inherited from interface org.incendo.cloud.execution.CommandExecutionHandler

executeFuture

Methods inherited from interface ModuleCommand

execute, execute

Methods inherited from interface ModuleLocalization

cooldown, cooldownOrThrow, permissions, sound, soundOrThrow

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable

Method Details

localization

Localization.Command.Whitelist localization(FPlayer fPlayer)

Description copied from interface: ModuleLocalization

The localization section for a player, picked from their chosen language.

Specified by:

localization in interface ModuleLocalization

Parameters:

fPlayer - the player the text is for

Returns:

the localization settings

config

Command.Whitelist config()

Description copied from interface: ModuleCommand

The config section for this command, which also holds its aliases.

Specified by:

config in interface ModuleCommand

Specified by:

config in interface ModuleSimple

Returns:

the command settings

permission

Permission.Command.Whitelist permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

add

@Nullable Moderation add(@NonNull FPlayer fModerator,
 @NonNull FPlayer fTarget,
 long time,
 @Nullable String reason)

isTurnedOn

boolean isTurnedOn()

Whether the whitelist is enforced.

Returns:

true if only whitelisted players may join

isWhitelisted

boolean isWhitelisted(FPlayer fPlayer)

Whether a player is on the whitelist.

Parameters:

fPlayer - the player

Returns:

true if they may join

kickOnlinePlayers

void kickOnlinePlayers(@NonNull Moderation moderation)

Disconnects everyone who is no longer whitelisted.

Parameters:

moderation - the entry that caused the change

kickPlayer

void kickPlayer(FEntity fModerator,
 FPlayer fTarget)

Disconnects one player removed from the whitelist.

Parameters:

fModerator - the moderator

fTarget - the player to remove