Chat(3)                                                                Chat(3)



NNAAMMEE
       Chat - To be documented.

SSYYNNOOPPSSIISS
   PPuubblliicc MMeetthhooddss
       object iidd (string str)
       void ccrreeaattee ()
       int aadddd__cchhaannnneell (string chan)
       int rreemmoovvee__cchhaannnneell (string chan)
       void iinniitt ()
       int mmuuttee ()
       int cchhaannnneell (string comm)
       varargs int hhiisstt (string chan)
       int cchhaatt (string mssg)

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       To be documented.

       Definition at line 11 of file chat.c.

MMEEMMBBEERR FFUUNNCCTTIIOONN DDOOCCUUMMEENNTTAATTIIOONN
   iinntt aadddd__cchhaannnneell ((ssttrriinngg cchhaann))
       Starts listening on a new channel, and resets this chat object. _c_h_a_n
       may be any string.

       RReettuurrnnss::
           True on success, false otherwise (channel already added).

       Definition at line 35 of file chat.c.

       Referenced by channel().

   iinntt cchhaannnneell ((ssttrriinngg ccoommmm))
       Provides the 'channel' command (verb). With no parameters, lists
       current channels. Otherwise, this lets you add or drop channels.

       Definition at line 88 of file chat.c.

       References add_channel(), and remove_channel().

   iinntt cchhaatt ((ssttrriinngg mmssssgg))
       Broadcasts a chat message.

       Definition at line 180 of file chat.c.

       References hist().

   vvooiidd ccrreeaattee (())
       Initialize the chat object, and queries the channel variable from the
       player.

       Definition at line 24 of file chat.c.

   vvaarraarrggss iinntt hhiisstt ((ssttrriinngg cchhaann))
       Displays chat line history

       Definition at line 151 of file chat.c.

       Referenced by chat().

   oobbjjeecctt iidd ((ssttrriinngg ssttrr))
       Doesn't inherit 'desc' for simple efficiency, so it must define its own
       iidd(()) lfun. Returns true if it is passed the string 'chat'. This may be
       changed later, it was only done for wiz convenience.

       Definition at line 21 of file chat.c.

   vvooiidd iinniitt (())
       Called whenever the chat object is reset. This is done every time
       channel settings are changed, and when the player receives the object.
       Adds the channel, mute, and chat commands to the player (one chat
       command for each channel).

       Definition at line 58 of file chat.c.

   iinntt mmuuttee (())
       Allows the player to mute all the channels they are currently listening
       to.

       Definition at line 74 of file chat.c.

   iinntt rreemmoovvee__cchhaannnneell ((ssttrriinngg cchhaann))
       Stops listening to a channel, and resets this chat object. _c_h_a_n may be
       any string.

       RReettuurrnnss::
           True on success, false otherwise (no such channel).

       Definition at line 46 of file chat.c.

       Referenced by channel().


AAUUTTHHOORR
       Generated automatically by Doxygen for Walraven from the source code.



Walraven                          8 Jan 2004                           Chat(3)
