Play Now

File /std/basic/help_files.c

Written by Pinkfish

Includes

Method index

• add_help_file(string)
  This method sets up the help for the room.
• help_function()
  This method returns the help data as a function pointer.
• help_string()
  This method returns the help as a string.
• query_help_file_directory()
  This method is used to get the directory for the help files.
• query_help_files()
  This method returns the help files for the current room.
• remove_help_file(string)
  This method removes the specified help file from the current ones.

Public Functions

These are functions that everyone can access.

.

add_help_file

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.

• Parameters:
  help_file - the help file name

help_function

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.

• Returns:
  the function pointer for the help text
  help_string

  string help_string()
  

  
  This method returns the help as a string.
  
  • Returns:
    the help as a string
    query_help_file_directory

    string query_help_file_directory()
    

    
    This method is used to get the directory for the help files. This should be overridden in higher up objects that use this object.
    query_help_files

    string query_help_files()
    

    
    This method returns the help files for the current room.
    
    • Returns:
      the array of help files
      remove_help_file

      void remove_help_file(string help_file)
      

      
      This method removes the specified help file from the current ones.
      
      • Parameters:
        help_file - the help file name to remove

Brought to you by CMOT Dibbler's Sensational Sausages; buy one while they're hot.
Copyright © Discworld MUD, Play Now, Vote.