Record Class ProgressSettings

java.lang.Object
java.lang.Record
dev.despical.mazeengine.config.ProgressSettings
public record ProgressSettings(boolean enabled, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay) extends Record
Stores the appearance and visibility settings for operation boss bars.

The enabled flag determines whether player actors see a bar. Color and overlay use Adventure's supported boss-bar enums, while MazeProgress supplies the operation title and percentage as work advances.

Configuration reading checks the accepted value types and resolves enum names without case sensitivity. Missing options preserve the standard bar appearance. These settings control presentation and do not change the world operation's block or time budget.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProgressSettings(boolean enabled, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay)
    Creates an instance of a ProgressSettings record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    net.kyori.adventure.bossbar.BossBar.Color
    color()
    Returns the value of the color record component.
    boolean
    enabled()
    Returns the value of the enabled record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.kyori.adventure.bossbar.BossBar.Overlay
    overlay()
    Returns the value of the overlay record component.
    static ProgressSettings
    read(org.bukkit.configuration.ConfigurationSection config)
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ProgressSettings

      public ProgressSettings(boolean enabled, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay)
      Creates an instance of a ProgressSettings record class.
      Parameters:
      enabled - the value for the enabled record component
      color - the value for the color record component
      overlay - the value for the overlay record component

  • Method Details

    • read

      public static ProgressSettings read(org.bukkit.configuration.ConfigurationSection config)

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

    • enabled

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

    • color

      public net.kyori.adventure.bossbar.BossBar.Color color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component

    • overlay

      public net.kyori.adventure.bossbar.BossBar.Overlay overlay()
      Returns the value of the overlay record component.
      Returns:
      the value of the overlay record component