boris Documentation

0.5

Design Documentation components:

• acs_info - access control string
• bitfield - manages small staticly sized bitmaps. uses BITFIELD
• bitmap - manages large bitmaps
• buffer - manages an i/o buffer
• channel_group
• channel_member
• config - represent a configuration parser. uses config_watcher as entries.
• dll - low-level api to open modules (.dll or .so). uses dll_open and dll_close
• plugin - open plug-ins using dll.
• fdb - file database. holds data in regular files.
• form - uses formitem.
• form_state
• freelist - allocate ranges of numbers from a pool. uses freelist_entry and freelist_extent.
• heapqueue_elm - priority queue for implementing timers
• menuinfo - draws menus to a telnetclient
• refcount - macros to provide reference counting. uses REFCOUNT_TAKE and REFCOUNT_GET
• server - accepts new connections
• sha1 - SHA1 hashing.
• sha1crypt - SHA1 passwd hashing.
• shvar - process $() macros. implemented by shvar_eval.
• socketio_handle - manages network sockets
• telnetclient - processes data from a socket for Telnet protocol
• user - user account handling. see also user_name_map_entry.
• util_strfile - holds contents of a textfile in an array.

dependency:

• socketio_handle - uses ref counts to determine when to free linked lists items
• user - uses ref counts.

types of records:

• objects - base objects for room, mob, or item
• instances - instance data for room, mob or item
• container - container data for room, mob or item (a type of instance data)
• stringmap - maps strings to a data structure (hash table)
• numbermap - maps integers to a data structure (hash table)
• strings - a large string that can span multiple blocks

objects:

• base - the following types of objects are defined:
  • room
  • mob
  • item
• instance - all instances are the same structure:
  • id - object id
  • count - all item instances are stackable 1 to 256.
  • flags - 24 status flags [A-HJ-KM-Z]
  • extra1..extra2 - control values that can be variable

containers:

• instance parameter holds a id that holds an array of up to 64 objects.

database saves the following types of blobs:

• player account
• room object
• mob object (also used for characters)
• item object
• instances
• container slots
• help text