Package org.geysermc.floodgate.api

Interface FloodgateApi

@Deprecated(forRemoval=true, since="3.0.0") public interface FloodgateApi
Deprecated, for removal: This API element is subject to removal in a future version.
The Floodgate API has been deprecated in favor of the GeyserApi, which is shared between Geyser and Floodgate

  • Method Summary

    Modifier and Type
    Method
    Description
    UUID
    createJavaPlayerId(long xuid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a valid Java player uuid of a xuid
    default FloodgateEventBus
    getEventBus()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CompletableFuture<String>
    getGamertagFor(long xuid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the gamertag of the user that has the given xuid.
    static FloodgateApi
    getInstance()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the Floodgate API instance.
    FloodgatePlayer
    getPlayer(UUID uuid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get info about the given Bedrock player
    int
    getPlayerCount()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the number of Floodgate players who are currently online.
    default PlayerLink
    getPlayerLink()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the instance that manages all the linking.
    String
    getPlayerPrefix()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the character(s) that will be added in front of a Bedrock player's name to prevent username duplicates.
    Collection<FloodgatePlayer>
    getPlayers()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns all the online Floodgate players.
    default CompletableFuture<UUID>
    getUuidFor(String gamertag)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the xuid of the player that has the given gamertag.
    CompletableFuture<Long>
    getXuidFor(String gamertag)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the xuid of the user that has the given gamertag.
    boolean
    isFloodgateId(UUID uuid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if the uuid of the player has the createJavaPlayerId(long) format.
    boolean
    isFloodgatePlayer(UUID uuid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Method to determine if the given online player is a bedrock player
    boolean
    sendForm(UUID uuid, org.geysermc.cumulus.form.Form form)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    sendForm(UUID uuid, org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    transferPlayer(UUID uuid, String address, int port)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Unsafe
    unsafe()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Details

    • getInstance

      static FloodgateApi getInstance()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the Floodgate API instance.

    • getPlayerPrefix

      String getPlayerPrefix()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the character(s) that will be added in front of a Bedrock player's name to prevent username duplicates.

    • getPlayers

      Collection<FloodgatePlayer> getPlayers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns all the online Floodgate players.

    • getPlayerCount

      int getPlayerCount()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the number of Floodgate players who are currently online.

    • isFloodgatePlayer

      boolean isFloodgatePlayer(UUID uuid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Method to determine if the given online player is a bedrock player
      Parameters:
      uuid - The uuid of the online player
      Returns:
      true if the given online player is a Bedrock player

    • getPlayer

      FloodgatePlayer getPlayer(UUID uuid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get info about the given Bedrock player
      Parameters:
      uuid - the uuid of the online Bedrock player
      Returns:
      FloodgatePlayer if the given uuid is a Bedrock player

    • createJavaPlayerId

      UUID createJavaPlayerId(long xuid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a valid Java player uuid of a xuid
      Parameters:
      xuid - the xuid that should be converted
      Returns:
      the created uuid based of the given xuid

    • isFloodgateId

      boolean isFloodgateId(UUID uuid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the uuid of the player has the createJavaPlayerId(long) format. This method can't validate a linked player uuid, since that doesn't equal the format. Use isFloodgatePlayer(UUID) if you want to include linked accounts.
      Parameters:
      uuid - the uuid to check
      Returns:
      true if the given uuid has the correct format.

    • sendForm

      boolean sendForm(UUID uuid, org.geysermc.cumulus.form.Form form)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • sendForm

      boolean sendForm(UUID uuid, org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • transferPlayer

      boolean transferPlayer(UUID uuid, String address, int port)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getXuidFor

      CompletableFuture<Long> getXuidFor(String gamertag)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the xuid of the user that has the given gamertag.
      Parameters:
      gamertag - the gamertag of the player
      Returns:
      the xuid of the player with the given gamertag, or null when there is no player with the given gamertag

    • getUuidFor

      default CompletableFuture<UUID> getUuidFor(String gamertag)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the xuid of the player that has the given gamertag. It does the same thing as getXuidFor(String) except that this method will return the xuid in Floodgate uuid format instead of just a long
      Parameters:
      gamertag - the gamertag of the player
      Returns:
      the xuid of the player with the given gamertag, or null when there is no player with the given gamertag

    • getGamertagFor

      CompletableFuture<String> getGamertagFor(long xuid)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the gamertag of the user that has the given xuid.
      Parameters:
      xuid - the xuid of the player
      Returns:
      the gamertag of the player with the given xuid, or null when there is not player with the given xuid

    • getEventBus

      default FloodgateEventBus getEventBus()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPlayerLink

      default PlayerLink getPlayerLink()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the instance that manages all the linking.

    • unsafe

      Unsafe unsafe()
      Deprecated, for removal: This API element is subject to removal in a future version.