Interface OnlineModule

All Superinterfaces:

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

public interface OnlineModule
extends ModuleCommand

The /online command, which reports how long a player has been playing.

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 tags that render play-time figures.
Command.Online	config()	The config section for this command, which also holds its aliases.
int	getTime(FPlayer fPlayer, TimeType type)	One play-time figure for a player.
@NonNull String	getTimeFormatted(FPlayer fPlayer, FPlayer fReceiver, TimeType type)
Localization.Command.Online	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
@NonNull String	parseTimeValue(FPlayer fPlayer, FPlayer fReceiver, String time)
Permission.Command.Online	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.Online 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.Online permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

Localization.Command.Online 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 tags that render play-time figures.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tags added

parseTimeValue

@NonNull String parseTimeValue(FPlayer fPlayer,
 FPlayer fReceiver,
 String time)

getTime

int getTime(FPlayer fPlayer,
 TimeType type)

One play-time figure for a player.

Parameters:

fPlayer - the player

type - which figure

Returns:

the value in milliseconds

getTimeFormatted

@NonNull String getTimeFormatted(FPlayer fPlayer,
 FPlayer fReceiver,
 TimeType type)