Class RemovedPlayerFromWorldEvent

java.lang.Object
com.hypixel.hytale.server.core.event.events.player.RemovedPlayerFromWorldEvent
All Implemented Interfaces:
IBaseEvent<String>, IEvent<String>
public class RemovedPlayerFromWorldEvent extends Object implements IEvent<String>
An event called right after a player has left a world

  • Constructor Details

    • RemovedPlayerFromWorldEvent

      public RemovedPlayerFromWorldEvent(@Nonnull Holder<EntityStore> holder, @Nonnull World world, @Nullable Message leaveMessage)

  • Method Details

    • getHolder

      @Nonnull public Holder<EntityStore> getHolder()
      Returns:
      the Holder of the player entity

    • getWorld

      @Nonnull public World getWorld()
      Returns:
      the World instance that the player is now ready in

    • shouldBroadcastLeaveMessage

      public boolean shouldBroadcastLeaveMessage()
      Returns:
      true if the player joining should be broadcasted, false otherwise

    • setBroadcastLeaveMessage

      public void setBroadcastLeaveMessage(boolean broadcastLeaveMessage)
      Called to set whether the player leaving should be broadcasted
      Parameters:
      broadcastLeaveMessage - true if it should, false otherwise

    • getLeaveMessage

      @Nullable public Message getLeaveMessage()

    • setLeaveMessage

      public void setLeaveMessage(@Nullable Message leaveMessage)
      Sets the message to be broadcasted when a player leaves the world. If set to null, no message will be broadcasted.
      Parameters:
      leaveMessage - the Message to broadcast when a player leaves the world, or null if no message should be broadcasted

    • toString

      public String toString()
      Overrides:
      toString in class Object