Class BBS
System data and statistics for the BBS. The BBS
properties object holds global information about the BBS (its name, the
number of nodes, etc.) as well as statistics (number of users, total
calls, etc.).
Externals may use the data property to store information that is
global (BBS-wide) in scope. Sample items that fit into this category
might be: high-score tables, global bulletins, auto-generated mazes or
dungeons, etc. Please note that the BBS object is not
the place to store preferences information. That is the domain of the Preferences object and the prefs
global property.
This object cannot be constructed and is instead made available
in the hermes
module as a global variable with the name bbs.
| Method Summary |
| |
__init__(self)
Do not construct this object; used the bbs global
variable in the hermes module to access the BBS
properties. |
| Instance Variable Summary |
| External Data |
ExternalData |
data: Global (BBS-wide) data for this external. |
| BBS Data |
str |
name: The name of the BBS. |
int |
numNodes: The number of nodes on the BBS. |
dict |
users: The list of active (non-deleted) users on the BBS. |
| BBS Statistics |
str |
lastUser: The name of the last user that logged in to the BBS. |
int |
numUsers: The number of active (non-deleted) users on the BBS. |
int |
totalCalls: The total number of calls to the BBS since its inception. |
__init__(self)
(Constructor)
Do not construct this object; used the bbs global
variable in the hermes module to access the BBS
properties.
-
|
| Instance Variable Details |
data
Global (BBS-wide) data for this external.
-
- Type:
-
ExternalData
|
name
The name of the BBS.
-
- Type:
-
str
|
numNodes
The number of nodes on the BBS.
-
- Type:
-
int
|
users
The list of active (non-deleted) users on the BBS. The returned
dictionary is indexed by both user id and user name. In other words, if a
user named "Michael Alyn Miller" is registered with the BBS as
user id #27, you can access this user in one of two ways:
-
bbs.users[27]
-
bbs.users['Michael Alyn Miller']
Both methods return the same User object. User names are considered in
case-insensitive fashion.
-
- Type:
-
dict
|
lastUser
The name of the last user that logged in to the BBS.
-
- Type:
-
str
|
numUsers
The number of active (non-deleted) users on the BBS.
-
- Type:
-
int
|
totalCalls
The total number of calls to the BBS since its inception.
-
- Type:
-
int
|