Record Class ClientSettings

java.lang.Object
java.lang.Record
net.minestom.server.network.player.ClientSettings
public record ClientSettings(Locale locale, byte viewDistance, ChatMessageType chatMessageType, boolean chatColors, byte displayedSkinParts, ClientSettings.MainHand mainHand, boolean enableTextFiltering, boolean allowServerListings, ClientSettings.ParticleSetting particleSetting) extends Record

  • Field Details

  • Constructor Details

    • ClientSettings

      public ClientSettings(Locale locale, byte viewDistance, ChatMessageType chatMessageType, boolean chatColors, byte displayedSkinParts, ClientSettings.MainHand mainHand, boolean enableTextFiltering, boolean allowServerListings, ClientSettings.ParticleSetting particleSetting)
      Creates an instance of a ClientSettings record class.
      Parameters:
      locale - the value for the locale record component
      viewDistance - the value for the viewDistance record component
      chatMessageType - the value for the chatMessageType record component
      chatColors - the value for the chatColors record component
      displayedSkinParts - the value for the displayedSkinParts record component
      mainHand - the value for the mainHand record component
      enableTextFiltering - the value for the enableTextFiltering record component
      allowServerListings - the value for the allowServerListings record component
      particleSetting - the value for the particleSetting record component

  • Method Details

    • effectiveViewDistance

      @Deprecated public int effectiveViewDistance()
      Deprecated.
      Deprecated in favor of Player.effectiveViewDistance()
      Returns:
      The effective view distance, which is the smaller of either the client's view distance settings and the server's max view distance

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • locale

      public Locale locale()
      Returns the value of the locale record component.
      Returns:
      the value of the locale record component

    • viewDistance

      public byte viewDistance()
      Returns the value of the viewDistance record component.
      Returns:
      the value of the viewDistance record component

    • chatMessageType

      public ChatMessageType chatMessageType()
      Returns the value of the chatMessageType record component.
      Returns:
      the value of the chatMessageType record component

    • chatColors

      public boolean chatColors()
      Returns the value of the chatColors record component.
      Returns:
      the value of the chatColors record component

    • displayedSkinParts

      public byte displayedSkinParts()
      Returns the value of the displayedSkinParts record component.
      Returns:
      the value of the displayedSkinParts record component

    • mainHand

      public ClientSettings.MainHand mainHand()
      Returns the value of the mainHand record component.
      Returns:
      the value of the mainHand record component

    • enableTextFiltering

      public boolean enableTextFiltering()
      Returns the value of the enableTextFiltering record component.
      Returns:
      the value of the enableTextFiltering record component

    • allowServerListings

      public boolean allowServerListings()
      Returns the value of the allowServerListings record component.
      Returns:
      the value of the allowServerListings record component

    • particleSetting

      public ClientSettings.ParticleSetting particleSetting()
      Returns the value of the particleSetting record component.
      Returns:
      the value of the particleSetting record component