Phantasmal MUD Lib for DGD

Phantasmal Site > Phantasmal API > API Listing > new_help_file

API Function: new_help_file

Summary:
read help file

Defined In LPC Object:
/usr/System/sys/helpd.c

Prototype:
void new_help_file(string path)

Can Be Called By:
System, Common, Game

Description:

Read a file ending in .hlp as a help entry and make it available for querying.

Return Value:

Nothing.

Errors:
Errors can occur in reading a file or parsing a help entry.

See Also:
new_help_directory , query_exact , query_exact_with_keywords , query_soundex , query_soundex_with_keywords