Command

interface Command

Represents a command within Housing.

Provides accessors and mutators for all command settings, and its associated action container.

Implementations perform sequential behavior and therefore expose suspend functions for better interaction with Housing.

Types

The mode in which a command is executed: either on the sender itself or on a target provided via command argument.

abstract var name: String

The unique name of this command, omitting the slash.

abstract suspend fun delete()

Deletes this command.

Returns the action container associated with this command.

Gets the targeting mode that this command runs with.

abstract suspend fun getListed(): Boolean

Fetches whether the command will be listed in command listings/tab complete.

open suspend fun getName(): String

Gets the current name of this command.

Retrieves the group priority required to execute this command.

abstract suspend fun setCommandMode(newCommandMode: Command.CommandMode): Command

Sets the targeting mode that this command will run with.

abstract suspend fun setListed(newListed: Boolean): Command

Controls whether this command appears in command listings/tab complete.

abstract suspend fun setName(newName: String): Command

Sets the name of this command.

abstract suspend fun setRequiredGroupPriority(newPriority: Int): Command

Sets the minimum group priority required to execute this command.