[Package Index | Mudlib Index | Effect Index]
This inheritable allows objects or rooms to have help attached to them.
Written by Pinkfish
This class includes the following files /include/nroff.h and /include/room.h
These are functions that everyone can access.
void add_help_file(string help_file)
This method sets up the help for the room. All the help file names are
relative to /doc/room unless a complete path is specified.
help_file - the help file name
- See also:
mixed * help_function()
This method returns the help data as a function pointer.
The function pointer needs to be evaluated to create the actual text.
the function pointer for the help text
This method returns the help as a string.
the help as a string
This method is used to get the directory for the help files.
This should be overridden in higher up objects that use this object.
string * query_help_files()
This method returns the help files for the current room.
the array of help files
void remove_help_file(string help_file)
This method removes the specified help file from the current ones.
help_file - the help file name to remove