Package gg.xp.xivsupport.timelines
Class CustomTimelineEntry
java.lang.Object
gg.xp.xivsupport.timelines.CustomTimelineEntry
- All Implemented Interfaces:
CustomTimelineItem
,TimelineEntry
,Serializable
,Comparable<TimelineEntry>
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionCustomTimelineEntry
(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 icon, @Nullable TimelineReference replaces, boolean disabled, String importSource, boolean callout, double calloutPreTime, @Nullable CombatJobSelection jobs) 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 icon, @Nullable TimelineReference replaces, boolean disabled, boolean callout, double calloutPreTime, @Nullable String importSource) -
Method Summary
Modifier and TypeMethodDescriptionboolean
callout()
double
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 jobboolean
@Nullable EventSyncController
boolean
Affects the behavior ofTimelineEntry.jump()
andTimelineEntry.jumpLabel()
.@Nullable CombatJobSelection
@Nullable String
int
hashCode()
icon()
boolean
isLabel()
@Nullable Double
jump()
An optional time to jump to.@Nullable String
Same asTimelineEntry.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 todouble
time()
The time of this timeline entry@NotNull TimelineWindow
The relative window in which this entry can be synced totoString()
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
-
sync
-
esc
-
duration
-
windowStart
-
windowEnd
-
jump
-
jumpLabel
-
importSource
-
forceJump
public boolean forceJump -
icon
-
enabled
public boolean enabled -
callout
public boolean callout -
calloutPreTime
public double calloutPreTime -
enabledJobs
-
-
Constructor Details
-
CustomTimelineEntry
public CustomTimelineEntry() -
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 URL icon, @Nullable @Nullable TimelineReference replaces, boolean disabled, boolean callout, double calloutPreTime, @Nullable @Nullable String importSource) -
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 icon, @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 interfaceTimelineEntry
- Returns:
- The timeline entry's time
-
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 interfaceTimelineEntry
- Returns:
- The name
-
sync
Description copied from interface:TimelineEntry
ACT parsed line regex to sync to- Specified by:
sync
in interfaceTimelineEntry
- Returns:
- The sync pattern
-
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 interfaceTimelineEntry
- Returns:
- The optional duration
-
timelineWindow
Description copied from interface:TimelineEntry
The relative window in which this entry can be synced to- Specified by:
timelineWindow
in interfaceTimelineEntry
- Returns:
- The sync window
-
jump
Description copied from interface:TimelineEntry
An optional time to jump to. IfTimelineEntry.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 interfaceTimelineEntry
- Returns:
- The jump time.
- See Also:
-
jumpLabel
Description copied from interface:TimelineEntry
Same asTimelineEntry.jump()
, but takes a 'label' to jump to instead of a raw time.- Specified by:
jumpLabel
in interfaceTimelineEntry
- Returns:
- The jump label
- See Also:
-
forceJump
public boolean forceJump()Description copied from interface:TimelineEntry
Affects the behavior ofTimelineEntry.jump()
andTimelineEntry.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 interfaceTimelineEntry
- Returns:
- whether to force jumps even without a sync
- See Also:
-
icon
- Specified by:
icon
in interfaceTimelineEntry
- Returns:
- An optional icon to display for the entry on the timeline bar and trigger (if it has one)
-
equals
-
hashCode
public int hashCode() -
eventSyncController
- Specified by:
eventSyncController
in interfaceTimelineEntry
-
toString
- Specified by:
toString
in interfaceTimelineEntry
- Overrides:
toString
in classObject
-
replaces
- Specified by:
replaces
in interfaceTimelineEntry
- Returns:
- If this entry overrides another entry, return a reference to the entry it overrides. Otherwise, return null.
- See Also:
-
enabled
public boolean enabled()- Specified by:
enabled
in interfaceTimelineEntry
- Returns:
- Whether this entry is enabled
-
disabled
public boolean disabled() -
isLabel
public boolean isLabel()- Specified by:
isLabel
in interfaceTimelineEntry
- Returns:
- true if this entry is a label
-
overrideFor
-
cloneFor
-
callout
public boolean callout()- Specified by:
callout
in interfaceTimelineEntry
- Returns:
- True if this entry is also a timeline trigger.
-
calloutPreTime
public double calloutPreTime()- Specified by:
calloutPreTime
in interfaceTimelineEntry
- Returns:
- The amount of time before this entry's
TimelineEntry.time()
that the trigger should fire
-
enabledForJob
Description copied from interface:TimelineEntry
Whether the entry is enabled for a certain job- Specified by:
enabledForJob
in interfaceTimelineEntry
- Parameters:
job
- The job- Returns:
- true if enabled for that job
-
getEnabledJobs
-
getImportSource
- Specified by:
getImportSource
in interfaceTimelineEntry
-
setImportSource
- Specified by:
setImportSource
in interfaceCustomTimelineItem
-