Package gg.xp.xivsupport.timelines

Class CustomTimelineLabel

java.lang.Object

gg.xp.xivsupport.timelines.CustomTimelineLabel

All Implemented Interfaces:

CustomTimelineItem, TimelineEntry, Comparable<TimelineEntry>

public class CustomTimelineLabel
extends Object
implements CustomTimelineItem

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable String	importSource
@Nullable String	name
double	time

Constructor Summary

Constructors

Constructor	Description
CustomTimelineLabel()

Method Summary

Modifier and Type	Method	Description
boolean	callout()
double	calloutPreTime()
static CustomTimelineLabel	cloneFor(TimelineEntry other)
@Nullable Double	duration()	An optional duration for the bar to be in "active" state as opposed to immediately becoming "in the past" when its time arrives.
boolean	enabled()
boolean	equals(Object o)
@Nullable EventSyncController	eventSyncController()
@Nullable String	getImportSource()
int	hashCode()
boolean	isLabel()
@Nullable Double	jump()	An optional time to jump to.
@Nullable String	jumpLabel()	Same as TimelineEntry.jump(), but takes a 'label' to jump to instead of a raw time.
@Nullable String	name()	The name of this timeline entry.
static CustomTimelineLabel	overrideFor(TimelineEntry item)
void	setImportSource(@Nullable String importSource)
@Nullable Pattern	sync()	ACT parsed line regex to sync to
double	time()	The time of this timeline entry
@NotNull TimelineWindow	timelineWindow()	The relative window in which this entry can be synced to

Methods inherited from class java.lang.Object

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

Methods inherited from interface gg.xp.xivsupport.timelines.TimelineEntry

canSync, compareTo, effectiveCalloutTime, enabledForJob, eventSyncType, forceJump, getAllTextEntries, getMaxTime, getMinTime, getSyncToTime, hasEventSync, icon, isImported, makeTriggerJs, makeTriggerTimelineEntries, replaces, shouldSupersede, shouldSync, shouldSync, toString, toTextFormat, untranslated

Field Details

time

public double time

name

@Nullable
public @Nullable String name

importSource

@Nullable
public @Nullable String importSource

Constructor Details

CustomTimelineLabel

public CustomTimelineLabel()

Method Details

overrideFor

public static CustomTimelineLabel overrideFor(TimelineEntry item)

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

time

public double time()

Description copied from interface: TimelineEntry

The time of this timeline entry

Specified by:

time in interface TimelineEntry

Returns:

The timeline entry's time

name

@Nullable
public @Nullable String name()

Description copied from interface: TimelineEntry

The name of this timeline entry.

For most entries, this is the displayed name. For labels, it is the label name. For triggers, it is the text that will be displayed on-screen.

Specified by:

name in interface TimelineEntry

Returns:

The name

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:

• TimelineEntry.forceJump()

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:

• TimelineEntry.forceJump()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

cloneFor

public static CustomTimelineLabel cloneFor(TimelineEntry other)

setImportSource

public void setImportSource(@Nullable
 @Nullable String importSource)

Specified by:

setImportSource in interface CustomTimelineItem

getImportSource

@Nullable
public @Nullable String getImportSource()

Specified by:

getImportSource in interface TimelineEntry