com.datasiqn.commandcore.command.source

Interface CommandSource

All Known Implementing Classes:

BlockCommandSource, EntityCommandSource, GenericCommandSource, PlayerCommandSource

public interface CommandSource

Represents the source of a command. Get one using the factory method createSource.

Method Summary

Modifier and Type	Method and Description
default @NotNull org.bukkit.command.BlockCommandSender	getBlock() Gets the block executing command
default @NotNull com.datasiqn.resultapi.Result<org.bukkit.command.BlockCommandSender,String>	getBlockChecked() Same as getBlock(), except checks if the sender is a command block and returns a Result
default @NotNull org.bukkit.entity.Entity	getEntity() Gets the entity executing command
default @NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Entity,String>	getEntityChecked() Same as getEntity(), except checks if the sender is an entity and returns a Result
default @NotNull LocatableCommandSender	getLocatable() Gets the locatable sender executing command
default @NotNull com.datasiqn.resultapi.Result<LocatableCommandSender,String>	getLocatableChecked() Same as getLocatable(), except checks if the sender is locatable and returns a Result
default @NotNull org.bukkit.entity.Player	getPlayer() Gets the player executing command.
default @NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Player,String>	getPlayerChecked() Same as getPlayer(), except checks if the sender is a player and returns a Result
@NotNull org.bukkit.command.CommandSender	getSender() Gets the sender of the command
default boolean	hasPermission(@NotNull org.bukkit.permissions.Permission permission) Gets whether the source of the command has a permission or not
default boolean	hasPermission(@Nullable String permission) Gets whether the source of the command has a permission or not
default void	sendMessage(String... messages) Sends the command source a message

Method Detail

getPlayer

@NotNull
default @NotNull org.bukkit.entity.Player getPlayer()

Gets the player executing command. This can be safely called if the command link requiresPlayer.

Returns:

The player

Throws:

IllegalStateException - If the sender is not a player

getPlayerChecked

@NotNull
default @NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Player,String> getPlayerChecked()

Same as getPlayer(), except checks if the sender is a player and returns a Result

Returns:

A result describing the player. If the command link requiresPlayer, use getPlayer() instead

getEntity

@NotNull
default @NotNull org.bukkit.entity.Entity getEntity()

Gets the entity executing command

Returns:

The entity. This can be safely called if the command link requiresEntity.

Throws:

IllegalStateException - If the sender is not an entity

getEntityChecked

@NotNull
default @NotNull com.datasiqn.resultapi.Result<org.bukkit.entity.Entity,String> getEntityChecked()

Same as getEntity(), except checks if the sender is an entity and returns a Result

Returns:

A result describing the entity. If the command link requiresEntity, use getEntity() instead

getBlock

@NotNull
default @NotNull org.bukkit.command.BlockCommandSender getBlock()

Gets the block executing command

Returns:

The block. This can be safely called if the command link CommandLink.requiresBlock() requiresBlock}.

Throws:

IllegalStateException - If the sender is not a block

getBlockChecked

@NotNull
default @NotNull com.datasiqn.resultapi.Result<org.bukkit.command.BlockCommandSender,String> getBlockChecked()

Same as getBlock(), except checks if the sender is a command block and returns a Result

Returns:

A result describing the command block. If the command link CommandLink.requiresBlock() requiresCommandBlock}, use getBlock() instead

getLocatable

@NotNull
default @NotNull LocatableCommandSender getLocatable()

Gets the locatable sender executing command

Returns:

The locatable sender. This can be safely called if the command link requiresLocatable.

Throws:

IllegalStateException - If the sender is not a locatable sender

getLocatableChecked

@NotNull
default @NotNull com.datasiqn.resultapi.Result<LocatableCommandSender,String> getLocatableChecked()

Same as getLocatable(), except checks if the sender is locatable and returns a Result

Returns:

A result describing the locatable sender. If the command link CommandLink.requiresLocatable() requiresCommandBlock}, use getLocatable() instead

getSender

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

Gets the sender of the command

Returns:

The sender

sendMessage

default void sendMessage(@NotNull
                         String... messages)

Sends the command source a message

Parameters:

messages - The messages to send

hasPermission

default boolean hasPermission(@NotNull
                              @NotNull org.bukkit.permissions.Permission permission)

Gets whether the source of the command has a permission or not

Parameters:

permission - The permission

Returns:

true if the source has permission, false otherwise

hasPermission

default boolean hasPermission(@Nullable
                              @Nullable String permission)

Gets whether the source of the command has a permission or not

Parameters:

permission - The permission

Returns:

true if the source has permission, false otherwise