Package org.geysermc.floodgate.api.player

Interface FloodgatePlayer

public interface FloodgatePlayer

  • 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)
    Casts the FloodgatePlayer instance to a class that extends FloodgatePlayer.
    UUID
    getCorrectUniqueId()
    Returns the uuid that the server will use as uuid of that player.
    String
    getCorrectUsername()
    Returns the username the server will as username for that player.
    org.geysermc.floodgate.util.DeviceOs
    getDeviceOs()
    Returns the Operating System of the Bedrock client
    org.geysermc.floodgate.util.InputMode
    getInputMode()
    Returns the Input Mode of the Bedrock client
    UUID
    getJavaUniqueId()
    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()
    Returns the Bedrock username that will be used as username on the server.
    String
    getLanguageCode()
    Returns the language code of the Bedrock client
    org.geysermc.floodgate.util.LinkedPlayer
    getLinkedPlayer()
    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.
    org.geysermc.floodgate.util.UiProfile
    getUiProfile()
    Returns the User Interface Profile of the Bedrock client
    String
    getUsername()
    Returns the real username of the Bedrock client.
    String
    getVersion()
    Returns the version of the Bedrock client
    String
    getXuid()
    Returns the Xbox Unique Identifier of the Bedrock client
    boolean
    hasProperty(String key)
    Deprecated.
    boolean
    hasProperty(PropertyKey key)
    Deprecated.
    boolean
    isFromProxy()
    Returns if the Floodgate player is connected through a proxy
    boolean
    isLinked()
    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)
     
    default boolean
    sendForm(org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)
     
    default boolean
    sendForm(org.geysermc.cumulus.Form<?> form)
    Deprecated.
    since Cumulus 1.1 and will be removed when Cumulus 2.0 releases.
    default boolean
    sendForm(org.geysermc.cumulus.util.FormBuilder<?,?> formBuilder)
    Deprecated.
    since Cumulus 1.1 and will be removed when Cumulus 2.0 releases.
    default boolean
    transfer(String address, int port)
     

  • Method Details

    • getJavaUsername

      String getJavaUsername()
      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()
      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()
      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()
      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()
      Returns the version of the Bedrock client

    • getUsername

      String getUsername()
      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()
      Returns the Xbox Unique Identifier of the Bedrock client

    • getDeviceOs

      org.geysermc.floodgate.util.DeviceOs getDeviceOs()
      Returns the Operating System of the Bedrock client

    • getLanguageCode

      String getLanguageCode()
      Returns the language code of the Bedrock client

    • getUiProfile

      org.geysermc.floodgate.util.UiProfile getUiProfile()
      Returns the User Interface Profile of the Bedrock client

    • getInputMode

      org.geysermc.floodgate.util.InputMode getInputMode()
      Returns the Input Mode of the Bedrock client

    • isFromProxy

      boolean isFromProxy()
      Returns if the Floodgate player is connected through a proxy

    • getLinkedPlayer

      org.geysermc.floodgate.util.LinkedPlayer getLinkedPlayer()
      Returns the LinkedPlayer object if the player is linked to a Java account.

    • isLinked

      boolean isLinked()
      Returns true if the player is linked to a Java account

    • sendForm

      default boolean sendForm(org.geysermc.cumulus.form.Form form)

    • sendForm

      default boolean sendForm(org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)

    • sendForm

      @Deprecated default boolean sendForm(org.geysermc.cumulus.Form<?> form)
      Deprecated.
      since Cumulus 1.1 and will be removed when Cumulus 2.0 releases. Please use the new form classes instead.

    • sendForm

      @Deprecated default boolean sendForm(org.geysermc.cumulus.util.FormBuilder<?,?> formBuilder)
      Deprecated.
      since Cumulus 1.1 and will be removed when Cumulus 2.0 releases. Please use the new form classes instead.

    • transfer

      default boolean transfer(String address, int port)

    • 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)
      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