Package revxrsal.commands.bukkit

Interface BukkitCommandActor

All Superinterfaces:

CommandActor

All Known Implementing Classes:

BukkitActor

public interface BukkitCommandActor
extends CommandActor

Represents a Bukkit CommandActor that wraps CommandSender

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.audience.Audience	audience()	Returns the Audience of this sender.
@Nullable org.bukkit.entity.Player	getAsPlayer()	Returns this actor as a Player if it is a player, otherwise returns null.
BukkitCommandHandler	getCommandHandler()	Returns the command handler that constructed this actor
@NotNull org.bukkit.command.CommandSender	getSender()	Returns the underlying CommandSender of this actor
boolean	isConsole()	Tests whether is this actor the console or not
boolean	isPlayer()	Tests whether is this actor a player or not
void	reply(@NotNull net.kyori.adventure.text.ComponentLike component)	Sends the given component to this actor.
@NotNull org.bukkit.command.ConsoleCommandSender	requireConsole()	Returns this actor as a ConsoleCommandSender if it is a player, otherwise throws a SenderNotConsoleException.
@NotNull org.bukkit.entity.Player	requirePlayer()	Returns this actor as a Player if it is a player, otherwise throws a SenderNotPlayerException.
static @NotNull BukkitCommandActor	wrap(@NotNull org.bukkit.command.CommandSender sender, @NotNull CommandHandler handler)	Creates a new BukkitCommandActor that wraps the given CommandSender.

Methods inherited from interface revxrsal.commands.command.CommandActor

as, error, errorLocalized, getLocale, getName, getTranslator, getUniqueId, reply, replyLocalized

Method Details

getSender

@NotNull
@NotNull org.bukkit.command.CommandSender getSender()

Returns the underlying CommandSender of this actor

Returns:

The sender

isPlayer

boolean isPlayer()

Tests whether is this actor a player or not

Returns:

Is this a player or not

isConsole

boolean isConsole()

Tests whether is this actor the console or not

Returns:

Is this the console or not

getAsPlayer

@Nullable
@Nullable org.bukkit.entity.Player getAsPlayer()

Returns this actor as a Player if it is a player, otherwise returns null.

Returns:

The sender as a player, or null.

requirePlayer

@NotNull
@NotNull org.bukkit.entity.Player requirePlayer()
                                         throws SenderNotPlayerException

Returns this actor as a Player if it is a player, otherwise throws a SenderNotPlayerException.

Returns:

The actor as a player

Throws:

SenderNotPlayerException - if not a player

requireConsole

@NotNull
@NotNull org.bukkit.command.ConsoleCommandSender requireConsole()
                                                         throws SenderNotConsoleException

Returns this actor as a ConsoleCommandSender if it is a player, otherwise throws a SenderNotConsoleException.

Returns:

The actor as console

Throws:

SenderNotConsoleException - if not a player

audience

@NotNull
@NotNull net.kyori.adventure.audience.Audience audience()

Returns the Audience of this sender.

NOTE: This requires calling BukkitCommandHandler.enableAdventure() or BukkitCommandHandler.enableAdventure(BukkitAudiences).

Returns:

The audience of this sender

Throws:

IllegalStateException - if enableAdventure was not called.

reply

void reply(@NotNull
 @NotNull net.kyori.adventure.text.ComponentLike component)

Sends the given component to this actor.

NOTE: This requires calling BukkitCommandHandler.enableAdventure() or BukkitCommandHandler.enableAdventure(BukkitAudiences).

Parameters:

component - Component to send

Throws:

IllegalStateException - if enableAdventure was not called.

getCommandHandler

BukkitCommandHandler getCommandHandler()

Returns the command handler that constructed this actor

Specified by:

getCommandHandler in interface CommandActor

Returns:

The command handler

wrap

@NotNull
static @NotNull BukkitCommandActor wrap(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull CommandHandler handler)

Creates a new BukkitCommandActor that wraps the given CommandSender.

Parameters:

sender - Command sender to wrap

Returns:

The wrapping BukkitCommandActor.