Package gg.xp.xivsupport.timelines

Class CustomTimelineEntry

java.lang.Object

gg.xp.xivsupport.timelines.CustomTimelineEntry

All Implemented Interfaces:

CustomTimelineItem, TimelineEntry, Serializable, Comparable<TimelineEntry>

public class CustomTimelineEntry
extends Object
implements CustomTimelineItem, Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
boolean	callout
double	calloutPreTime
@Nullable Double	duration
boolean	enabled
CombatJobSelection	enabledJobs
@Nullable CustomEventSyncController	esc
boolean	forceJump
@Nullable TimelineIcon	iconSpec
@Nullable String	importSource
@Nullable Double	jump
@Nullable String	jumpLabel
@Nullable String	name
@Nullable Pattern	sync
double	time
@Nullable Double	windowEnd
@Nullable Double	windowStart

Constructor Summary

Constructors

Constructor	Description
CustomTimelineEntry()
CustomTimelineEntry(double time, @Nullable String name, @Nullable String sync, @Nullable CustomEventSyncController esc, @Nullable Double duration, @NotNull TimelineWindow timelineWindow, @Nullable Double jump, @Nullable String jumpLabel, @Nullable Boolean forceJump, @Nullable URL legacyIcon, @Nullable TimelineIcon newIcon, @Nullable TimelineReference replaces, boolean disabled, String importSource, boolean callout, double calloutPreTime, @Nullable CombatJobSelection jobs)
CustomTimelineEntry(double time, @Nullable String name, @Nullable String sync, @Nullable CustomEventSyncController esc, @Nullable Double duration, @NotNull TimelineWindow timelineWindow, @Nullable Double jump, @Nullable String jumpLabel, @Nullable Boolean forceJump, @Nullable URL legacyIcon, @Nullable TimelineReference replaces, boolean disabled, String importSource, boolean callout, double calloutPreTime, @Nullable CombatJobSelection jobs)	Deprecated.
CustomTimelineEntry(double time, @Nullable String name, @Nullable Pattern sync, @Nullable CustomEventSyncController esc, @Nullable Double duration, @NotNull TimelineWindow timelineWindow, @Nullable Double jump, @Nullable String jumpLabel, @Nullable Boolean forceJump, @Nullable TimelineIcon iconSpec, @Nullable TimelineReference replaces, boolean disabled, boolean callout, double calloutPreTime, @Nullable String importSource)
CustomTimelineEntry(double time, @Nullable String name, @Nullable Pattern sync, @Nullable CustomEventSyncController esc, @Nullable Double duration, @NotNull TimelineWindow timelineWindow, @Nullable Double jump, @Nullable String jumpLabel, @Nullable Boolean forceJump, @Nullable URL legacyIcon, @Nullable TimelineReference replaces, boolean disabled, boolean callout, double calloutPreTime, @Nullable String importSource)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	callout()
double	calloutPreTime()
static CustomTimelineEntry	cloneFor(TimelineEntry other)
boolean	disabled()
@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	enabledForJob(Job job)	Whether the entry is enabled for a certain job
boolean	equals(Object o)
@Nullable EventSyncController	eventSyncController()
boolean	forceJump()	Affects the behavior of TimelineEntry.jump() and TimelineEntry.jumpLabel().
@Nullable CombatJobSelection	getEnabledJobs()
@Nullable String	getImportSource()
int	hashCode()
@Nullable URL	icon()
@Nullable TimelineIcon	iconSpec()
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 CustomTimelineEntry	overrideFor(TimelineEntry other)
@Nullable TimelineReference	replaces()
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
String	toString()

Methods inherited from class java.lang.Object

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

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

canSync, compareTo, effectiveCalloutTime, eventSyncType, getAllTextEntries, getMaxTime, getMinTime, getSyncToTime, hasEventSync, isImported, makeTriggerJs, makeTriggerTimelineEntries, shouldSupersede, shouldSync, shouldSync, toTextFormat, untranslated

Field Details

time

public double time

name

@Nullable
public @Nullable String name

sync

@Nullable
public @Nullable Pattern sync

esc

@Nullable
public @Nullable CustomEventSyncController esc

duration

@Nullable
public @Nullable Double duration

windowStart

@Nullable
public @Nullable Double windowStart

windowEnd

@Nullable
public @Nullable Double windowEnd

jump

@Nullable
public @Nullable Double jump

jumpLabel

@Nullable
public @Nullable String jumpLabel

importSource

@Nullable
public @Nullable String importSource

forceJump

public boolean forceJump

iconSpec

@Nullable
public @Nullable TimelineIcon iconSpec

enabled

public boolean enabled

callout

public boolean callout

calloutPreTime

public double calloutPreTime

enabledJobs

public CombatJobSelection enabledJobs

Constructor Details

CustomTimelineEntry

public CustomTimelineEntry()

CustomTimelineEntry

