Interface MuteModule

All Superinterfaces:

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

public interface MuteModule
extends ModuleCommand

The /mute 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
MessageContext	addTag(MessageContext messageContext)	Registers the tag that renders a player's mute in a message.
Command.Mute	config()	The config section for this command, which also holds its aliases.
String	getMuteSuffix(FPlayer fPlayer, FPlayer fReceiver)	The marker appended to a muted player's name.
Localization.Command.Mute	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Command.Mute	permission()	The permission that gates this module.
void	sendForTarget(FEntity fModerator, FPlayer fReceiver, Moderation mute)	Tells the muted player they have been silenced.

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

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

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

addTag

MessageContext addTag(MessageContext messageContext)

Registers the tag that renders a player's mute in a message.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tag added

getMuteSuffix

String getMuteSuffix(FPlayer fPlayer,
 FPlayer fReceiver)

The marker appended to a muted player's name.

Parameters:

fPlayer - the muted player

fReceiver - the reader

Returns:

the suffix, or an empty string if the player is not muted

sendForTarget

void sendForTarget(FEntity fModerator,
 FPlayer fReceiver,
 Moderation mute)

Tells the muted player they have been silenced.

Parameters:

fModerator - the moderator

fReceiver - the muted player

mute - the mute that was issued