revxrsal.commands.command

Interface CommandActor

public interface CommandActor

Represents a command sender, responsible for performing a command-related action.

Method Summary

Modifier and Type	Method and Description
default void	error(@NotNull java.lang.String message) Replies to the sender with the specified message, and marks it as an error depending on the platform.
Lamp<?>	lamp() Returns the Lamp instance that constructed this actor.
@NotNull java.lang.String	name() Returns the name of this actor.
default void	reply(@NotNull java.lang.String message) Replies to the sender with the specified message.
void	sendRawError(@NotNull java.lang.String message) Sends an error message to the sender.
void	sendRawMessage(@NotNull java.lang.String message) Sends a message to the sender.
@NotNull java.util.UUID	uniqueId() Returns the unique UID of this subject.

Method Detail

name

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

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

Returns:

The actor name

uniqueId

@NotNull
@NotNull java.util.UUID uniqueId()

Returns the unique UID of this subject. Varies depending on the platform.

Although some platforms explicitly have their underlying senders have UUIDs, some platforms may have to generate this UUID based on other available data.

Returns:

The UUID of this subject.

reply

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

Replies to the sender with the specified message.

If the Lamp instance provides a custom Lamp.messageSender(), it will be used, otherwise this will fall back to the normal sender.

Varies depending on the platform.

Parameters:

message - Message to reply with.

sendRawMessage

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

Sends a message to the sender. This implementation is specific to the platform.

Parameters:

message - Message to send

error

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

Replies to the sender with the specified message, and marks it as an error depending on the platform.

If the Lamp instance provides a custom Lamp.errorSender(), it will be used, otherwise this will fall back to the normal sender.

Note that, in certain platforms where no "error" mode is available, this may effectively be equivalent to calling reply(String).

This method should not throw any exceptions.

Parameters:

message - Message to reply with

sendRawError

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

Sends an error message to the sender. This implementation is specific to the platform.

Parameters:

message - Error message to send

lamp

Lamp<?> lamp()

Returns the Lamp instance that constructed this actor.

Returns:

The lamp instance