Modifier and Type	Class and Description
public abstract static class	Timer.Task Runnable that can be scheduled on a `Timer`.
pack-priv static class	Timer.TimerThread Manages a single thread for updating timers.

Modifier and Type	Field and Description
pack-priv long	stopTimeMillis
pack-priv final Array<Timer.Task>	tasks
pack-priv static Timer.TimerThread	thread
pack-priv static final Object	threadLock

Access	Constructor and Description
public	Timer()

Method Summary

Modifier and Type	Method and Description
public void	clear() Cancels all tasks.
public synchronized void	delay(long delayMillis) Adds the specified delay to all tasks.
public static Timer	instance() Timer instance singleton for general application wide usage.
public synchronized boolean	isEmpty() Returns true if the timer has no tasks in the queue.
public static Timer.Task	post(Timer.Task task) Schedules a task on `instance`.
public Timer.Task	postTask(Timer.Task task) Schedules a task to occur once as soon as possible, but not sooner than the start of the next frame.
public static Timer.Task	schedule(Timer.Task task, float delaySeconds) Schedules a task on `instance`.
public static Timer.Task	schedule(Timer.Task task, float delaySeconds, float intervalSeconds) Schedules a task on `instance`.
public static Timer.Task	schedule(Timer.Task task, float delaySeconds, float intervalSeconds, int repeatCount) Schedules a task on `instance`.
public Timer.Task	scheduleTask(Timer.Task task, float delaySeconds) Schedules a task to occur once after the specified delay.
public Timer.Task	scheduleTask(Timer.Task task, float delaySeconds, float intervalSeconds) Schedules a task to occur once after the specified delay and then repeatedly at the specified interval until cancelled.
public Timer.Task	scheduleTask(Timer.Task task, float delaySeconds, float intervalSeconds, int If negative, the task will repeat forever. repeatCount) Schedules a task to occur once after the specified delay and then a number of additional times at the specified interval.
public void	start() Starts the timer if it was stopped.
public void	stop() Stops the timer if it was started.
pack-priv static Timer.TimerThread	thread()
pack-priv synchronized long	update(Timer.TimerThread thread, long timeMillis, long waitMillis)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

stopTimeMillis	back to summary
pack-priv long stopTimeMillis

tasks	back to summary
pack-priv final Array<Timer.Task> tasks

thread	back to summary
pack-priv static Timer.TimerThread thread

threadLock	back to summary
pack-priv static final Object threadLock

Timer	back to summary
public Timer()

Method Detail

clear	back to summary
public void clear() Cancels all tasks.

delay	back to summary
public synchronized void delay(long delayMillis) Adds the specified delay to all tasks.

instance	back to summary
public static Timer instance() Timer instance singleton for general application wide usage. Static methods on `Timer` make convenient use of this instance.

isEmpty	back to summary
public synchronized boolean isEmpty() Returns true if the timer has no tasks in the queue. Note that this can change at any time. Synchronize on the timer instance to prevent tasks being added, removed, or updated.

post back to summary

post	back to summary
public static Timer.Task post(Timer.Task task) Schedules a task on `instance`. See Also `postTask(Task)`

public static Timer.Task post(Timer.Task task)

Schedules a task on instance.

See Also: postTask(Task)

postTask	back to summary
public Timer.Task postTask(Timer.Task task) Schedules a task to occur once as soon as possible, but not sooner than the start of the next frame.

schedule back to summary

schedule	back to summary
public static Timer.Task schedule(Timer.Task task, float delaySeconds) Schedules a task on `instance`. See Also `scheduleTask(Task, float)`

public static Timer.Task schedule(Timer.Task task, float delaySeconds)

Schedules a task on instance.

See Also: scheduleTask(Task, float)

schedule back to summary

schedule	back to summary
public static Timer.Task schedule(Timer.Task task, float delaySeconds, float intervalSeconds) Schedules a task on `instance`. See Also `scheduleTask(Task, float, float)`

