Package com.velocitypowered.api.event.player

Class PlayerSettingsChangedEvent

java.lang.Object

com.velocitypowered.api.event.player.PlayerSettingsChangedEvent

public final class PlayerSettingsChangedEvent
extends Object

This event is fired when the client sends new client settings for the player. This event can and typically will be fired multiple times per connection. Velocity will not wait on this event to finish firing.

Constructor Summary

Constructors

Constructor	Description
PlayerSettingsChangedEvent(Player player, PlayerSettings playerSettings)	Constructs a new PlayerSettingsChangedEvent.

Method Summary

Modifier and Type	Method	Description
Player	getPlayer()	Returns the player whose settings changed.
PlayerSettings	getPlayerSettings()	Returns the new client settings sent by the player.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerSettingsChangedEvent

public PlayerSettingsChangedEvent(Player player,
 PlayerSettings playerSettings)

Constructs a new PlayerSettingsChangedEvent.

Parameters:

player - the player who changed settings

playerSettings - the new settings sent by the client

Method Details

getPlayer

public Player getPlayer()

Returns the player whose settings changed.

Returns:

the player

getPlayerSettings

public PlayerSettings getPlayerSettings()

Returns the new client settings sent by the player.

Returns:

the updated player settings

toString

public String toString()

Overrides:

toString in class Object