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 Summary

Constructors

Constructor	Description
GameProfileRequestEvent(InboundConnection connection, GameProfile originalProfile, boolean onlineMode)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
InboundConnection	getConnection()
GameProfile	getGameProfile()	Returns the game profile that will be used to initialize the connection with.
GameProfile	getOriginalProfile()
String	getUsername()
boolean	isOnlineMode()
void	setGameProfile(@Nullable GameProfile gameProfile)	Sets the game profile to use for this connection.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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 Detail

getConnection

public InboundConnection getConnection()

getUsername

public String getUsername()

getOriginalProfile

public GameProfile getOriginalProfile()

isOnlineMode

public boolean isOnlineMode()

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