api/org.kryptonmc.api.command/Sender

Sender

interface Sender : Audience, Subject

A sender is an interface representing the sender of a command.

Inheritors

Functions

Link copied to clipboard
open fun asPermissionChecker(): PermissionChecker

Converts this subject to its equivalent Adventure permission checker.

Link copied to clipboard
open fun clearTitle()
Link copied to clipboard
open fun deleteMessage(@NotNull signedMessage: @NotNull SignedMessage)
open fun deleteMessage(signature: @NotNull SignedMessage.Signature)
Link copied to clipboard
@NotNull
open fun filterAudience(@NotNull filter: @NotNull Predicate<in Audience>): @NotNull Audience
Link copied to clipboard
open fun forEachAudience(@NotNull action: @NotNull Consumer<in Audience>)
Link copied to clipboard
@NotNull
open operator fun <T : Any> get(@NotNull pointer: @NotNull Pointer<T>): @NotNull Optional<T>
Link copied to clipboard
@Contract(value = "_, null -> _; _, !null -> !null")
@Nullable
open fun <T : Any> getOrDefault(@NotNull pointer: @NotNull Pointer<T>, @Nullable defaultValue: @Nullable T?): @Nullable T?
Link copied to clipboard
open fun <T : Any> getOrDefaultFrom(@NotNull pointer: @NotNull Pointer<T>, @NotNull defaultValue: @NotNull Supplier<out T>): @UnknownNullability T
Link copied to clipboard
abstract fun getPermissionValue(permission: String): TriState

Gets the value for the given permission.

Link copied to clipboard
open fun hasPermission(permission: String): Boolean

Checks if this subject has the given permission.

Link copied to clipboard
open fun hideBossBar(@NotNull bar: @NotNull BossBar)
Link copied to clipboard
open fun openBook(@NotNull book: @NotNull Book)
open fun openBook(book: @NotNull Book.Builder)
Link copied to clipboard
open fun playSound(@NotNull sound: @NotNull Sound)
open fun playSound(@NotNull sound: @NotNull Sound, emitter: @NotNull Sound.Emitter)
open fun playSound(@NotNull sound: @NotNull Sound, x: Double, y: Double, z: Double)
Link copied to clipboard
@NotNull
open fun pointers(): @NotNull Pointers
Link copied to clipboard
open fun resetTitle()
Link copied to clipboard
open fun sendActionBar(@NotNull message: @NotNull Component)
open fun sendActionBar(@NotNull message: @NotNull ComponentLike)
Link copied to clipboard
open fun sendMessage(@NotNull message: @NotNull Component)
open fun sendMessage(@NotNull message: @NotNull ComponentLike)
open fun sendMessage(@NotNull signedMessage: @NotNull SignedMessage, boundChatType: @NotNull ChatType.Bound)
open fun sendMessage(@NotNull source: @NotNull Identified, @NotNull message: @NotNull Component)
open fun sendMessage(@NotNull source: @NotNull Identified, @NotNull message: @NotNull ComponentLike)
open fun sendMessage(@NotNull source: @NotNull Identity, @NotNull message: @NotNull Component)
open fun sendMessage(@NotNull source: @NotNull Identity, @NotNull message: @NotNull ComponentLike)
@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
open fun sendMessage(@NotNull message: @NotNull Component, @NotNull type: @NotNull MessageType)
open fun sendMessage(@NotNull message: @NotNull Component, boundChatType: @NotNull ChatType.Bound)
@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
open fun sendMessage(@NotNull message: @NotNull ComponentLike, @NotNull type: @NotNull MessageType)
open fun sendMessage(@NotNull message: @NotNull ComponentLike, boundChatType: @NotNull ChatType.Bound)
@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
open fun sendMessage(@NotNull source: @NotNull Identified, @NotNull message: @NotNull Component, @NotNull type: @NotNull MessageType)
@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
open fun sendMessage(@NotNull source: @NotNull Identified, @NotNull message: @NotNull ComponentLike, @NotNull type: @NotNull MessageType)
@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
open fun sendMessage(@NotNull source: @NotNull Identity, @NotNull message: @NotNull Component, @NotNull type: @NotNull MessageType)
@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
open fun sendMessage(@NotNull source: @NotNull Identity, @NotNull message: @NotNull ComponentLike, @NotNull type: @NotNull MessageType)
Link copied to clipboard
open fun sendPlayerListFooter(@NotNull footer: @NotNull Component)
open fun sendPlayerListFooter(@NotNull footer: @NotNull ComponentLike)
Link copied to clipboard
open fun sendPlayerListHeader(@NotNull header: @NotNull Component)
open fun sendPlayerListHeader(@NotNull header: @NotNull ComponentLike)
Link copied to clipboard
open fun sendPlayerListHeaderAndFooter(@NotNull header: @NotNull Component, @NotNull footer: @NotNull Component)
open fun sendPlayerListHeaderAndFooter(@NotNull header: @NotNull ComponentLike, @NotNull footer: @NotNull ComponentLike)
Link copied to clipboard
open fun <T : Any> sendTitlePart(@NotNull part: @NotNull TitlePart<T>, @NotNull value: @NotNull T)
Link copied to clipboard
open fun showBossBar(@NotNull bar: @NotNull BossBar)
Link copied to clipboard
open fun showTitle(@NotNull title: @NotNull Title)
Link copied to clipboard
open fun stopSound(@NotNull sound: @NotNull Sound)
open fun stopSound(@NotNull stop: @NotNull SoundStop)

Properties

Link copied to clipboard
abstract val name: String

The name of the sender.

Link copied to clipboard
abstract val server: Server

The server that the sender is on.