Interface PlayerCommonConnection

All Superinterfaces:
PlayerConnection, PluginMessageRecipient, ReadablePlayerCookieConnection, WritablePlayerCookieConnection
All Known Subinterfaces:
PlayerConfigurationConnection, PlayerGameConnection
public interface PlayerCommonConnection extends WritablePlayerCookieConnection, ReadablePlayerCookieConnection, PluginMessageRecipient
Represents a connection that has properties shared between the GAME and CONFIG stage.

  • Method Details

    • sendReportDetails

      void sendReportDetails(Map<String,String> details)
      Sends data to appear in this connection's report logs. This is useful for debugging server state that may be causing player disconnects.

      These are formatted as key - value, where keys are limited to a length of 128 characters, values are limited to 4096, and 32 maximum entries can be sent.

      Parameters:
      details - report details

    • sendLinks

      void sendLinks(ServerLinks links)
      Sends the given server links to this connection.
      Parameters:
      links - links to send

    • transfer

      void transfer(String host, int port)
      Transfers this connection to another server.
      Parameters:
      host - host
      port - port

    • getClientOption

      <T> T getClientOption(ClientOption<T> type)
      Parameters:
      type - client option
      Returns:
      the client option value of the player

    • getClientBrandName

      @Nullable String getClientBrandName()
      Returns player's client brand name. If the client didn't send this information, the brand name will be null.

      For the Notchian client this name defaults to vanilla. Some modified clients report other names such as neoforge.

      Returns:
      client brand name