@Deprecated
public CustomTimelineEntry(double time,
 @Nullable
 @Nullable String name,
 @Nullable
 @Nullable Pattern sync,
 @Nullable
 @Nullable CustomEventSyncController esc,
 @Nullable
 @Nullable Double duration,
 @NotNull
 @NotNull TimelineWindow timelineWindow,
 @Nullable
 @Nullable Double jump,
 @Nullable
 @Nullable String jumpLabel,
 @Nullable
 @Nullable Boolean forceJump,
 @Nullable
 @Nullable URL legacyIcon,
 @Nullable
 @Nullable TimelineReference replaces,
 boolean disabled,
 boolean callout,
 double calloutPreTime,
 @Nullable
 @Nullable String importSource)

Deprecated.

CustomTimelineEntry

public CustomTimelineEntry(double time,
 @Nullable
 @Nullable String name,
 @Nullable
 @Nullable Pattern sync,
 @Nullable
 @Nullable CustomEventSyncController esc,
 @Nullable
 @Nullable Double duration,
 @NotNull
 @NotNull TimelineWindow timelineWindow,
 @Nullable
 @Nullable Double jump,
 @Nullable
 @Nullable String jumpLabel,
 @Nullable
 @Nullable Boolean forceJump,
 @Nullable
 @Nullable TimelineIcon iconSpec,
 @Nullable
 @Nullable TimelineReference replaces,
 boolean disabled,
 boolean callout,
 double calloutPreTime,
 @Nullable
 @Nullable String importSource)

CustomTimelineEntry

@Deprecated
public CustomTimelineEntry(double time,
 @Nullable
 @Nullable String name,
 @Nullable
 @Nullable String sync,
 @Nullable
 @Nullable CustomEventSyncController esc,
 @Nullable
 @Nullable Double duration,
 @NotNull
 @NotNull TimelineWindow timelineWindow,
 @Nullable
 @Nullable Double jump,
 @Nullable
 @Nullable String jumpLabel,
 @Nullable
 @Nullable Boolean forceJump,
 @Nullable
 @Nullable URL legacyIcon,
 @Nullable
 @Nullable TimelineReference replaces,
 boolean disabled,
 String importSource,
 boolean callout,
 double calloutPreTime,
 @Nullable
 @Nullable CombatJobSelection jobs)

Deprecated.

CustomTimelineEntry

public CustomTimelineEntry(double time,
 @Nullable
 @Nullable String name,
 @Nullable
 @Nullable String sync,
 @Nullable
 @Nullable CustomEventSyncController esc,
 @Nullable
 @Nullable Double duration,
 @NotNull
 @NotNull TimelineWindow timelineWindow,
 @Nullable
 @Nullable Double jump,
 @Nullable
 @Nullable String jumpLabel,
 @Nullable
 @Nullable Boolean forceJump,
 @Nullable
 @Nullable URL legacyIcon,
 @Nullable
 @Nullable TimelineIcon newIcon,
 @Nullable
 @Nullable TimelineReference replaces,
 boolean disabled,
 String importSource,
 boolean callout,
 double calloutPreTime,
 @Nullable
 @Nullable CombatJobSelection jobs)

Method Details

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()

forceJump

public boolean forceJump()

Description copied from interface: TimelineEntry

Affects the behavior of TimelineEntry.jump() and TimelineEntry.jumpLabel(). If true, then the jump will occur unconditionally when the current timeline time hits the time of this entry (i.e. when we are T-0 from hitting this entry). If false, jumps will only occur when this entry is synced to.

Specified by:

forceJump in interface TimelineEntry

Returns:

whether to force jumps even without a sync

See Also:

• TimelineEntry.jump()
• TimelineEntry.jumpLabel()

iconSpec

@Nullable
public @Nullable TimelineIcon iconSpec()

icon

@Nullable
public @Nullable URL icon()

Specified by:

icon in interface TimelineEntry

Returns:

An optional icon to display for the entry on the timeline bar and trigger (if it has one)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

eventSyncController

@Nullable
public @Nullable EventSyncController eventSyncController()

Specified by:

eventSyncController in interface TimelineEntry

toString

public String toString()

Specified by:

toString in interface TimelineEntry

Overrides:

toString in class Object

replaces

@Nullable
public @Nullable TimelineReference replaces()

Specified by:

replaces in interface TimelineEntry

Returns:

If this entry overrides another entry, return a reference to the entry it overrides. Otherwise, return null.

See Also:

• TimelineReference

enabled

public boolean enabled()

Specified by:

enabled in interface TimelineEntry

Returns:

Whether this entry is enabled

disabled

public boolean disabled()

isLabel

public boolean isLabel()

Specified by:

isLabel in interface TimelineEntry

Returns:

true if this entry is a label

overrideFor

public static CustomTimelineEntry overrideFor(TimelineEntry other)

cloneFor

public static CustomTimelineEntry cloneFor(TimelineEntry other)

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

enabledForJob

public boolean enabledForJob(Job job)

Description copied from interface: TimelineEntry

Whether the entry is enabled for a certain job

Specified by:

enabledForJob in interface TimelineEntry

Parameters:

job - The job

Returns:

true if enabled for that job

getEnabledJobs

@Nullable
public @Nullable CombatJobSelection getEnabledJobs()

getImportSource

@Nullable
public @Nullable String getImportSource()

Specified by:

getImportSource in interface TimelineEntry

setImportSource

public void setImportSource(@Nullable
 @Nullable String importSource)

Specified by:

setImportSource in interface CustomTimelineItem