Package org.geysermc.floodgate.api.player

Interface FloodgatePlayer

@Deprecated(forRemoval=true, since="3.0.0") public interface FloodgatePlayer
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
    <T> T
    addProperty(String key, Object value)
    Deprecated.
    <T> T
    addProperty(PropertyKey key, Object value)
    Deprecated.
    default <T extends FloodgatePlayer>
    T
    as(Class<T> clazz)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Casts the FloodgatePlayer instance to a class that extends FloodgatePlayer.
    UUID
    getCorrectUniqueId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the uuid that the server will use as uuid of that player.
    String
    getCorrectUsername()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the username the server will as username for that player.
    DeviceOs
    getDeviceOs()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the Operating System of the Bedrock client
    InputMode
    getInputMode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the Input Mode of the Bedrock client
    UUID
    getJavaUniqueId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the uuid that will be used as UUID on the server.
    Note that this field is not used when the player is a LinkedPlayer
    String
    getJavaUsername()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the Bedrock username that will be used as username on the server.
    String
    getLanguageCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the language code of the Bedrock client
    LinkedPlayer
    getLinkedPlayer()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the LinkedPlayer object if the player is linked to a Java account.
    <T> T
    getProperty(String key)
    Deprecated.
    <T> T
    getProperty(PropertyKey key)
    Deprecated.
    UiProfile
    getUiProfile()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the User Interface Profile of the Bedrock client
    String
    getUsername()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the real username of the Bedrock client.
    String
    getVersion()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the version of the Bedrock client
    String
    getXuid()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the Xbox Unique Identifier of the Bedrock client
    boolean
    hasProperty(String key)
    Deprecated.
    boolean
    hasProperty(PropertyKey key)
    Deprecated.
    boolean
    isFromProxy()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns if the Floodgate player is connected through a proxy
    boolean
    isLinked()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns true if the player is linked to a Java account
    <T> T
    removeProperty(String key)
    Deprecated.
    <T> T
    removeProperty(PropertyKey key)
    Deprecated.
    default boolean
    sendForm(org.geysermc.cumulus.form.Form form)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default boolean
    sendForm(org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default boolean
    transfer(String address, int port)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Details

    • getJavaUsername

      String getJavaUsername()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the Bedrock username that will be used as username on the server. This includes replace spaces (if enabled), username shortened and prefix appended.
      Note that this field is not used when the player is a LinkedPlayer

    • getJavaUniqueId

      UUID getJavaUniqueId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the uuid that will be used as UUID on the server.
      Note that this field is not used when the player is a LinkedPlayer

    • getCorrectUniqueId

      UUID getCorrectUniqueId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the uuid that the server will use as uuid of that player. Will return getJavaUniqueId() when not linked or LinkedPlayer.getJavaUniqueId() when linked.

    • getCorrectUsername

      String getCorrectUsername()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the username the server will as username for that player. Will return getJavaUsername() when not linked or LinkedPlayer.getJavaUsername() when linked.

    • getVersion

      String getVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the version of the Bedrock client

    • getUsername

      String getUsername()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the real username of the Bedrock client. This username doesn't have a prefix, spaces aren't replaced and the username hasn't been shortened.

    • getXuid

      String getXuid()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the Xbox Unique Identifier of the Bedrock client

    • getDeviceOs

      DeviceOs getDeviceOs()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the Operating System of the Bedrock client

    • getLanguageCode

      String getLanguageCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the language code of the Bedrock client

    • getUiProfile

      UiProfile getUiProfile()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the User Interface Profile of the Bedrock client

    • getInputMode

      InputMode getInputMode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the Input Mode of the Bedrock client

    • isFromProxy

      boolean isFromProxy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns if the Floodgate player is connected through a proxy

    • getLinkedPlayer

      LinkedPlayer getLinkedPlayer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the LinkedPlayer object if the player is linked to a Java account.

    • isLinked

      boolean isLinked()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if the player is linked to a Java account

    • sendForm

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

    • sendForm

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

    • transfer

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

    • hasProperty

      @Deprecated boolean hasProperty(PropertyKey key)
      Deprecated.

    • hasProperty

      @Deprecated boolean hasProperty(String key)
      Deprecated.

    • getProperty

      @Deprecated <T> T getProperty(PropertyKey key)
      Deprecated.

    • getProperty

      @Deprecated <T> T getProperty(String key)
      Deprecated.

    • removeProperty

      @Deprecated <T> T removeProperty(PropertyKey key)
      Deprecated.

    • removeProperty

      @Deprecated <T> T removeProperty(String key)
      Deprecated.

    • addProperty

      @Deprecated <T> T addProperty(PropertyKey key, Object value)
      Deprecated.

    • addProperty

      @Deprecated <T> T addProperty(String key, Object value)
      Deprecated.

    • as

      default <T extends FloodgatePlayer> T as(Class<T> clazz)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Casts the FloodgatePlayer instance to a class that extends FloodgatePlayer.
      Type Parameters:
      T - The instance to cast to.
      Returns:
      The FloodgatePlayer casted to the given class
      Throws:
      ClassCastException - when it can't cast the instance to the given class