Package io.papermc.paper.connection

Interface PlayerConfigurationConnection

All Superinterfaces:

PlayerCommonConnection, PlayerConnection, PluginMessageRecipient, ReadablePlayerCookieConnection, WritablePlayerCookieConnection

public interface PlayerConfigurationConnection
extends PlayerCommonConnection

Method Summary

Modifier and Type	Method	Description
void	clearChat()	Clears the players chat history and their local chat.
void	completeReconfiguration()	Completes the configuration for this player, which will cause this player to reenter the game.
net.kyori.adventure.audience.Audience	getAudience()	Returns the audience representing the player in configuration mode.
PlayerProfile	getProfile()	Gets the profile for this connection.

Methods inherited from interface io.papermc.paper.connection.PlayerCommonConnection

getClientOption, sendLinks, sendReportDetails, transfer

Methods inherited from interface io.papermc.paper.connection.PlayerConnection

disconnect, getAddress, getClientAddress, getHAProxyAddress, getVirtualHost, isTransferred

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient

getListeningPluginChannels, sendPluginMessage

Methods inherited from interface io.papermc.paper.connection.ReadablePlayerCookieConnection

retrieveCookie

Methods inherited from interface io.papermc.paper.connection.WritablePlayerCookieConnection

storeCookie

Method Details

getAudience

net.kyori.adventure.audience.Audience getAudience()

Returns the audience representing the player in configuration mode. This can be used to interact with the Adventure API during the configuration stage. This is guaranteed to be an instance of PlayerConfigurationConnection

Returns:

the configuring player audience

getProfile

PlayerProfile getProfile()

Gets the profile for this connection.

Returns:

profile

clearChat

void clearChat()

Clears the players chat history and their local chat.

completeReconfiguration

void completeReconfiguration()

Completes the configuration for this player, which will cause this player to reenter the game.

Note, this should be only be called if you are reconfiguring the player.