Skip to content

Commit e362437

Browse files
committed
Update README.textile
1 parent d7862df commit e362437

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.textile

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,14 @@ h2. Library Reference
9595

9696
h3. You should know:
9797

98-
- @Thread.()@ := Get the first available Timer.
98+
- @bool Thread::enabled@ := Enables or disables the Thread. (do not stop it from running, but will return false when shouldRun() is called)
99+
- @int Thread::ThreadID@ := Theoretically, it's the address of memory. It's unique, and can be used to compare if two threads are identical.
100+
- @int Thread::ThreadName@ := A human-redable thread name. Default is "Thread ThreadID" eg.: "Thread 141515";
101+
102+
- @void Thread::setInterval()@ := Setts the desired interval for the Thread (in Ms).
103+
- @bool Thread::shouldRun()@ := Returns true, if the Thread should be runned. (Basicaly, the logic is: (reached time AND is enabled?).
104+
- @void Thread::runned()@ := Used to reset internal timer of the Thread. This is automaticaly called AFTER a call to @run()@.
105+
99106

100107

101108
h3. You don't need to know:

0 commit comments

Comments
 (0)