Package dev.bouncingelf10.timelesslib.api.time

Class TimeAnchor

java.lang.Object

dev.bouncingelf10.timelesslib.api.time.TimeAnchor

public class TimeAnchor
extends Object

Constructor Summary

Constructors

Constructor	Description
TimeAnchor()	Creates a new TimeAnchor that uses the game time.
TimeAnchor(TimeSource timeSource)	Creates a new TimeAnchor that uses the specified time source.

Method Summary

Modifier and Type	Method	Description
static TimeAnchor	createGameTime()	Creates a new TimeAnchor that uses the game time.
static TimeAnchor	createPaused()	Creates a new TimeAnchor that is paused and uses the game time.
static TimeAnchor	createPaused(TimeSource source)	Creates a new TimeAnchor that is paused and uses the specified time source.
static TimeAnchor	createRealTime()	Creates a new TimeAnchor that uses the real time.
Duration	elapsed()
double	elapsed(DurationUnit unit)	Returns the elapsed time in the specified unit.
double	elapsedMillis()
double	elapsedMinutes()
long	elapsedNanos()
double	elapsedSeconds()
Duration	elapsedSince(Duration snapshot)
long	elapsedTicks()
TimeSource	getTimeSource()
boolean	hasElapsed(long amount, DurationUnit unit)
boolean	hasElapsed(Duration duration)	Returns true if the specified duration has elapsed.
boolean	hasElapsedSeconds(long seconds)
boolean	hasElapsedTicks(long ticks)
boolean	isPaused()
void	pause()	Pauses the anchor. Note: If the anchor is already paused, this method does nothing.
void	pauseOrUnpause()
void	playOrReset()
long	remaining(long amount, DurationUnit unit)
double	remaining(long targetAmount, DurationUnit targetUnit, DurationUnit returnUnit)
Duration	remaining(Duration target)	Returns the remaining time until the specified target.
void	reset()
void	resetAndPause()
void	resume()	Resumes the anchor. Note: If the anchor is not paused, this method does nothing.
Duration	snapshot()	Creates a snapshot of the current time.
String	toString()
String	toString(TimeFormat format)

Methods inherited from class java.lang.Object

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

Constructor Details

TimeAnchor

public TimeAnchor()

Creates a new TimeAnchor that uses the game time.

See Also:

• TimeSources

TimeAnchor

public TimeAnchor(TimeSource timeSource)

Creates a new TimeAnchor that uses the specified time source.

Parameters:

timeSource - Time source to use

See Also:

• TimeSources

Method Details

elapsedNanos

public long elapsedNanos()

elapsed

public Duration elapsed()

elapsed

public double elapsed(DurationUnit unit)

Returns the elapsed time in the specified unit.

elapsedTicks

public long elapsedTicks()

elapsedMillis

public double elapsedMillis()

elapsedSeconds

public double elapsedSeconds()

elapsedMinutes

public double elapsedMinutes()

hasElapsed

public boolean hasElapsed(Duration duration)

Returns true if the specified duration has elapsed.

hasElapsed

public boolean hasElapsed(long amount,
 DurationUnit unit)

hasElapsedTicks

public boolean hasElapsedTicks(long ticks)

hasElapsedSeconds

public boolean hasElapsedSeconds(long seconds)

remaining

public Duration remaining(Duration target)

Returns the remaining time until the specified target.

remaining

public long remaining(long amount,
 DurationUnit unit)

remaining

public double remaining(long targetAmount,
 DurationUnit targetUnit,
 DurationUnit returnUnit)

pause

public void pause()

Pauses the anchor.
Note: If the anchor is already paused, this method does nothing.

resume

public void resume()

Resumes the anchor.
Note: If the anchor is not paused, this method does nothing.

isPaused

public boolean isPaused()

reset

public void reset()

resetAndPause

public void resetAndPause()

playOrReset

public void playOrReset()

pauseOrUnpause

public void pauseOrUnpause()

snapshot

public Duration snapshot()

Creates a snapshot of the current time.

elapsedSince

public Duration elapsedSince(Duration snapshot)

getTimeSource

public TimeSource getTimeSource()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(TimeFormat format)

createGameTime

public static TimeAnchor createGameTime()

Creates a new TimeAnchor that uses the game time.

See Also:

• TimeSources

createRealTime

public static TimeAnchor createRealTime()

Creates a new TimeAnchor that uses the real time.

See Also:

• TimeSources

createPaused

public static TimeAnchor createPaused()

Creates a new TimeAnchor that is paused and uses the game time.

See Also:

• TimeSources

createPaused

public static TimeAnchor createPaused(TimeSource source)

Creates a new TimeAnchor that is paused and uses the specified time source.

See Also:

• TimeSources