Interface BanModule

All Superinterfaces:

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

public interface BanModule
extends ModuleCommand

The /ban command.

Nested Class Summary

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
void	ban(FPlayer fPlayer, String target, long time, String reason)	Bans a player and announces it.
Command.Ban	config()	The config section for this command, which also holds its aliases.
void	kick(@NonNull Moderation ban)	Disconnects a player who has just been banned.
Localization.Command.Ban	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Command.Ban	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

config

Command.Ban 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.Ban permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

Localization.Command.Ban 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

ban

void ban(FPlayer fPlayer,
 String target,
 long time,
 String reason)

Bans a player and announces it.

Parameters:

fPlayer - the moderator

target - the player to ban

time - when the ban expires in milliseconds, or -1 for permanent

reason - the stated reason

kick

void kick(@NonNull Moderation ban)

Disconnects a player who has just been banned.

Parameters:

ban - the ban that was issued