Class CommandSenderWrapper.BukkitWrapper

Method Details

• getName

  public String getName()

  Description copied from interface: CommandSenderWrapper

  Remotes the name of the sender.

  For Bukkit Players: CommandSender.getName()
  For Remote Players: RemotePlayer.getName()
  For Console: Console

  Specified by:

  getName in interface CommandSenderWrapper

  Returns:

  The name of the sender

• getUniqueId

  public UUID getUniqueId()

  Description copied from interface: CommandSenderWrapper

  Remotes the uuid of the sender. May be null if it's not supported for the type.

  For Bukkit Players: Entity.getUniqueId()
  For Remote Players: RemotePlayer.getUniqueId()

  Specified by:

  getUniqueId in interface CommandSenderWrapper

  Returns:

  The uuid of the reference, might be null

• isBukkitPlayer

  public boolean isBukkitPlayer()

  Description copied from interface: CommandSenderWrapper

  Returns whether an online player executed this.

  If this method returns true, you may use CommandSenderWrapper.getBukkitPlayer().

  Specified by:

  isBukkitPlayer in interface CommandSenderWrapper

  Returns:

  Returns true when an actual Player is being referenced.

• isRemotePlayer

  public boolean isRemotePlayer()

  Description copied from interface: CommandSenderWrapper

  Returns whether it's a player on a remote server.

  If this method returns true, you may use CommandSenderWrapper.getRemotePlayer().

  Specified by:

  isRemotePlayer in interface CommandSenderWrapper

  Returns:

  Returns true when an actual RemotePlayer is being referenced.

• isConsole

  public boolean isConsole()

  Description copied from interface: CommandSenderWrapper

  Returns whether it was the console that executed the command.

  Specified by:

  isConsole in interface CommandSenderWrapper

  Returns:

  Returns true when a console is the sender (either remotely and local)

• isPlayer

  public boolean isPlayer()

  Description copied from interface: CommandSenderWrapper

  Returns whether it was a player who executed the command.

  Specified by:

  isPlayer in interface CommandSenderWrapper

  Returns:

  Returns true when a player is the sender (either remotely and local)

• isLocal

  public boolean isLocal()

  Description copied from interface: CommandSenderWrapper

  Returns whether this object is wrapping a sender this is located on this server.

  Specified by:

  isLocal in interface CommandSenderWrapper

  Returns:

  Returns true when the sender is located on this server

• isRemote

  public boolean isRemote()

  Description copied from interface: CommandSenderWrapper

  Returns whether this object is wrapping a sender this is located on another server.

  Specified by:

  isRemote in interface CommandSenderWrapper

  Returns:

  Returns true when the sender is located on another server

• getReference

  public Object getReference()

  Description copied from interface: CommandSenderWrapper

  Returns the object that's being referenced. This may be a CommandSender or a RemotePlayer.

  Specified by:

  getReference in interface CommandSenderWrapper

  Returns:

  The instance that's being wrapped

• getCommandSender

  public CommandSender getCommandSender()

  Description copied from interface: CommandSenderWrapper

  Returns the CommandSender that is being wrapped.

  Returns null when it is not being wrapped.

  Specified by:

  getCommandSender in interface CommandSenderWrapper

  Returns:

  The CommandSender that is being wrapped. May be null

• getBukkitPlayer

  @Nullable public @Nullable Player getBukkitPlayer()

  Description copied from interface: CommandSenderWrapper

  Returns the Player that is being wrapped.

  Returns null when the player is not on this server or when it's not a player.

  Specified by:

  getBukkitPlayer in interface CommandSenderWrapper

  Returns:

  The Player that is being wrapped. May be null

• getRemotePlayer

  @Nullable public @Nullable RemotePlayer getRemotePlayer()

  Description copied from interface: CommandSenderWrapper

  Returns the RemotePlayer that is being wrapped.

  Returns null when the player is not on a remote server.

  Specified by:

  getRemotePlayer in interface CommandSenderWrapper

  Returns:

  The RemotePlayer that is being wrapped. May be null

• sendMessage

  public void sendMessage(String message)

  Description copied from interface: CommandSenderWrapper

  Sends a message to the sender.

  For Bukkit Players: CommandSender.sendMessage(String) ()}
  For Remote Players: RemotePlayer.sendMessage(String...) ()}

  Specified by:

  sendMessage in interface CommandSenderWrapper

  Parameters:

  message - The message that shall be sent

• sendMessage

  public void sendMessage(String... messages)

  Description copied from interface: CommandSenderWrapper

  Sends multiple messages to the sender.

  For Bukkit Players: CommandSender.sendMessage(String[]) ()}
  For Remote Players: RemotePlayer.sendMessage(String...) ()}

  Specified by:

  sendMessage in interface CommandSenderWrapper

  Parameters:

  messages - The messages that shall be sent

• hasPermission

  public boolean hasPermission(String name)

  Description copied from interface: CommandSenderWrapper

  Returns whether the sender has a given permission.

  For Bukkit Players: Permissible.hasPermission(String) ()} (Or when hasOP is true: Always true)
  For Remote Players: Always true

  Specified by:

  hasPermission in interface CommandSenderWrapper

  Parameters:

  name - The permission that shall be checked

• hasPermission

  public boolean hasPermission(Permission perm)

  Description copied from interface: CommandSenderWrapper

  Returns whether the sender has a given permission.

  For Bukkit Players: Permissible.hasPermission(Permission) ()} (Or when hasOP is true: Always true)
  For Remote Players: Always true

  Specified by:

  hasPermission in interface CommandSenderWrapper

  Parameters:

  perm - The permission that shall be checked

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object