Interface RockpaperscissorsModule

All Superinterfaces:

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

public interface RockpaperscissorsModule
extends ModuleCommand

The /rockpaperscissors command, which plays a round against another player.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RockpaperscissorsModule.GamePhase	How far a round has got.

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.Rockpaperscissors	config()	The config section for this command, which also holds its aliases.
void	create(UUID id, FEntity fPlayer, UUID receiver)	Invites a player to a game.
void	end(UUID id, FPlayer fPlayer, String move, UUID metadataUUID)	Closes a game and announces the result.
void	finalMove(FPlayer fPlayer, FPlayer fReceiver, String move, UUID uuid)	Records the second player's move and announces the winner.
Localization.Command.Rockpaperscissors	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
void	move(UUID id, FEntity fPlayer, String move, UUID metadataUUID)	Records a move.
Permission.Command.Rockpaperscissors	permission()	The permission that gates this module.
void	removeGame(UUID uuid)	Removes an active game session by the UUID of either the sender or the receiver

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

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

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

finalMove

void finalMove(FPlayer fPlayer,
 FPlayer fReceiver,
 String move,
 UUID uuid)

Records the second player's move and announces the winner.

Parameters:

fPlayer - the player moving

fReceiver - the opponent

move - the chosen shape

uuid - the game id

end

void end(UUID id,
 FPlayer fPlayer,
 String move,
 UUID metadataUUID)

Closes a game and announces the result.

Parameters:

id - the game id

fPlayer - the player who moved last

move - their shape

metadataUUID - the shared message id

move

void move(UUID id,
 FEntity fPlayer,
 String move,
 UUID metadataUUID)

Records a move.

Parameters:

id - the game id

fPlayer - the player moving

move - the chosen shape

metadataUUID - the shared message id

create

void create(UUID id,
 FEntity fPlayer,
 UUID receiver)

Invites a player to a game.

Parameters:

id - the game id

fPlayer - who sent the invitation

receiver - who was invited

removeGame

void removeGame(UUID uuid)

Removes an active game session by the UUID of either the sender or the receiver

Parameters:

uuid - the UUID of the sender or the receiver whose game should be removed