Package com.velocitypowered.api.event.player.configuration

Record Class PlayerEnterConfigurationEvent

java.lang.Object
java.lang.Record
com.velocitypowered.api.event.player.configuration.PlayerEnterConfigurationEvent
Record Components:
player - The player who is about to enter configuration state.
server - The server that wants to reconfigure the player.
@AwaitingEvent public record PlayerEnterConfigurationEvent(@NotNull Player player, ServerConnection server) extends Record
This event is executed when a player is about to enter the configuration state. It is not called for the initial configuration of a player after login.

Velocity will wait for this event before asking the client to enter configuration state. However due to backend server being unable to keep the connection alive during state changes, Velocity will only wait for a maximum of 5 seconds.

Since:
3.3.0
Since Minecraft:
1.20.2

  • Constructor Details

    • PlayerEnterConfigurationEvent

      public PlayerEnterConfigurationEvent(@NotNull @NotNull Player player, ServerConnection server)
      Creates an instance of a PlayerEnterConfigurationEvent record class.
      Parameters:
      player - the value for the player record component
      server - the value for the server record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • player

      @NotNull public @NotNull Player player()
      Returns the value of the player record component.
      Returns:
      the value of the player record component

    • server

      public ServerConnection server()
      Returns the value of the server record component.
      Returns:
      the value of the server record component