Package net.md_5.bungee.api.event

Class LoginEvent

java.lang.Object
net.md_5.bungee.api.plugin.Event
net.md_5.bungee.api.event.AsyncEvent<LoginEvent>
net.md_5.bungee.api.event.LoginEvent
All Implemented Interfaces:
Cancellable
public class LoginEvent extends AsyncEvent<LoginEvent> implements Cancellable
Event called to represent a player logging in.

  • Constructor Details

  • Method Details

    • getCancelReason

      @Deprecated public String getCancelReason()
      Deprecated.
      use component methods instead
      Returns:
      reason to be displayed

    • setCancelReason

      @Deprecated public void setCancelReason(String cancelReason)
      Deprecated.
      use component methods instead
      Parameters:
      cancelReason - reason to be displayed

    • getCancelReasonComponents

      @Deprecated public net.md_5.bungee.api.chat.BaseComponent[] getCancelReasonComponents()
      Deprecated.
      use single component methods instead
      Returns:
      reason to be displayed

    • setCancelReason

      @Deprecated public void setCancelReason(net.md_5.bungee.api.chat.BaseComponent... cancelReason)
      Deprecated.
      use single component methods instead
      Parameters:
      cancelReason - reason to be displayed

    • isCancelled

      public boolean isCancelled()
      Cancelled state.
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      the cancelled state of this event

    • getReason

      public net.md_5.bungee.api.chat.BaseComponent getReason()
      Message to use when kicking if this event is canceled.

    • getConnection

      public PendingConnection getConnection()
      Connection attempting to login.

    • setCancelled

      public void setCancelled(boolean cancelled)
      Cancelled state.
      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancelled - the state to set

    • setReason

      public void setReason(net.md_5.bungee.api.chat.BaseComponent reason)
      Message to use when kicking if this event is canceled.

    • toString

      public String toString()
      Overrides:
      toString in class AsyncEvent<LoginEvent>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AsyncEvent<LoginEvent>

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AsyncEvent<LoginEvent>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AsyncEvent<LoginEvent>