Package org.geysermc.api.connection

Interface Connection

public interface Connection
Represents a player connection.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    bedrockUsername()
    Returns the bedrock name of the connection.
    @NonNull InputMode
    inputMode()
    Returns the Input Mode of the Bedrock client.
    boolean
    isLinked()
    Returns whether the connection is linked.
    @MonotonicNonNull String
    javaUsername()
    Returns the java name of the connection.
    @MonotonicNonNull UUID
    javaUuid()
    Returns the UUID of the connection.
    @NonNull String
    languageCode()
    Returns the language code of the connection.
    @NonNull BedrockPlatform
    platform()
    Returns the platform that the connection is playing on.
    boolean
    sendForm(@NonNull org.geysermc.cumulus.form.Form form)
    Sends a form to the connection and opens it.
    boolean
    sendForm(@NonNull org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)
    Sends a form to the connection and opens it.
    boolean
    transfer(@NonNull String address, @org.checkerframework.common.value.qual.IntRange(from=0L, to=65535L) int port)
    Transfer the connection to a server.
    @NonNull UiProfile
    uiProfile()
    Returns the User Interface Profile of the connection.
    @NonNull String
    version()
    Returns the version of the Bedrock client.
    @NonNull String
    xuid()
    Returns the XUID of the connection.

  • Method Details

    • bedrockUsername

      @NonNull String bedrockUsername()
      Returns the bedrock name of the connection.

    • javaUsername

      @MonotonicNonNull String javaUsername()
      Returns the java name of the connection.

    • javaUuid

      @MonotonicNonNull UUID javaUuid()
      Returns the UUID of the connection.

    • xuid

      @NonNull String xuid()
      Returns the XUID of the connection.

    • version

      @NonNull String version()
      Returns the version of the Bedrock client.

    • platform

      @NonNull BedrockPlatform platform()
      Returns the platform that the connection is playing on.

    • languageCode

      @NonNull String languageCode()
      Returns the language code of the connection.

    • uiProfile

      @NonNull UiProfile uiProfile()
      Returns the User Interface Profile of the connection.

    • inputMode

      @NonNull InputMode inputMode()
      Returns the Input Mode of the Bedrock client.

    • isLinked

      boolean isLinked()
      Returns whether the connection is linked. This will always return false when the auth-type isn't Floodgate.

    • sendForm

      boolean sendForm(@NonNull org.geysermc.cumulus.form.Form form)
      Sends a form to the connection and opens it.
      Parameters:
      form - the form to send
      Returns:
      whether the form was successfully sent

    • sendForm

      boolean sendForm(@NonNull org.geysermc.cumulus.form.util.FormBuilder<?,?,?> formBuilder)
      Sends a form to the connection and opens it.
      Parameters:
      formBuilder - the formBuilder to send
      Returns:
      whether the form was successfully sent

    • transfer

      boolean transfer(@NonNull String address, @org.checkerframework.common.value.qual.IntRange(from=0L, to=65535L) int port)
      Transfer the connection to a server. A Bedrock player can successfully transfer to the same server they are currently playing on.
      Parameters:
      address - the address of the server
      port - the port of the server
      Returns:
      true if the transfer was a success