public static Timer.Task schedule(Timer.Task task, float delaySeconds, float intervalSeconds)

Schedules a task on instance.

See Also: scheduleTask(Task, float, float)

schedule back to summary

schedule	back to summary
public static Timer.Task schedule(Timer.Task task, float delaySeconds, float intervalSeconds, int repeatCount) Schedules a task on `instance`. See Also `scheduleTask(Task, float, float, int)`

public static Timer.Task schedule(Timer.Task task, float delaySeconds, float intervalSeconds, int repeatCount)

Schedules a task on instance.

See Also: scheduleTask(Task, float, float, int)

scheduleTask	back to summary
public Timer.Task scheduleTask(Timer.Task task, float delaySeconds) Schedules a task to occur once after the specified delay.

scheduleTask	back to summary
public Timer.Task scheduleTask(Timer.Task task, float delaySeconds, float intervalSeconds) Schedules a task to occur once after the specified delay and then repeatedly at the specified interval until cancelled.

scheduleTask	back to summary
public Timer.Task scheduleTask(Timer.Task task, float delaySeconds, float intervalSeconds, int repeatCount) Schedules a task to occur once after the specified delay and then a number of additional times at the specified interval. Parameters repeatCount:int If negative, the task will repeat forever.

scheduleTask

back to summary

public Timer.Task scheduleTask(Timer.Task task, float delaySeconds, float intervalSeconds, int repeatCount)

Schedules a task to occur once after the specified delay and then a number of additional times at the specified interval.

Parameters

repeatCount:int: If negative, the task will repeat forever.

start	back to summary
public void start() Starts the timer if it was stopped. Tasks are delayed by the time passed while stopped.

stop	back to summary
public void stop() Stops the timer if it was started. Tasks will not be executed while stopped.

thread	back to summary
pack-priv static Timer.TimerThread thread()

update	back to summary
pack-priv synchronized long update(Timer.TimerThread thread, long timeMillis, long waitMillis)

com.badlogic.gdx.utils back to summary

public abstract Class Timer.Task

Class Inheritance

extends Object
implements Runnable

java.lang.Object
com.badlogic.gdx.utils.Timer.Task

All Implemented Interfaces

java.lang.Runnable

Known Direct Subclasses

com.badlogic.gdx.scenes.scene2d.ui.TextField.KeyRepeatTask

Runnable that can be scheduled on a Timer.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv final Application	app
pack-priv long	executeTimeMillis
pack-priv long	intervalMillis
pack-priv int	repeatCount
pack-priv volatile Timer	timer

Constructor Summary

Access	Constructor and Description
public	Task()

Method Summary

Modifier and Type	Method and Description
public void	cancel() Cancels the task.
public synchronized long	getExecuteTimeMillis() Returns the time in milliseconds when this task will be executed next.
public boolean	isScheduled() Returns true if this task is scheduled to be executed in the future by a timer.
pack-priv synchronized void	reset()
public abstract void	run() Redeclares java.lang.Runnable.run. If this is the last time the task will be ran or the task is first cancelled, it may be scheduled again in this method.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

app	back to summary
pack-priv final Application app

executeTimeMillis	back to summary
pack-priv long executeTimeMillis

intervalMillis	back to summary
pack-priv long intervalMillis

repeatCount	back to summary
pack-priv int repeatCount

timer	back to summary
pack-priv volatile Timer timer

Constructor Detail

Task	back to summary
public Task()

Method Detail

cancel	back to summary
public void cancel() Cancels the task. It will not be executed until it is scheduled again. This method can be called at any time.

getExecuteTimeMillis	back to summary
public synchronized long getExecuteTimeMillis() Returns the time in milliseconds when this task will be executed next.

