Interface SpyModule

All Superinterfaces:

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

public interface SpyModule
extends ModuleCommand

The /spy command, which mirrors other players' chat, commands and book or sign edits to a moderator.

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	checkAnvil(@NonNull UUID player, @Nullable String itemName)	Reports an anvil rename to the watching moderators.
void	checkBook(@NonNull UUID player, @Nullable String title, @Nullable List<String> pages)	Reports a book edit to the watching moderators.
void	checkChat(@NonNull UUID player, @Nullable String message, @NonNull List<UUID> receivers)	Reports a chat message to the moderators who did not already receive it.
void	checkChat(@NonNull FPlayer fPlayer, @NonNull String chat, @NonNull String message, @NonNull Set<FPlayer> receivers)	Reports a chat message, naming the chat it was written in.
void	checkCommand(@NonNull UUID player, @Nullable String command)	Reports a command to the watching moderators.
void	checkSign(@NonNull UUID player, @Nullable String[] lines)	Reports a sign edit to the watching moderators.
Command.Spy	config()	The config section for this command, which also holds its aliases.
Predicate<FPlayer>	createFilter(FPlayer fPlayer, Set<FPlayer> receivers)	Which moderators should receive a report.
Localization.Command.Spy	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Command.Spy	permission()	The permission that gates this module.
void	spy(@NonNull FPlayer fPlayer, @NonNull String action, @NonNull String message)	Sends one spy report to every watching moderator.
void	spy(@NonNull FPlayer fPlayer, @NonNull String action, @NonNull String message, @NonNull Set<FPlayer> receivers)	Sends one spy report, skipping moderators who already saw the original.

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

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

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

checkAnvil

void checkAnvil(@NonNull UUID player,
 @Nullable String itemName)

Reports an anvil rename to the watching moderators.

Parameters:

player - who renamed the item

itemName - the new name, may be null

checkSign

void checkSign(@NonNull UUID player,
 @Nullable String[] lines)

Reports a sign edit to the watching moderators.

Parameters:

player - who edited the sign

lines - the lines written, may be null

checkBook

void checkBook(@NonNull UUID player,
 @Nullable String title,
 @Nullable List<String> pages)

Reports a book edit to the watching moderators.

Parameters:

player - who wrote the book

title - the book title, may be null

pages - the pages written, may be null

checkCommand

void checkCommand(@NonNull UUID player,
 @Nullable String command)

Reports a command to the watching moderators.

Parameters:

player - who ran it

command - the command line, may be null

checkChat

void checkChat(@NonNull UUID player,
 @Nullable String message,
 @NonNull List<UUID> receivers)

Reports a chat message to the moderators who did not already receive it.

Parameters:

player - who wrote it

message - the text, may be null

receivers - who already saw it

checkChat

void checkChat(@NonNull FPlayer fPlayer,
 @NonNull String chat,
 @NonNull String message,
 @NonNull Set<FPlayer> receivers)

Reports a chat message, naming the chat it was written in.

Parameters:

fPlayer - who wrote it

chat - the chat name

message - the text

receivers - who already saw it

spy

void spy(@NonNull FPlayer fPlayer,
 @NonNull String action,
 @NonNull String message)

Sends one spy report to every watching moderator.

Parameters:

fPlayer - who was spied on

action - what they did

message - the text they entered

spy

void spy(@NonNull FPlayer fPlayer,
 @NonNull String action,
 @NonNull String message,
 @NonNull Set<FPlayer> receivers)

Sends one spy report, skipping moderators who already saw the original.

Parameters:

fPlayer - who was spied on

action - what they did

message - the text they entered

receivers - who already saw it

createFilter

Predicate<FPlayer> createFilter(FPlayer fPlayer,
 Set<FPlayer> receivers)

Which moderators should receive a report.

Parameters:

fPlayer - who was spied on

receivers - who already saw the original

Returns:

the receiver filter