Class KickedFromServerEvent.Notify

java.lang.Object
com.velocitypowered.api.event.player.KickedFromServerEvent.Notify
All Implemented Interfaces:
KickedFromServerEvent.ServerKickResult, ResultedEvent.Result
Enclosing class:
KickedFromServerEvent

public static final class KickedFromServerEvent.Notify extends Object implements KickedFromServerEvent.ServerKickResult
Notifies the player with the specified message but does nothing else. This is only a valid result to use if the player was trying to connect to a different server, otherwise it is treated like a KickedFromServerEvent.DisconnectPlayer result.
  • Method Details

    • isAllowed

      public boolean isAllowed()
      Description copied from interface: ResultedEvent.Result
      Returns whether or not the event is allowed to proceed. Plugins may choose to skip denied events, and the proxy will respect the result of this method.
      Specified by:
      isAllowed in interface ResultedEvent.Result
      Returns:
      whether or not the event is allowed to proceed
    • getMessageComponent

      public Component getMessageComponent()
    • create

      public static KickedFromServerEvent.Notify create(Component message)
      Notifies the player with the specified message but does nothing else.
      Parameters:
      message - the server to send the player to
      Returns:
      the redirect result