Package com.velocitypowered.api.proxy.player

Interface PlayerSettings

public interface PlayerSettings
Represents the client settings for the player.

  • Method Details

    • 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

    • isClientListingAllowed

      boolean isClientListingAllowed()
      Returns whether the client explicitly allows listing on the TabList or not in anonymous TabList mode. This feature was introduced in 1.18.
      Returns:
      whether or not the client explicitly allows listing. Always false on older clients.
      Since Minecraft:
      1.18

    • isTextFilteringEnabled

      boolean isTextFilteringEnabled()
      Returns if the client has text filtering enabled.
      Returns:
      if text filtering is enabled

    • getParticleStatus

      PlayerSettings.ParticleStatus getParticleStatus()
      Returns the selected "Particles" option state.
      Returns:
      the particle option