summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'src/com/isode/stroke/network/Timer.java')
-rw-r--r--src/com/isode/stroke/network/Timer.java16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/com/isode/stroke/network/Timer.java b/src/com/isode/stroke/network/Timer.java
index 4949e05..a28d3e6 100644
--- a/src/com/isode/stroke/network/Timer.java
+++ b/src/com/isode/stroke/network/Timer.java
@@ -12,7 +12,23 @@ package com.isode.stroke.network;
import com.isode.stroke.signals.Signal;
public abstract class Timer {
+
+ /**
+ * Starts the timer.
+ *
+ * After the given period, onTick() will be called.
+ */
public abstract void start();
+
+ /**
+ * Cancels the timer.
+ *
+ * If the timer was started, onTick() will no longer be called.
+ */
public abstract void stop();
+
+ /**
+ * Emitted when the timer expires.
+ */
public final Signal onTick = new Signal();
}