Package org.bukkit.event.server

Class ServerListPingEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.server.ServerEvent
org.bukkit.event.server.ServerListPingEvent
All Implemented Interfaces:
java.lang.Iterable<Player>
public class ServerListPingEvent
extends ServerEvent
implements java.lang.Iterable<Player>
Called when a server list ping is coming in. Displayed players can be checked and removed by iterating over this event.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    Event.Result

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected ServerListPingEvent​(java.net.InetAddress address, java.lang.String motd, int maxPlayers)
    This constructor is intended for implementations that provide the iterator() method, thus provided the getNumPlayers() count.
      ServerListPingEvent​(java.net.InetAddress address, java.lang.String motd, int numPlayers, int maxPlayers)  

  • Method Summary

    Modifier and Type Method Description
    java.net.InetAddress getAddress()
    Get the address the ping is coming from.
    static HandlerList getHandlerList()  
    HandlerList getHandlers()  
    int getMaxPlayers()
    Get the maximum number of players sent.
    java.lang.String getMotd()
    Get the message of the day message.
    int getNumPlayers()
    Get the number of players sent.
    java.util.Iterator<Player> iterator()
    void setMaxPlayers​(int maxPlayers)
    Set the maximum number of players sent.
    void setMotd​(java.lang.String motd)
    Change the message of the day message.
    void setServerIcon​(CachedServerIcon icon)
    Sets the server-icon sent to the client.

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Constructor Details

    • ServerListPingEvent

      public ServerListPingEvent​(java.net.InetAddress address, java.lang.String motd, int numPlayers, int maxPlayers)

    • ServerListPingEvent

      protected ServerListPingEvent​(java.net.InetAddress address, java.lang.String motd, int maxPlayers)
      This constructor is intended for implementations that provide the iterator() method, thus provided the getNumPlayers() count.
      Parameters:
      address - the address of the pinger
      motd - the message of the day
      maxPlayers - the max number of players

  • Method Details

    • getAddress

      public java.net.InetAddress getAddress()
      Get the address the ping is coming from.
      Returns:
      the address

    • getMotd

      public java.lang.String getMotd()
      Get the message of the day message.
      Returns:
      the message of the day

    • setMotd

      public void setMotd​(java.lang.String motd)
      Change the message of the day message.
      Parameters:
      motd - the message of the day

    • getNumPlayers

      public int getNumPlayers()
      Get the number of players sent.
      Returns:
      the number of players

    • getMaxPlayers

      public int getMaxPlayers()
      Get the maximum number of players sent.
      Returns:
      the maximum number of players

    • setMaxPlayers

      public void setMaxPlayers​(int maxPlayers)
      Set the maximum number of players sent.
      Parameters:
      maxPlayers - the maximum number of player

    • setServerIcon

      public void setServerIcon​(CachedServerIcon icon) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
      Sets the server-icon sent to the client.
      Parameters:
      icon - the icon to send to the client
      Throws:
      java.lang.IllegalArgumentException - if the CachedServerIcon is not created by the caller of this event; null may be accepted for some implementations
      java.lang.UnsupportedOperationException - if the caller of this event does not support setting the server icon

    • getHandlers

      public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      public static HandlerList getHandlerList()

    • iterator

      public java.util.Iterator<Player> iterator() throws java.lang.UnsupportedOperationException

      Calling the Iterator.remove() method will force that particular player to not be displayed on the player list, decrease the size returned by getNumPlayers(), and will not be returned again by any new iterator.

      Specified by:
      iterator in interface java.lang.Iterable<Player>
      Throws:
      java.lang.UnsupportedOperationException - if the caller of this event does not support removing players