revxrsal.commands.bukkit.actor

Interface BukkitCommandActor

All Superinterfaces:

revxrsal.commands.command.CommandActor

public interface BukkitCommandActor
extends revxrsal.commands.command.CommandActor

Represents a Bukkit CommandActor that wraps CommandSender

Method Summary

Modifier and Type	Method and Description
default @Nullable org.bukkit.entity.Player	asPlayer() Returns this actor as a Player if it is a player, otherwise returns null.
@NotNull java.util.Optional<net.kyori.adventure.audience.Audience>	audience() Returns this actor as an adventure Audience.
default boolean	isConsole() Tests whether is this actor the console or not
default boolean	isPlayer() Tests whether is this actor a player or not
revxrsal.commands.Lamp<BukkitCommandActor>	lamp() Returns the Lamp instance that constructed this actor.
default @NotNull java.lang.String	name() Returns the name of this actor.
void	reply(@NotNull net.kyori.adventure.text.ComponentLike message) Prints the given component to this actor.
default @NotNull org.bukkit.command.ConsoleCommandSender	requireConsole() Returns this actor as a ConsoleCommandSender if it is a player, otherwise throws a SenderNotConsoleException.
default @NotNull org.bukkit.entity.Player	requirePlayer() Returns this actor as a Player if it is a player, otherwise throws a SenderNotPlayerException.
@NotNull org.bukkit.command.CommandSender	sender() Returns the underlying CommandSender of this actor
default void	sendRawError(@NotNull java.lang.String message) Prints the given component to this actor as an error.
default void	sendRawMessage(@NotNull java.lang.String message) Prints the given component to this actor.

Methods inherited from interface revxrsal.commands.command.CommandActor

error, reply, uniqueId

Method Detail

sender

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

Returns the underlying CommandSender of this actor

Returns:

The sender

isPlayer

default boolean isPlayer()

Tests whether is this actor a player or not

Returns:

Is this a player or not

isConsole

default boolean isConsole()

Tests whether is this actor the console or not

Returns:

Is this the console or not

asPlayer

@Nullable
default @Nullable org.bukkit.entity.Player asPlayer()

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

Returns:

The sender as a player, or null.

requirePlayer

@NotNull
default @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
default @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 console

sendRawMessage

default void sendRawMessage(@NotNull
                            @NotNull java.lang.String message)

Prints the given component to this actor. This function does not delegate sending, but invokes CommandSender.sendMessage(String) directly

Specified by:

sendRawMessage in interface revxrsal.commands.command.CommandActor

Parameters:

message - The message to send

sendRawError

default void sendRawError(@NotNull
                          @NotNull java.lang.String message)

Prints the given component to this actor as an error. This function does not delegate sending, but invokes CommandSender.sendMessage(String) directly

Specified by:

sendRawError in interface revxrsal.commands.command.CommandActor

Parameters:

message - The message to send

reply

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

Prints the given component to this actor.

Parameters:

message - The message to send

audience

@NotNull
@NotNull java.util.Optional<net.kyori.adventure.audience.Audience> audience()

Returns this actor as an adventure Audience.

Returns:

The audience

lamp

revxrsal.commands.Lamp<BukkitCommandActor> lamp()

Returns the Lamp instance that constructed this actor.

Specified by:

lamp in interface revxrsal.commands.command.CommandActor

Returns:

The Lamp instance

name

@NotNull
default @NotNull java.lang.String name()

Returns the name of this actor. Varies depending on the platform.

Specified by:

name in interface revxrsal.commands.command.CommandActor

Returns:

The actor name