Interface ServerListing

public interface ServerListing
How the server shows up in the multiplayer server list: the values used to answer status pings.

Changes apply to the next ping. To change a single answer, listen to ServerStatusRequestEvent instead.

Since:
0.1.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Component
    description()
    Gets the server description shown in the status ping.
    void
    description(Component description)
    Sets the server description shown in the status ping.
    Optional<Favicon>
    favicon()
    Gets the server's favicon shown in the status ping.
    void
    favicon(Favicon favicon)
    Sets the server's favicon shown in the status ping.
    int
    maxPlayers()
    Gets the maximum player count shown in the status ping.
    void
    maxPlayers(int maxPlayers)
    Sets the maximum player count shown in the status ping.

  • Method Details

    • favicon

      @Contract(pure=true) Optional<Favicon> favicon()
      Gets the server's favicon shown in the status ping.
      Returns:
      the server favicon
      Since:
      0.1.0

    • favicon

      @Contract(mutates="this") void favicon(Favicon favicon)
      Sets the server's favicon shown in the status ping.
      Parameters:
      favicon - the server favicon
      Since:
      0.1.0

    • description

      @Contract(pure=true) Component description()
      Gets the server description shown in the status ping.
      Returns:
      server description
      Since:
      0.1.0

    • description

      @Contract(mutates="this") void description(Component description)
      Sets the server description shown in the status ping.
      Parameters:
      description - server description
      Since:
      0.1.0

    • maxPlayers

      @Contract(pure=true) int maxPlayers()
      Gets the maximum player count shown in the status ping.
      Returns:
      maximum player count
      Since:
      0.1.0

    • maxPlayers

      @Contract(mutates="this") void maxPlayers(int maxPlayers)
      Sets the maximum player count shown in the status ping.
      Parameters:
      maxPlayers - maximum player count
      Since:
      0.1.0