Package gg.xp.xivsupport.timelines

Class TimelineProcessor.UpcomingTrigger

java.lang.Object

gg.xp.xivsupport.timelines.TimelineProcessor.UpcomingTrigger

All Implemented Interfaces:

HasOptionalIconURL, HasDuration, TimelineProcessor.UpcomingAction

Enclosing class:

TimelineProcessor

public class TimelineProcessor.UpcomingTrigger
extends Object
implements TimelineProcessor.UpcomingAction, HasDuration, HasOptionalIconURL

Method Summary

Modifier and Type	Method	Description
void	fire()
Duration	getEffectiveTimeSince()	Must be implemented.
TimelineEntry	getEntry()
Duration	getEstimatedRemainingDuration()
Duration	getEstimatedTimeSinceExpiry()
@Nullable HasIconURL	getIconUrl()
Duration	getInitialDuration()
boolean	isPreCall()
double	timeUntil()
double	timeUntilTimelineEntry()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gg.xp.xivsupport.events.actlines.events.HasDuration

getEstimatedElapsedDuration, isIndefinite, remainingDurationPlus, wouldBeExpired

Method Details

isPreCall

public boolean isPreCall()

timeUntil

public double timeUntil()

Specified by:

timeUntil in interface TimelineProcessor.UpcomingAction

timeUntilTimelineEntry

public double timeUntilTimelineEntry()

getEstimatedRemainingDuration

public Duration getEstimatedRemainingDuration()

Specified by:

getEstimatedRemainingDuration in interface HasDuration

Returns:

The elapsed duration. Note that this takes HasDuration.getEffectiveTimeSince() into account, so it will respect fake time sources.

getEstimatedTimeSinceExpiry

public Duration getEstimatedTimeSinceExpiry()

Specified by:

getEstimatedTimeSinceExpiry in interface HasDuration

Returns:

The time between the current time, and when the duration should have expired. If called before expiry time, behavior is undefined.

getInitialDuration

public Duration getInitialDuration()

Specified by:

getInitialDuration in interface HasDuration

Returns:

The initial duration at the time of the event happening.

getEffectiveTimeSince

public Duration getEffectiveTimeSince()

Description copied from interface: HasDuration

Must be implemented.

Specified by:

getEffectiveTimeSince in interface HasDuration

Returns:

The time since this event has occurred.

getEntry

public TimelineEntry getEntry()

getIconUrl

@Nullable
public @Nullable HasIconURL getIconUrl()

Specified by:

getIconUrl in interface HasOptionalIconURL

fire

public void fire()

Specified by:

fire in interface TimelineProcessor.UpcomingAction

toString

public String toString()

Overrides:

toString in class Object