File /std/room/basic/chatter.c

See also:
/std/room.c and room_chat .c

Written by Pinkfish

Includes

Method index

• add_room_chats(string *)
  Adds more chats to the existing set of room chats managed by this chatter object.
• check_chat()
  Checks that the chatter is on and being activated properly from the room_handler.
• query_room_chats()
  Returns the the set of room chats managed by this chatter object.
• remove_room_chats(string *)
  Removes chats from the set of room chats managed by this chatter object.
• set_chat_min_max(int, int)
  Allows the chat interval to be changed.
• setup_chatter(object, mixed *)
  Gives the chatter a room to chat at and the chat args.

Public Functions

These are functions that everyone can access.

.

add_room_chats

void add_room_chats(string * new_chats)


Adds more chats to the existing set of room chats managed by this chatter object.

• Parameters:
  new_chats - an array of new chat strings
• See also:
  remove_room_chats.c, query_room_chats.c and /std/room/basic/chatter .c

check_chat

void check_chat()


Checks that the chatter is on and being activated properly from the room_handler.

• See also:
  /std/room/basic/chatter.c and /obj/handlers/room_handler .c
  query_room_chats

  mixed * query_room_chats()
  

  
  Returns the the set of room chats managed by this chatter object.
  
  • Returns:
    pointer to the mixed array of chat args
  • See also:
    add_room_chats.c, remove_room_chats.c, room_chat.c and /std/room/basic/chatter .c
  • Example:
    

     ({ 120, 240, ({ "A frog gimbles the curtains.",
                     "A truly revolting smell drifts insidiously "
                     "from the rug." }) })

    remove_room_chats

    void remove_room_chats(string * dead_chats)
    

    
    Removes chats from the set of room chats managed by this chatter object. If there are no chats left the chatter is destructed.
    
    • Parameters:
      dead_chats - an array of chat strings to remove
    • See also:
      add_room_chats.c, query_room_chats.c and /std/room/basic/chatter .c
      set_chat_min_max

      void set_chat_min_max(int min,
                            int max)
      

      
      Allows the chat interval to be changed.
      
      • Parameters:
        min - minimum interval between chats (seconds)
        max - maximum interval between chats (seconds)
        setup_chatter

        void setup_chatter(object my_room,
                           mixed * chat_args)
        

        
        Gives the chatter a room to chat at and the chat args.
        
        • Parameters:
          my_room - room object
          chat_args - chat data: ({ min, max, chats array })
        • See also:
          room_chat.c, query_room_chats.c and /std/room/basic/chatter .c