Record Class Message.Scoreboard

java.lang.Object
java.lang.Record
net.flectone.pulse.config.Message.Scoreboard
All Implemented Interfaces:
EnableSetting
Enclosing class:
Message
public static record Message.Scoreboard(Boolean enable, Boolean nameVisible, double nameDistance, Boolean hideNameWhenSneaking, String color, Ticker ticker, Message.Scoreboard.Objective objective) extends Record implements EnableSetting
Since:
1.7.1

  • Constructor Details

    • Scoreboard

      public Scoreboard(Boolean enable, Boolean nameVisible, double nameDistance, Boolean hideNameWhenSneaking, String color, Ticker ticker, @JsonPropertyDescription(" https://flectone.net/pulse/docs/message/scoreboard/objective") Message.Scoreboard.Objective objective)
      Creates an instance of a Scoreboard record class.
      Parameters:
      enable - the value for the enable record component
      nameVisible - the value for the nameVisible record component
      nameDistance - the value for the nameDistance record component
      hideNameWhenSneaking - the value for the hideNameWhenSneaking record component
      color - the value for the color record component
      ticker - the value for the ticker record component
      objective - the value for the objective record component

  • Method Details

    • builder

      public static Message.Scoreboard.ScoreboardBuilder builder()

    • toBuilder

      public Message.Scoreboard.ScoreboardBuilder toBuilder()

    • withEnable

      public Message.Scoreboard withEnable(Boolean enable)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withNameVisible

      public Message.Scoreboard withNameVisible(Boolean nameVisible)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withNameDistance

      public Message.Scoreboard withNameDistance(double nameDistance)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withHideNameWhenSneaking

      public Message.Scoreboard withHideNameWhenSneaking(Boolean hideNameWhenSneaking)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withColor

      public Message.Scoreboard withColor(String color)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withTicker

      public Message.Scoreboard withTicker(Ticker ticker)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withObjective

      public Message.Scoreboard withObjective(Message.Scoreboard.Objective objective)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • 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.

    • enable

      public Boolean enable()
      Returns the value of the enable record component.
      Specified by:
      enable in interface EnableSetting
      Returns:
      the value of the enable record component

    • nameVisible

      public Boolean nameVisible()
      Returns the value of the nameVisible record component.
      Returns:
      the value of the nameVisible record component

    • nameDistance

      public double nameDistance()
      Returns the value of the nameDistance record component.
      Returns:
      the value of the nameDistance record component

    • hideNameWhenSneaking

      public Boolean hideNameWhenSneaking()
      Returns the value of the hideNameWhenSneaking record component.
      Returns:
      the value of the hideNameWhenSneaking record component

    • color

      public String color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component

    • ticker

      public Ticker ticker()
      Returns the value of the ticker record component.
      Returns:
      the value of the ticker record component

    • objective

      @JsonPropertyDescription(" https://flectone.net/pulse/docs/message/scoreboard/objective") public Message.Scoreboard.Objective objective()
      Returns the value of the objective record component.
      Returns:
      the value of the objective record component