io.lurkers.server.scripting.interfaces.lua

Class Timer

java.lang.Object

io.lurkers.server.scripting.interfaces.lua.Timer

public class Timer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Timer()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the timer
static void	cancelAllTimers() Cancels all running timers.
static long	getTimeMillis()
static Timer	getTimerByName(java.lang.String name, Peer peer) Returns the timer with the specified name
static long	getTimeSeconds()
static boolean	hasTimer(java.lang.String name, Peer peer)
static Timer	startCounterTimer(LuaClosure closure, float delaySeconds, float intervalSeconds, int repeatCount, java.lang.String name) Start a timer that shows up on the UI and execute the callback when expired.
static Timer	startCounterTimerForPeer(LuaClosure closure, float delaySeconds, float intervalSeconds, int repeatCount, java.lang.String name, io.lurkers.server.Peer peer)
static Timer	startCounterTimerForPeer(LuaClosure closure, float delaySeconds, float intervalSeconds, int repeatCount, java.lang.String name, Peer peer) Start a timer that shows up on the UI for the specified peer only and execute the callback when expired.
static Timer	startTimer(LuaClosure closure, float delaySeconds, float intervalSeconds, int repeatCount, java.lang.String name) Start a timer and execute the callback when expired.
void	stop() Cancels the timer

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer()

Method Detail

stop

public void stop()

Cancels the timer

cancel

public void cancel()

Cancels the timer

startTimer

public static Timer startTimer(LuaClosure closure,
                               float delaySeconds,
                               float intervalSeconds,
                               int repeatCount,
                               java.lang.String name)

Start a timer and execute the callback when expired. Can optionally be repeated

Parameters:

closure - The callback to be executed on expiry. No arguments are passed

delaySeconds - Delay before the timer expires

intervalSeconds - Delay after the first interval

repeatCount - Number of repeats, set to 0 to not repeat

Returns:

Returns the newly created timer

startCounterTimer

public static Timer startCounterTimer(LuaClosure closure,
                                      float delaySeconds,
                                      float intervalSeconds,
                                      int repeatCount,
                                      java.lang.String name)

Start a timer that shows up on the UI and execute the callback when expired. Can optionally be repeated.

Parameters:

closure - The callback to be executed on expiry. No arguments are passed

delaySeconds - Delay before the timer expires

intervalSeconds - Delay after the first interval

repeatCount - Number of repeats, set to 0 to not repeat

Returns:

Returns the newly created timer

startCounterTimerForPeer

public static Timer startCounterTimerForPeer(LuaClosure closure,
                                             float delaySeconds,
                                             float intervalSeconds,
                                             int repeatCount,
                                             java.lang.String name,
                                             Peer peer)

Start a timer that shows up on the UI for the specified peer only and execute the callback when expired. Can optionally be repeated.

Parameters:

closure - The callback to be executed on expiry. No arguments are passed

delaySeconds - Delay before the timer expires

intervalSeconds - Delay after the first interval

repeatCount - Number of repeats, set to 0 to not repeat

Returns:

Returns the newly created timer

startCounterTimerForPeer

public static Timer startCounterTimerForPeer(LuaClosure closure,
                                             float delaySeconds,
                                             float intervalSeconds,
                                             int repeatCount,
                                             java.lang.String name,
                                             io.lurkers.server.Peer peer)

getTimerByName

public static Timer getTimerByName(java.lang.String name,
                                   Peer peer)

Returns the timer with the specified name

Parameters:

name -

Returns:

hasTimer

public static boolean hasTimer(java.lang.String name,
                               Peer peer)

cancelAllTimers

public static void cancelAllTimers()

Cancels all running timers.

getTimeMillis

public static long getTimeMillis()

Returns:

Returns the current time in milliseconds.

getTimeSeconds

public static long getTimeSeconds()

Returns:

Returns the current time in seconds.