Interface(3)                                                      Interface(3)



NNAAMMEE
       Interface -

SSYYNNOOPPSSIISS
       Inherited by PPllaayyeerr.


   PPuubblliicc MMeetthhooddss
       __iinntteerrffaaccee__aadddd (string name, string prompt, object ob)
       __iinntteerrffaaccee__sshhiifftt (string name, string prompt, object ob)

   PPuubblliicc AAttttrriibbuutteess
       nosave string * iiffuunnccss
       nosave object * iioobbjjss
       nosave object * iipprroommppttss
       nosave int * iimmooddee
       nosave int eessccaappee__ccoouunntt

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       Inherit this file in any object that needs to be able to use an
       interface. Interfaces are used by things like the text editor, the
       administration utility, etc.

       For more information about interfaces, see the add_interface,
       drop_interface, clear_interface, and shift_interface functions in
       simul_efun.

       Definition at line 13 of file interface.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teerrffaaccee__aadddd ((ssttrriinngg nnaammee,, ssttrriinngg pprroommpptt,, oobbjjeecctt oobb))
       Adds an interface to this player's input stack. This is only for line-
       mode interfaces; for single character interfaces, you should use
       _interface_single_char. You normally shouldn't call these functions
       directly, use SSiimmuull__eeffuunn::::aadddd__iinntteerrffaaccee(()) instead.

       PPaarraammeetteerrss::

       _n_a_m_e   The function that will process the input given.

       _p_r_o_m_p_t The text given as a prompt. Uses PPllaayyeerr::::sseett__ccuurrrr__pprroommpptt(()).

       _o_b     A pointer to the object hosting the interface.

       Definition at line 37 of file interface.c.

       References ifuncs, imode, iobjs, and iprompts.

   __iinntteerrffaaccee__sshhiifftt ((ssttrriinngg nnaammee,, ssttrriinngg pprroommpptt,, oobbjjeecctt oobb))
       Used by shift_interface. Note that it preserves the input catch.

       Definition at line 68 of file interface.c.

       References ifuncs, imode, iobjs, and iprompts.

MMEEMMBBEERR DDAATTAA DDOOCCUUMMEENNTTAATTIIOONN
   nnoossaavvee iinntt eessccaappee__ccoouunntt
       Number of times in a row that escape's been pressed. Three escapes is
       like a 'control+break' from charmode interfaces.

       Definition at line 107 of file interface.c.

   nnoossaavvee ssttrriinngg** iiffuunnccss
       Functions providing the interface.

       Definition at line 17 of file interface.c.

       Referenced by _interface_add(), and _interface_shift().

   nnoossaavvee iinntt** iimmooddee
       The interface mode. This is a bit-wise set integer with various
       interface information. Presently implemented features:

       &0x01: This interface is in charmode

       &0x02: This interface wants to handle all received text (using
       catch_tell).


       Definition at line 27 of file interface.c.

       Referenced by _interface_add(), _interface_shift(),
       Player::catch_tell(), and Player::find_catcher().

   nnoossaavvee oobbjjeecctt** iioobbjjss
       Definition at line 19 of file interface.c.

       Referenced by _interface_add(), and _interface_shift().

   nnoossaavvee oobbjjeecctt** iipprroommppttss
       The stack of prompts provided by the interface (only relevant in line-
       mode).

       Definition at line 21 of file interface.c.

       Referenced by _interface_add(), and _interface_shift().


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



Walraven                          8 Jan 2004                      Interface(3)
