Package com.velocitypowered.api.event.connection

Class PreLoginEvent.PreLoginComponentResult

java.lang.Object
com.velocitypowered.api.event.connection.PreLoginEvent.PreLoginComponentResult
All Implemented Interfaces:
ResultedEvent.Result
Enclosing class:
PreLoginEvent
public static final class PreLoginEvent.PreLoginComponentResult extends Object implements ResultedEvent.Result
Represents an "allowed/allowed with forced online\offline mode/denied" result with a reason allowed for denial.

  • 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

    • getReasonComponent

      public Optional<Component> getReasonComponent()
      Gets the reason component shown to the player if the connection is denied.
      Returns:
      the reason as a Component, or empty if not denied

    • isOnlineModeAllowed

      public boolean isOnlineModeAllowed()
      Checks if this result explicitly forces online mode for the connection.
      Returns:
      true if online mode is forced

    • isForceOfflineMode

      public boolean isForceOfflineMode()
      Checks if this result explicitly forces offline mode for the connection.
      Returns:
      true if offline mode is forced

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • allowed

      public static PreLoginEvent.PreLoginComponentResult allowed()
      Returns a result indicating the connection will be allowed through the proxy.
      Returns:
      the allowed result

    • forceOnlineMode

      public static PreLoginEvent.PreLoginComponentResult forceOnlineMode()
      Returns a result indicating the connection will be allowed through the proxy, but the connection will be forced to use online mode provided that the proxy is in offline mode. This acts similarly to allowed() on an online-mode proxy.
      Returns:
      the result

    • forceOfflineMode

      public static PreLoginEvent.PreLoginComponentResult forceOfflineMode()
      Returns a result indicating the connection will be allowed through the proxy, but the connection will be forced to use offline mode even when the proxy is running in online mode.
      Returns:
      the result

    • denied

      public static PreLoginEvent.PreLoginComponentResult denied(Component reason)
      Denies the login with the specified reason.
      Parameters:
      reason - the reason for disallowing the connection
      Returns:
      a new result