org.spongepowered.api.event.entity.living.humanoid.player

Interface PlayerChangeClientSettingsEvent

All Superinterfaces:

Event, TargetEntityEvent, TargetHumanoidEvent, TargetLivingEvent, TargetPlayerEvent

public interface PlayerChangeClientSettingsEvent
extends TargetPlayerEvent

Fired when a Player changes one or more of the following settings.

• Locale
• View distance
• Chat visibility
• Chat colors
• Displayed skin parts

The event is fired before the player object is updated so it is possible to inspect the old settings.

Method Summary

Modifier and Type	Method and Description
ChatVisibility	getChatVisibility() Gets the new chat visibility setting of the player.
Set<SkinPart>	getDisplayedSkinParts() Gets the new skin part's displayed.
Locale	getLocale() Gets the new locale of the player.
int	getViewDistance() Gets the new view distance of the player.
boolean	isChatColorsEnabled() Gets the new value for whether the player has colors enabled in chat.

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

getTargetEntity

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getLocale

Locale getLocale()

Gets the new locale of the player.

Returns:

The locale

getViewDistance

int getViewDistance()

Gets the new view distance of the player. This value represents the radius in unit chunks.

Returns:

The view distance

getChatVisibility

ChatVisibility getChatVisibility()

Gets the new chat visibility setting of the player.

Returns:

The chat visibility setting

isChatColorsEnabled

boolean isChatColorsEnabled()

Gets the new value for whether the player has colors enabled in chat.

Returns:

True if colors are enabled in chat

getDisplayedSkinParts

Set<SkinPart> getDisplayedSkinParts()

Gets the new skin part's displayed.

Returns:

The displayed skin parts