Class PreLoginEvent.PreLoginComponentResult

  • All Implemented Interfaces:
    ResultedEvent.Result
    Enclosing class:
    PreLoginEvent

    public static final class PreLoginEvent.PreLoginComponentResult
    extends java.lang.Object
    implements ResultedEvent.Result
    Represents an "allowed/allowed with forced online\offline mode/denied" result with a reason allowed for denial.
    • Method Detail

      • 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
      • getReason

        public java.util.Optional<net.kyori.adventure.text.Component> getReason()
      • isOnlineModeAllowed

        public boolean isOnlineModeAllowed()
      • isForceOfflineMode

        public boolean isForceOfflineMode()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • 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​(net.kyori.adventure.text.Component reason)
        Denies the login with the specified reason.
        Parameters:
        reason - the reason for disallowing the connection
        Returns:
        a new result