document idlers and slow them down!

[uccvend-vendserver.git] / sql-edition / servers / Idler.py

diff --git a/sql-edition/servers/Idler.py b/sql-edition/servers/Idler.py
index 89783e3..e56f8d7 100755 (executable)
--- a/sql-edition/servers/Idler.py
+++ b/sql-edition/servers/Idler.py
@@ -6,20 +6,26 @@ from MessageKeeper import MessageKeeper
 
 orderings = None
 
+IDLER_TEXT_SPEED=1.8
+
 class Idler:
        def __init__(self, v):
                self.v = v
 
        def next(self):
+               """Displays next stage of the idler"""
                pass
 
        def reset(self):
+               """Resets the idler to a known intial state"""
                pass
        
        def finished(self):
+               """Returns True if the idler is considered finished"""
                return False
 
        def affinity(self):
+               """How much we want this idler to be the next one chosen"""
                return 1
 
 class TrainIdler(Idler):
@@ -194,7 +200,7 @@ class StringIdler(Idler):
                self.mk = MessageKeeper(v)
                self.text = self.clean_text(text) + "          "
                
-               msg = [("",False, None),(self.text, repeat, 0.8)]
+               msg = [("",False, None),(self.text, repeat, IDLER_TEXT_SPEED)]
                self.mk.set_messages(msg)
 
        def clean_text(self, text):