Interface ICommandSender

All Superinterfaces:

IMessageable

All Known Subinterfaces:

IPlayer, IServer

All Known Implementing Classes:

SpigotServer, WrappedOfflinePlayer, WrappedPlayer

public interface ICommandSender
extends IMessageable

Represents a command sender. This may be a player or any kind of non-player entity that can issue commands (e.g. the server, a command block, etc.).

Method Summary

Modifier and Type	Method	Description
String	formatCommand(String commandName, String subCommandFormat, @Nullable Object @Nullable ... args)	Formats a command appropriately for this command sender.
Optional<IPlayer>	getPlayer()	Gets the IPlayer that issued the command.
default CompletableFuture<Boolean>	hasPermission(String permission)	Checks if this sender has a given permission.
default CompletableFuture<PermissionsStatus>	hasPermission(CommandDefinition command)	Checks if this sender has a given command.
boolean	isPlayer()	Checks if the command sender is a player.

Methods inherited from interface IMessageable

getPersonalizedLocalizer, getTextFactory, newText, sendError, sendInfo, sendMessage, sendMessage, sendSuccess

Method Details

getPlayer

Optional<IPlayer> getPlayer()

Gets the IPlayer that issued the command.

Returns:

The IPlayer that issued the command, if it was a player that issued the command. Otherwise, an empty Optional is returned.

isPlayer

boolean isPlayer()

Checks if the command sender is a player.

Returns:

True if the command sender is a player.

formatCommand

@FormatMethod
@CheckReturnValue
String formatCommand(String commandName,
 @FormatString
 String subCommandFormat,
 @Nullable Object @Nullable ... args)

Formats a command appropriately for this command sender.

Players receive commands with a leading slash (e.g., "/command"), while non-players (console, command blocks) receive commands without the leading slash (e.g., "command").

Parameters:

commandName - The name of the command (without leading slash).

subCommandFormat - The format string for the subcommand and its arguments.

args - Arguments referenced by the format specifiers in the subcommand format string.

Returns:

The formatted command appropriate for this sender.

hasPermission

default CompletableFuture<Boolean> hasPermission(String permission)

Checks if this sender has a given permission.

Parameters:

permission - The permission node to check.

Returns:

True if the player has access to the provided permission, otherwise false.

hasPermission

default CompletableFuture<PermissionsStatus> hasPermission(CommandDefinition command)

Checks if this sender has a given command.

Both the user permission (See CommandDefinition.getUserPermission()) and the admin permission (See CommandDefinition.getAdminPermission()) are checked.

Parameters:

command - The CommandDefinition of a command to check.

Returns:

A PermissionsStatus that is true if the player has access to the provided permissions, otherwise false for the user and the admin permission nodes respectively.