public interface AuthMeVelocityAPI
API provided to interact with logged players
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addPlayer(@NotNull Player player)
    Adds a player to the list of logged in players
    boolean
    isAuthServer(@NotNull RegisteredServer server)
    Check if a server is intended to be a logging server
    boolean
    isAuthServer(@NotNull ServerConnection connection)
    Checks if a connection is made from a login server
    boolean
    isAuthServer(@NotNull String server)
    Checks if a string is a name of an auth server
    boolean
    isInAuthServer(@NotNull Player player)
    Check if the player is on a login server
    boolean
    isLogged(@NotNull Player player)
    Check if the player is logged in or not
    boolean
    isNotLogged(@NotNull Player player)
    Check if the player is not logged
    boolean
    removePlayer(@NotNull Player player)
    Removes a player from the list of logged-in players
    void
    removePlayerIf(@NotNull Predicate<@NotNull Player> predicate)
    Removes players who meet the established condition
  • Method Details

    • isLogged

      boolean isLogged(@NotNull @NotNull Player player)
      Check if the player is logged in or not
      Parameters:
      player - the player
      Returns:
      if the player is logged in or not
    • isNotLogged

      boolean isNotLogged(@NotNull @NotNull Player player)
      Check if the player is not logged
      Parameters:
      player - the player
      Returns:
      if the player is not logged
    • addPlayer

      boolean addPlayer(@NotNull @NotNull Player player)
      Adds a player to the list of logged in players
      Parameters:
      player - the new logged player
      Returns:
      if the player was successfully added
    • removePlayer

      boolean removePlayer(@NotNull @NotNull Player player)
      Removes a player from the list of logged-in players
      Parameters:
      player - the unlogged player
      Returns:
      if the player was successfully removed
    • removePlayerIf

      void removePlayerIf(@NotNull @NotNull Predicate<@NotNull Player> predicate)
      Removes players who meet the established condition
      Parameters:
      predicate - the condition
    • isInAuthServer

      boolean isInAuthServer(@NotNull @NotNull Player player)
      Check if the player is on a login server
      Parameters:
      player - the player
      Returns:
      if the player is on a login server
    • isAuthServer

      boolean isAuthServer(@NotNull @NotNull RegisteredServer server)
      Check if a server is intended to be a logging server
      Parameters:
      server - the server
      Returns:
      if the server is a login server
    • isAuthServer

      boolean isAuthServer(@NotNull @NotNull ServerConnection connection)
      Checks if a connection is made from a login server
      Parameters:
      connection - the connection
      Returns:
      if the connection is made from a login server
    • isAuthServer

      boolean isAuthServer(@NotNull @NotNull String server)
      Checks if a string is a name of an auth server
      Parameters:
      server - the server name
      Returns:
      if the server is an auth server