Package com.velocitypowered.api.event.player

Class GameProfileRequestEvent

java.lang.Object
com.velocitypowered.api.event.player.GameProfileRequestEvent
@AwaitingEvent public final class GameProfileRequestEvent extends Object
This event is fired after the PreLoginEvent in order to set up the game profile for the user. This can be used to configure a custom profile for a user, i.e. skin replacement.

Velocity will wait for this event to finish firing before proceeding with the rest of the login process, but you should try to limit the work done in any event that fires during the login process.

  • Constructor Details

    • GameProfileRequestEvent

      public GameProfileRequestEvent(InboundConnection connection, GameProfile originalProfile, boolean onlineMode)
      Creates a new instance.
      Parameters:
      connection - the connection connecting to the proxy
      originalProfile - the original GameProfile for the user
      onlineMode - whether or not the user connected in online or offline mode

  • Method Details

    • getConnection

      public InboundConnection getConnection()
      Returns the inbound connection from the player attempting to log in.
      Returns:
      the inbound connection

    • getUsername

      public String getUsername()
      Returns the username associated with the original game profile.
      Returns:
      the username

    • getOriginalProfile

      public GameProfile getOriginalProfile()
      Returns the original game profile before any plugin customization.
      Returns:
      the original GameProfile

    • isOnlineMode

      public boolean isOnlineMode()
      Returns whether the player is connecting in online mode.
      Returns:
      true if the connection is in online mode, otherwise false

    • getGameProfile

      public GameProfile getGameProfile()
      Returns the game profile that will be used to initialize the connection with. Should no profile be currently specified, the one generated by the proxy (for offline mode) or retrieved from the Mojang session servers (for online mode) will be returned instead.
      Returns:
      the user's GameProfile

    • setGameProfile

      public void setGameProfile(@Nullable GameProfile gameProfile)
      Sets the game profile to use for this connection.
      Parameters:
      gameProfile - the profile for this connection, null uses the original profile

    • toString

      public String toString()
      Overrides:
      toString in class Object