Interface TellModule

All Superinterfaces:

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

public interface TellModule
extends ModuleCommand

The /tell command, which sends a private message.

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
Command.Tell	config()	The config section for this command, which also holds its aliases.
@Nullable String	getReceiverFor(FPlayer fPlayer)
Localization.Command.Tell	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Command.Tell	permission()	The permission that gates this module.
void	removeReceiver(FPlayer fPlayer)	Forgets who a player last wrote to.
void	saveReceiver(UUID player, String receiver)	Remembers who a player last wrote to, so /reply knows where to go.
void	send(FEntity sender, FPlayer target, FPlayer fReceiver, Function<Localization.Command.Tell, String> format, String string, UUID metadataUUID)
void	send(FPlayer fPlayer, String playerName, String message)	Sends a private message.

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

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

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

send

void send(FPlayer fPlayer,
 String playerName,
 String message)

Sends a private message.

Parameters:

fPlayer - the sender

playerName - the addressee

message - the text

send

void send(FEntity sender,
 FPlayer target,
 FPlayer fReceiver,
 Function<Localization.Command.Tell, String> format,
 String string,
 UUID metadataUUID)

saveReceiver

void saveReceiver(UUID player,
 String receiver)

Remembers who a player last wrote to, so /reply knows where to go.

Parameters:

player - the sender

receiver - the addressee

removeReceiver

void removeReceiver(FPlayer fPlayer)

Forgets who a player last wrote to.

Parameters:

fPlayer - the sender

getReceiverFor

@Nullable String getReceiverFor(FPlayer fPlayer)