revxrsal.commands.velocity.actor

Interface VelocityCommandActor

All Superinterfaces:

revxrsal.commands.command.CommandActor

public interface VelocityCommandActor
extends revxrsal.commands.command.CommandActor

Represents a Velocity CommandActor that wraps CommandSource

Method Summary

Modifier and Type	Method and Description
default @Nullable com.velocitypowered.api.proxy.Player	asPlayer() Returns this actor as a Player if it is a player, otherwise returns null.
void	error(@NotNull net.kyori.adventure.text.ComponentLike message) Sends the given component to this error.
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<VelocityCommandActor>	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) Sends the given component to this actor.
default @NotNull com.velocitypowered.api.proxy.ConsoleCommandSource	requireConsole() Returns this actor as a ConsoleCommandSource if it is the console, otherwise throws a SenderNotConsoleException.
default @NotNull com.velocitypowered.api.proxy.Player	requirePlayer() Returns this actor as a Player if it is a player, otherwise throws a SenderNotPlayerException.
default void	sendRawError(@NotNull net.kyori.adventure.text.ComponentLike message) Prints the given component to this actor as an error.
default void	sendRawError(@NotNull java.lang.String message) Sends the given message to the actor as an error, with legacy color-coding.
default void	sendRawMessage(@NotNull net.kyori.adventure.text.ComponentLike message) Prints the given component to this actor.
default void	sendRawMessage(@NotNull java.lang.String message) Sends the given message to the actor, with legacy color-coding.
@NotNull com.velocitypowered.api.command.CommandSource	source() Returns the underlying CommandSource of this actor

Methods inherited from interface revxrsal.commands.command.CommandActor

error, reply, uniqueId

Method Detail

source

@NotNull
@NotNull com.velocitypowered.api.command.CommandSource source()

Returns the underlying CommandSource 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 com.velocitypowered.api.proxy.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 com.velocitypowered.api.proxy.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 com.velocitypowered.api.proxy.ConsoleCommandSource requireConsole()
                                                                                     throws SenderNotConsoleException

Returns this actor as a ConsoleCommandSource if it is the console, otherwise throws a SenderNotConsoleException.

Returns:

The actor as a player

Throws:

SenderNotPlayerException - if not a console

SenderNotConsoleException

reply

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

Sends the given component to this actor.

Note that this may be delegated to an underlying MessageSender, as specified in an ActorFactory.

Parameters:

message - The message to send

error

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

Sends the given component to this error.

Note that this may be delegated to an underlying MessageSender, as specified in an ActorFactory.

Parameters:

message - The message to send

sendRawMessage

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

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

Parameters:

message - The message to send

sendRawError

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

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

Parameters:

message - The message to send

sendRawMessage

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

Sends the given message to the actor, with legacy color-coding.

This function does not delegate sending, but invokes Audience.sendMessage(Component) directly

Specified by:

sendRawMessage in interface revxrsal.commands.command.CommandActor

Parameters:

message - Message to send

sendRawError

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

Sends the given message to the actor as an error, with legacy color-coding.

This function does not delegate sending, but invokes Audience.sendMessage(Component) directly

Specified by:

sendRawError in interface revxrsal.commands.command.CommandActor

Parameters:

message - Message to send

lamp

revxrsal.commands.Lamp<VelocityCommandActor> 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