Package com.onarandombox.MultiverseCore.utils

Class PlayerFinder

  • public class PlayerFinder
extends java.lang.Object
    Helper class to get Player from name, UUID or Selectors.

    • Constructor Summary

      Constructors 
      Constructor Description
      PlayerFinder()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static @Nullable org.bukkit.entity.Player get​(@NotNull java.lang.String playerIdentifier, @NotNull org.bukkit.command.CommandSender sender)
      Get a Player based on an identifier of name UUID or selector.
      static @Nullable org.bukkit.entity.Player getByName​(@NotNull java.lang.String playerName)
      Get a Player based on player name.
      static @Nullable org.bukkit.entity.Player getBySelector​(@NotNull java.lang.String playerSelector, @NotNull org.bukkit.command.CommandSender sender)
      Get a Player based on vanilla selectors.
      static @Nullable org.bukkit.entity.Player getByUuid​(@NotNull java.lang.String playerUuid)
      Get a Player based on player UUID.
      static @Nullable org.bukkit.entity.Player getByUuid​(@NotNull java.util.UUID playerUuid)
      Get a Player based on playerUUID.
      static @Nullable java.util.List<org.bukkit.entity.Player> getMulti​(@NotNull java.lang.String playerIdentifiers, @NotNull org.bukkit.command.CommandSender sender)
      Get multiple Player based on many identifiers of name UUID or selector.
      static @Nullable java.util.List<org.bukkit.entity.Player> getMultiBySelector​(@NotNull java.lang.String playerSelector, @NotNull org.bukkit.command.CommandSender sender)
      Get multiple Player based on selector.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PlayerFinder

        public PlayerFinder()

    • Method Detail

      • get

        @Nullable
public static @Nullable org.bukkit.entity.Player get​(@NotNull
                                                     @NotNull java.lang.String playerIdentifier,
                                                     @NotNull
                                                     @NotNull org.bukkit.command.CommandSender sender)
        Get a Player based on an identifier of name UUID or selector.
        Parameters:
        playerIdentifier - An identifier of name UUID or selector.
        sender - Target sender for selector.
        Returns:
        The player if found, else null.

      • getMulti

        @Nullable
public static @Nullable java.util.List<org.bukkit.entity.Player> getMulti​(@NotNull
                                                                          @NotNull java.lang.String playerIdentifiers,
                                                                          @NotNull
                                                                          @NotNull org.bukkit.command.CommandSender sender)
        Get multiple Player based on many identifiers of name UUID or selector.
        Parameters:
        playerIdentifiers - An identifier of multiple names, UUIDs or selectors, separated by comma.
        sender - Target sender for selector.
        Returns:
        A list of all the Player found.

      • getByName

        @Nullable
public static @Nullable org.bukkit.entity.Player getByName​(@NotNull
                                                           @NotNull java.lang.String playerName)
        Get a Player based on player name.
        Parameters:
        playerName - Name of a Player.
        Returns:
        The player if found, else null.

      • getByUuid

        @Nullable
public static @Nullable org.bukkit.entity.Player getByUuid​(@NotNull
                                                           @NotNull java.lang.String playerUuid)
        Get a Player based on player UUID.
        Parameters:
        playerUuid - UUID of a player.
        Returns:
        The player if found, else null.

      • getByUuid

        @Nullable
public static @Nullable org.bukkit.entity.Player getByUuid​(@NotNull
                                                           @NotNull java.util.UUID playerUuid)
        Get a Player based on playerUUID.
        Parameters:
        playerUuid - UUID of a player.
        Returns:
        The player if found, else null.

      • getBySelector

        @Nullable
public static @Nullable org.bukkit.entity.Player getBySelector​(@NotNull
                                                               @NotNull java.lang.String playerSelector,
                                                               @NotNull
                                                               @NotNull org.bukkit.command.CommandSender sender)
        Get a Player based on vanilla selectors. https://minecraft.gamepedia.com/Commands#Target_selectors
        Parameters:
        playerSelector - A target selector, usually starts with an '@'.
        sender - Target sender for selector.
        Returns:
        The player if only one found, else null.

      • getMultiBySelector

        @Nullable
public static @Nullable java.util.List<org.bukkit.entity.Player> getMultiBySelector​(@NotNull
                                                                                    @NotNull java.lang.String playerSelector,
                                                                                    @NotNull
                                                                                    @NotNull org.bukkit.command.CommandSender sender)
        Get multiple Player based on selector. https://minecraft.gamepedia.com/Commands#Target_selectors
        Parameters:
        playerSelector - A target selector, usually starts with an '@'.
        sender - Target sender for selector.
        Returns:
        A list of all the Player found.