com.almasb.fxgl.time

Interface MasterTimer

All Superinterfaces:

FXGLListener, UserProfileSavable

public interface MasterTimer
extends FXGLListener, UserProfileSavable

Represents master timer, all local timers are synchronized with this. Allows to set up interval based tasks.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Type	Property and Description
javafx.beans.property.IntegerProperty	fps
javafx.beans.property.IntegerProperty	performanceFPS
javafx.beans.property.ReadOnlyLongProperty	playtime
javafx.beans.property.ReadOnlyLongProperty	tick

Method Summary

Modifier and Type	Method and Description
void	addUpdateListener(UpdateEventListener listener) Adds update event listener.
javafx.beans.property.IntegerProperty	fpsProperty()
default int	getFPS()
long	getNow() Current time for this tick in nanoseconds.
default int	getPerformanceFPS()
default long	getPlaytime() Gets the value of the property playtime.
default long	getPlaytimeHours()
default long	getPlaytimeMinutes()
default long	getPlaytimeSeconds()
default long	getTick() Returns current tick (frame).
javafx.beans.property.IntegerProperty	performanceFPSProperty()
javafx.beans.property.ReadOnlyLongProperty	playtimeProperty()
void	removeUpdateListener(UpdateEventListener listener) Removes update event listener.
void	reset() Clears all registered timer based actions.
TimerAction	runAtInterval(Runnable action, javafx.util.Duration interval) The Runnable action will be scheduled to run at given interval.
TimerAction	runAtIntervalWhile(Runnable action, javafx.util.Duration interval, javafx.beans.property.ReadOnlyBooleanProperty whileCondition) The Runnable action will be scheduled for execution iff whileCondition is initially true.
TimerAction	runOnceAfter(Runnable action, javafx.util.Duration delay) The Runnable action will be executed once after given delay
javafx.beans.property.ReadOnlyLongProperty	tickProperty()
double	tpf()

Methods inherited from interface com.almasb.fxgl.app.FXGLListener

onExit, onPause, onReset, onResume

Methods inherited from interface com.almasb.fxgl.settings.UserProfileSavable

load, save

Property Detail

playtime

javafx.beans.property.ReadOnlyLongProperty playtimeProperty

See Also:

getPlaytime()

tick

javafx.beans.property.ReadOnlyLongProperty tickProperty

See Also:

getTick()

fps

javafx.beans.property.IntegerProperty fpsProperty

performanceFPS

javafx.beans.property.IntegerProperty performanceFPSProperty

See Also:

getPerformanceFPS()

Method Detail

getNow

long getNow()

Current time for this tick in nanoseconds. Also time elapsed from the start of game. This time does not change while the game is paused. This time does not change while within the same tick.

Returns:

current time in nanoseconds

getPlaytime

default long getPlaytime()

Gets the value of the property playtime.

getPlaytimeHours

default long getPlaytimeHours()

getPlaytimeMinutes

default long getPlaytimeMinutes()

getPlaytimeSeconds

default long getPlaytimeSeconds()

playtimeProperty

javafx.beans.property.ReadOnlyLongProperty playtimeProperty()

See Also:

getPlaytime()

getTick

default long getTick()

Returns current tick (frame). When the game has just started, the first cycle in the loop will have tick == 1, second cycle - 2 and so on.

The update to this number happens when a new update cycle starts.

Returns:

current tick

tpf

double tpf()

Returns:

time per frame

tickProperty

javafx.beans.property.ReadOnlyLongProperty tickProperty()

See Also:

getTick()

getFPS

default int getFPS()

Returns:

average render FPS

fpsProperty

javafx.beans.property.IntegerProperty fpsProperty()

getPerformanceFPS

default int getPerformanceFPS()

Returns:

Average performance FPS

performanceFPSProperty

javafx.beans.property.IntegerProperty performanceFPSProperty()

See Also:

getPerformanceFPS()

runAtInterval

TimerAction runAtInterval(Runnable action,
                          javafx.util.Duration interval)

The Runnable action will be scheduled to run at given interval. The action will run for the first time after given interval.

Note: the scheduled action will not run while the game is paused.

Parameters:

action - the action

interval - time

runAtIntervalWhile

TimerAction runAtIntervalWhile(Runnable action,
                               javafx.util.Duration interval,
                               javafx.beans.property.ReadOnlyBooleanProperty whileCondition)

The Runnable action will be scheduled for execution iff whileCondition is initially true. If that's the case then the Runnable action will be scheduled to run at given interval. The action will run for the first time after given interval

The action will be removed from schedule when whileCondition becomes false.

Note: the scheduled action will not run while the game is paused

Parameters:

action - action to execute

interval - interval between executions

whileCondition - condition

runOnceAfter

TimerAction runOnceAfter(Runnable action,
                         javafx.util.Duration delay)

The Runnable action will be executed once after given delay

Note: the scheduled action will not run while the game is paused

Parameters:

action - action to execute

delay - delay after which to execute

reset

void reset()

Clears all registered timer based actions.

addUpdateListener

void addUpdateListener(UpdateEventListener listener)

Adds update event listener. Note: cannot be used during callbacks.

Parameters:

listener - the listener to add

removeUpdateListener

void removeUpdateListener(UpdateEventListener listener)

Removes update event listener. Note: cannot be used during callbacks.

Parameters:

listener - the listener to remove