Some documentation fixups that I noticed off-hand.

This commit is contained in:
Greg Taylor 2007-05-23 19:52:55 +00:00
parent a523f845d1
commit 88dcdc95eb
3 changed files with 7 additions and 5 deletions

View file

@ -10,10 +10,10 @@ import functions_general
import functions_db import functions_db
import commands_general import commands_general
import ansi import ansi
""" """
Any command here is prefixed by an '@' sign, usually denoting a This file contains commands that require special permissions to use. These
builder, staff or otherwise manipulative command that doesn't fall within are generally @-prefixed commands, but there are exceptions.
the scope of normal gameplay.
""" """
def cmd_reload(cdat): def cmd_reload(cdat):

View file

@ -6,7 +6,7 @@ import session_mgr
Holds the events scheduled in scheduler.py. Holds the events scheduled in scheduler.py.
""" """
def check_sessions(): def evt_check_sessions():
""" """
Event: Check all of the connected sessions. Event: Check all of the connected sessions.
""" """

View file

@ -2,6 +2,8 @@ import time
from twisted.internet import task from twisted.internet import task
import events import events
""" """
This file contains the event scheduler system.
ADDING AN EVENT: ADDING AN EVENT:
* Create an event function to call. * Create an event function to call.
* Add an entry to the 'schedule' dictionary here. * Add an entry to the 'schedule' dictionary here.
@ -11,7 +13,7 @@ ADDING AN EVENT:
# Dictionary of events with a list in the form of: # Dictionary of events with a list in the form of:
# [<function>, <interval>, <lastrantime>, <taskobject>, <description>] # [<function>, <interval>, <lastrantime>, <taskobject>, <description>]
schedule = { schedule = {
'check_sessions': [events.check_sessions, 60, time.time(), None, "Session consistency checks."] 'evt_check_sessions': [events.evt_check_sessions, 60, time.time(), None, "Session consistency checks."]
} }
def start_events(): def start_events():