Package gg.xp.xivsupport.timelines

Record Class TextFileLabelEntry

java.lang.Object
java.lang.Record
gg.xp.xivsupport.timelines.TextFileLabelEntry
All Implemented Interfaces:
TimelineEntry, Serializable, Comparable<TimelineEntry>
public record TextFileLabelEntry(double time, String name) extends Record implements TimelineEntry, Serializable
See Also:

  • Constructor Details

    • TextFileLabelEntry

      public TextFileLabelEntry(double time, String name)
      Creates an instance of a TextFileLabelEntry record class.
      Parameters:
      time - the value for the time record component
      name - the value for the name record component

  • Method Details

    • toString

      public 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 interface TimelineEntry
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • sync

      @Nullable public @Nullable Pattern sync()
      Description copied from interface: TimelineEntry
      ACT parsed line regex to sync to
      Specified by:
      sync in interface TimelineEntry
      Returns:
      The sync pattern

    • duration

      @Nullable public @Nullable Double duration()
      Description copied from interface: TimelineEntry
      An optional duration for the bar to be in "active" state as opposed to immediately becoming "in the past" when its time arrives.
      Specified by:
      duration in interface TimelineEntry
      Returns:
      The optional duration

    • timelineWindow

      @NotNull public @NotNull TimelineWindow timelineWindow()
      Description copied from interface: TimelineEntry
      The relative window in which this entry can be synced to
      Specified by:
      timelineWindow in interface TimelineEntry
      Returns:
      The sync window

    • jump

      @Nullable public @Nullable Double jump()
      Description copied from interface: TimelineEntry
      An optional time to jump to. If TimelineEntry.forceJump() is false, this line must have its sync conditions hit (i.e. we are syncing onto this line). If forceJump is true, then the jump will also happen if this timeline entry's time is hit.
      Specified by:
      jump in interface TimelineEntry
      Returns:
      The jump time.
      See Also:

    • jumpLabel

      @Nullable public @Nullable String jumpLabel()
      Description copied from interface: TimelineEntry
      Same as TimelineEntry.jump(), but takes a 'label' to jump to instead of a raw time.
      Specified by:
      jumpLabel in interface TimelineEntry
      Returns:
      The jump label
      See Also:

    • enabled

      public boolean enabled()
      Specified by:
      enabled in interface TimelineEntry
      Returns:
      Whether this entry is enabled

    • callout

      public boolean callout()
      Specified by:
      callout in interface TimelineEntry
      Returns:
      True if this entry is also a timeline trigger.

    • calloutPreTime

      public double calloutPreTime()
      Specified by:
      calloutPreTime in interface TimelineEntry
      Returns:
      The amount of time before this entry's TimelineEntry.time() that the trigger should fire

    • isLabel

      public boolean isLabel()
      Specified by:
      isLabel in interface TimelineEntry
      Returns:
      true if this entry is a label

    • eventSyncController

      @Nullable public @Nullable EventSyncController eventSyncController()
      Specified by:
      eventSyncController in interface TimelineEntry

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

    • time

      public double time()
      Returns the value of the time record component.
      Specified by:
      time in interface TimelineEntry
      Returns:
      the value of the time record component

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface TimelineEntry
      Returns:
      the value of the name record component