Record Class WorldMapTracker.ZoneDiscoveryInfo

java.lang.Object
java.lang.Record
com.hypixel.hytale.server.core.universe.world.WorldMapTracker.ZoneDiscoveryInfo
Record Components:
zoneName - The name of the zone.
regionName - The name of the region.
display - Whether to display the discovery title and play the discovery sound.
discoverySoundEventId - The sound event ID to play when discovering this zone, or null if none.
icon - The icon to display with the event title, or null if none.
major - Whether this zone is considered a major zone for discovery purposes.
duration - The duration to display the event title for, in seconds.
fadeInDuration - The fade-in duration for the event title, in seconds.
fadeOutDuration - The fade-out duration for the event title, in seconds.
Enclosing class:
WorldMapTracker
public static record WorldMapTracker.ZoneDiscoveryInfo(@Nonnull String zoneName, @Nonnull String regionName, boolean display, @Nullable String discoverySoundEventId, @Nullable String icon, boolean major, float duration, float fadeInDuration, float fadeOutDuration) extends Record
Contains zone discovery information passed from the world generator.

  • Constructor Details

    • ZoneDiscoveryInfo

      public ZoneDiscoveryInfo(@Nonnull String zoneName, @Nonnull String regionName, boolean display, @Nullable String discoverySoundEventId, @Nullable String icon, boolean major, float duration, float fadeInDuration, float fadeOutDuration)
      Creates an instance of a ZoneDiscoveryInfo record class.
      Parameters:
      zoneName - the value for the zoneName record component
      regionName - the value for the regionName record component
      display - the value for the display record component
      discoverySoundEventId - the value for the discoverySoundEventId record component
      icon - the value for the icon record component
      major - the value for the major record component
      duration - the value for the duration record component
      fadeInDuration - the value for the fadeInDuration record component
      fadeOutDuration - the value for the fadeOutDuration record component

  • Method Details

    • clone

      @Nonnull public WorldMapTracker.ZoneDiscoveryInfo clone()

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

    • zoneName

      @Nonnull public String zoneName()
      Returns the value of the zoneName record component.
      Returns:
      the value of the zoneName record component

    • regionName

      @Nonnull public String regionName()
      Returns the value of the regionName record component.
      Returns:
      the value of the regionName record component

    • display

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

    • discoverySoundEventId

      @Nullable public String discoverySoundEventId()
      Returns the value of the discoverySoundEventId record component.
      Returns:
      the value of the discoverySoundEventId record component

    • icon

      @Nullable public String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component

    • major

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

    • duration

      public float duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component

    • fadeInDuration

      public float fadeInDuration()
      Returns the value of the fadeInDuration record component.
      Returns:
      the value of the fadeInDuration record component

    • fadeOutDuration

      public float fadeOutDuration()
      Returns the value of the fadeOutDuration record component.
      Returns:
      the value of the fadeOutDuration record component