isScheduled	back to summary
public boolean isScheduled() Returns true if this task is scheduled to be executed in the future by a timer. The execution time may be reached at any time after calling this method, which may change the scheduled state. To prevent the scheduled state from changing, synchronize on this task object, eg: synchronized (task) { if (!task.isScheduled()) { ... } }

isScheduled

back to summary

public boolean isScheduled()

Returns true if this task is scheduled to be executed in the future by a timer. The execution time may be reached at any time after calling this method, which may change the scheduled state. To prevent the scheduled state from changing, synchronize on this task object, eg:

synchronized (task) {
	if (!task.isScheduled()) { ... }
}

reset	back to summary
pack-priv synchronized void reset()

run	back to summary
public abstract void run() Redeclares java.lang.Runnable.run. If this is the last time the task will be ran or the task is first cancelled, it may be scheduled again in this method.

run

back to summary

public abstract void run()

Redeclares java.lang.Runnable.run.

If this is the last time the task will be ran or the task is first cancelled, it may be scheduled again in this method.

com.badlogic.gdx.utils back to summary

pack-priv Class Timer.TimerThread

Class Inheritance

extends Object
implements Runnable, LifecycleListener

java.lang.Object
com.badlogic.gdx.utils.Timer.TimerThread

All Implemented Interfaces

com.badlogic.gdx.LifecycleListener, java.lang.Runnable

Manages a single thread for updating timers. Uses libgdx application events to pause, resume, and dispose the thread.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
pack-priv final Application	app
pack-priv final Files	files
pack-priv Timer	instance
pack-priv final Array<Timer>	instances
pack-priv long	pauseTimeMillis
pack-priv final Array<Timer.Task>	postedTasks
private final Runnable	runPostedTasks
pack-priv final Array<Timer.Task>	runTasks

Constructor Summary

Access	Constructor and Description
public	TimerThread()

Method Summary

Modifier and Type	Method and Description
pack-priv void	addPostedTask(Timer.Task task)
public void	dispose() Implements com.badlogic.gdx.LifecycleListener.dispose. Called when the `Application` is about to be disposed
public void	pause() Implements com.badlogic.gdx.LifecycleListener.pause. Called when the `Application` is about to pause
pack-priv void	removePostedTask(Timer.Task task)
public void	resume() Implements com.badlogic.gdx.LifecycleListener.resume. Called when the Application is about to be resumed
public void	run() Implements java.lang.Runnable.run. Runs this operation.
pack-priv void	runPostedTasks()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

app	back to summary
pack-priv final Application app

files	back to summary
pack-priv final Files files

instance	back to summary
pack-priv Timer instance

instances	back to summary
pack-priv final Array<Timer> instances

pauseTimeMillis	back to summary
pack-priv long pauseTimeMillis

postedTasks	back to summary
pack-priv final Array<Timer.Task> postedTasks

runPostedTasks	back to summary
private final Runnable runPostedTasks

runTasks	back to summary
pack-priv final Array<Timer.Task> runTasks

Constructor Detail

TimerThread	back to summary
public TimerThread()

Method Detail

addPostedTask	back to summary
pack-priv void addPostedTask(Timer.Task task)

dispose back to summary

public void dispose()

Implements com.badlogic.gdx.LifecycleListener.dispose.

Doc from com.badlogic.gdx.LifecycleListener.dispose.

Called when the Application is about to be disposed

pause back to summary

public void pause()

Implements com.badlogic.gdx.LifecycleListener.pause.

Doc from com.badlogic.gdx.LifecycleListener.pause.

Called when the Application is about to pause

removePostedTask	back to summary
pack-priv void removePostedTask(Timer.Task task)

resume

back to summary

public void resume()

Implements com.badlogic.gdx.LifecycleListener.resume.

Doc from com.badlogic.gdx.LifecycleListener.resume.

Called when the Application is about to be resumed

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

runPostedTasks	back to summary
pack-priv void runPostedTasks()

public Class Timer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class Timer.Task

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Timer.TimerThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail