com.unity3d.services.core.timer

Class BaseTimer

java.lang.Object

com.unity3d.services.core.timer.BaseTimer

All Implemented Interfaces:

IAppActiveListener, IBaseTimer

Direct Known Subclasses:

IntervalTimer

public class BaseTimer
extends java.lang.Object
implements IBaseTimer, IAppActiveListener

Simple class that represents a timer with a ITimerListener that notifies when finished

Constructor Summary

Constructors

Constructor and Description
BaseTimer(java.lang.Integer totalDurationMs, ITimerListener timerListener)
BaseTimer(java.lang.Integer totalDurationMs, ITimerListener timerListener, LifecycleCache lifecycleCache)

Method Summary

Modifier and Type	Method and Description
boolean	isRunning()
void	kill() Stops and cleans up
void	onAppStateChanged(LifecycleEvent event)
void	onStep()
boolean	pause() Pauses the timer countdown Countdown can be continued via Resume or Restart
void	restart(java.util.concurrent.ScheduledExecutorService timerService) Restarts the timer to initial countdown after a Stop
boolean	resume() Resumes the timer countdown after a Pause
void	start(java.util.concurrent.ScheduledExecutorService timerService) Starts the timer countdown
void	stop() Stops the timer countdown For timer to continue Restart is required

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTimer

public BaseTimer(java.lang.Integer totalDurationMs,
                 ITimerListener timerListener,
                 LifecycleCache lifecycleCache)

BaseTimer

public BaseTimer(java.lang.Integer totalDurationMs,
                 ITimerListener timerListener)

Method Detail

start

public void start(java.util.concurrent.ScheduledExecutorService timerService)

Starts the timer countdown

Specified by:

start in interface IBaseTimer

Parameters:

timerService - ScheduledExecutorService to run timer on, will be shutdown when timer is stopped via Stop or Kill

stop

public void stop()

Stops the timer countdown For timer to continue Restart is required

Specified by:

stop in interface IBaseTimer

pause

public boolean pause()

Pauses the timer countdown Countdown can be continued via Resume or Restart

Specified by:

pause in interface IBaseTimer

Returns:

if countdown could be paused

resume

public boolean resume()

Resumes the timer countdown after a Pause

Specified by:

resume in interface IBaseTimer

Returns:

if countdown resumed successfully

restart

public void restart(java.util.concurrent.ScheduledExecutorService timerService)

Restarts the timer to initial countdown after a Stop

kill

public void kill()

Stops and cleans up

Specified by:

kill in interface IBaseTimer

isRunning

public boolean isRunning()

Returns:

if countdown is currently running

onStep

public void onStep()

onAppStateChanged

public void onAppStateChanged(LifecycleEvent event)

Specified by:

onAppStateChanged in interface IAppActiveListener