com.velocitypowered.api.proxy.player

Interface PlayerSettings

public interface PlayerSettings

Represents the client settings for the player.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlayerSettings.ChatMode
static class	PlayerSettings.MainHand

Method Summary

Modifier and Type	Method and Description
PlayerSettings.ChatMode	getChatMode() Returns the chat setting for the client.
Locale	getLocale() Returns the locale of the Minecraft client.
PlayerSettings.MainHand	getMainHand() Returns the primary hand of the client.
SkinParts	getSkinParts() Returns the parts of player skins the client will show.
byte	getViewDistance() Returns the client's view distance.
boolean	hasChatColors() Returns whether or not the client has chat colors disabled.

Method Detail

getLocale

Locale getLocale()

Returns the locale of the Minecraft client.

Returns:

the client locale

getViewDistance

byte getViewDistance()

Returns the client's view distance. This does not guarantee the client will see this many chunks, since your servers are responsible for sending the chunks.

Returns:

the client view distance

getChatMode

PlayerSettings.ChatMode getChatMode()

Returns the chat setting for the client.

Returns:

the chat setting

hasChatColors

boolean hasChatColors()

Returns whether or not the client has chat colors disabled.

Returns:

whether or not the client has chat colors disabled

getSkinParts

SkinParts getSkinParts()

Returns the parts of player skins the client will show.

Returns:

the skin parts for the client

getMainHand

PlayerSettings.MainHand getMainHand()

Returns the primary hand of the client.

Returns:

the primary hand of the client