BungeeCommandActor

All Superinterfaces:: CommandActor

All Known Implementing Classes:: BungeeActor

public interface BungeeCommandActor extends CommandActor

Represents a Bungee CommandActor that wraps CommandSender

Method Summary

Modifier and Type

Method

Description

@Nullable net.md_5.bungee.api.connection.ProxiedPlayer

asPlayer()

Returns this sender as a ProxiedPlayer.

net.md_5.bungee.api.CommandSender

getSender()

The underlying CommandSender for this subject

boolean

isPlayer()

Returns whether is this sender a player or not

@NotNull net.md_5.bungee.api.connection.ProxiedPlayer

requirePlayer()

Requires this sender to be player, otherwise throws SenderNotPlayerException.

static @NotNull BungeeCommandActor

wrap(@NotNull net.md_5.bungee.api.CommandSender sender, @NotNull CommandHandler handler)

Creates a new BungeeCommandActor that wraps the given CommandSender.

Methods inherited from interface revxrsal.commands.command.CommandActor
as, error, errorLocalized, getCommandHandler, getLocale, getName, getTranslator, getUniqueId, reply, replyLocalized

Method Details
- getSender
  
  net.md_5.bungee.api.CommandSender getSender()
  
  The underlying CommandSender for this subject
  
  Returns:
  
  The underlying sender
- isPlayer
  
  boolean isPlayer()
  
  Returns whether is this sender a player or not
  
  Returns:
  
  Whether is that sender a player or not
- asPlayer
  
  @Nullable @Nullable net.md_5.bungee.api.connection.ProxiedPlayer asPlayer()
  
  Returns this sender as a ProxiedPlayer.
  
  Returns:
  
  This sender as a player. Returns null if not a player.
- requirePlayer
  
  @NotNull @NotNull net.md_5.bungee.api.connection.ProxiedPlayer requirePlayer() throws SenderNotPlayerException
  
  Requires this sender to be player, otherwise throws SenderNotPlayerException.
  
  Returns:
  
  The sender as the player
  
  Throws:
  
  SenderNotPlayerException - if the sender is not a player (i.e console)
- wrap
  
  @NotNull static @NotNull BungeeCommandActor wrap(@NotNull @NotNull net.md_5.bungee.api.CommandSender sender, @NotNull @NotNull CommandHandler handler)
  
  Creates a new BungeeCommandActor that wraps the given CommandSender.
  
  Parameters:
  
  sender - Command sender to wrap
  
  Returns:
  
  The wrapping BungeeCommandActor.