File /std/basic/club_discuss.c

See also:
/obj/handlers/club_handler.c

Written by Pinkfish

Started April 21st 1999

Includes

Method index

• add_club_commands(object)
• add_elected_commands(object)
  This method adds the elected club specific commands to the player.
• discussion_item(int, string)
  This method returns information on the specified discussion item.
• discussion_item_list(string)
  This method will return the listing of discussion items as a nice string.
• do_archive(int)
  This method prints out the specific archive in more detail.
• do_list_archives()
  This method prints out the archives.
• do_nominate(int, string)
  A special entry point for nominating people to discussion items, this only works with the nomination discussion item.
• do_withdraw(int)
  A special entry point for withdrawing from a nominated discussion item, this only works with the nomination discussion item.

Public Functions

These are functions that everyone can access.

.

discussion_item

string discussion_item(int id,
                       string player)


This method returns information on the specified discussion item.

• Parameters:
  id - the id of the discussion item to get information on
  player - the player retreiving the information
• Returns:
  a string which is the information on the discussion item

discussion_item_list

string discussion_item_list(string player)


This method will return the listing of discussion items as a nice string.

• Parameters:
  player - the player who is doing the listing
• Returns:
  the discussion items as a listing
  do_archive

  int do_archive(int num)
  

  
  This method prints out the specific archive in more detail.
  
  • Parameters:
    num - the number of the archive to print out
  • Returns:
    1 on success, 0 on failure
    do_list_archives

    int do_list_archives()
    

    
    This method prints out the archives.
    
    • Returns:
      1 on success, 0 on failure
      do_nominate

      int do_nominate(int id,
                      string person)
      

      
      A special entry point for nominating people to discussion items, this only works with the nomination discussion item.
      
      • Parameters:
        id - the id of the discussion item
        person - the person to nominate
      • Returns:
        1 for success, 0 for failure
        do_withdraw

        int do_withdraw(int id)
        

        
        A special entry point for withdrawing from a nominated discussion item, this only works with the nomination discussion item.
        
        • Parameters:
          id - the id of the discussion item
        • Returns:
          1 for success, 0 for failure

          Protected Functions

          These are functions that only objects inheriting the class can access.
          add_club_commands

          void add_club_commands(object per)
          

          add_elected_commands

          void add_elected_commands(object per)
          

          
          This method adds the elected club specific commands to the player.