Blocker(3)                                                          Blocker(3)



NNAAMMEE
       Blocker -

SSYYNNOOPPSSIISS
   PPuubblliicc MMeetthhooddss
       string bblloocckkeerr__iinnffoo ()
       string qquueerryy__bblloocckk__mmeessssaaggee ()
       string qquueerryy__ppaassss__mmeessssaaggee ()
       int qquueerryy__bblloocckk__vviissiibbllee ()
       void sseett__bblloocckk__mmeessssaaggee (string x)
       void sseett__ppaassss__mmeessssaaggee (string x)
       void sseett__bblloocckk__vviissiibbllee (int x)

   PPuubblliicc AAttttrriibbuutteess
       string bblloocckk__mmeessssaaggee
       string ppaassss__mmeessssaaggee
       int bblloocckk__vviissiibbllee

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       This object handles all the variables associated with objects used for
       blocking exits. It is not strictly necessary for an object to inherit
       this one in order to be used for blocking exits. This object does allow
       you to have a lot more flexibility in the way you handle exit blocking,
       though, with things like special messages when the blocker stops or
       passes someone, etc.

       Definition at line 13 of file blocker.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
   ssttrriinngg bblloocckkeerr__iinnffoo (())
       A function used by the object editor to find internal variables.

       Definition at line 17 of file blocker.c.

   ssttrriinngg qquueerryy__bblloocckk__mmeessssaaggee (())
       RReettuurrnnss::
           The message returned when this object blocks something.

       Definition at line 29 of file blocker.c.

       References block_message.

   iinntt qquueerryy__bblloocckk__vviissiibbllee (())
       RReettuurrnnss::
           True if this blocker should be visible in the room it's blocking
           in.

       Definition at line 35 of file blocker.c.

       References block_visible.

   ssttrriinngg qquueerryy__ppaassss__mmeessssaaggee (())
       RReettuurrnnss::
           The message returned when something is allowed to pass this object.

       Definition at line 32 of file blocker.c.

       References pass_message.

   vvooiidd sseett__bblloocckk__mmeessssaaggee ((ssttrriinngg xx))
       Sets the 'exit is blocked' message to _x.

       Definition at line 38 of file blocker.c.

       References block_message.

   vvooiidd sseett__bblloocckk__vviissiibbllee ((iinntt xx))
       Sets the block_visible flag.

       Definition at line 44 of file blocker.c.

       References block_visible.

   vvooiidd sseett__ppaassss__mmeessssaaggee ((ssttrriinngg xx))
       Sets the 'passage allowed' message to _x.

       Definition at line 41 of file blocker.c.

       References pass_message.

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
   ssttrriinngg bblloocckk__mmeessssaaggee
       The message given when the exit is blocked.

       Definition at line 20 of file blocker.c.

       Referenced by query_block_message(), and set_block_message().

   iinntt bblloocckk__vviissiibbllee
       If this flag is true, the blocker will be visible in the descriptions
       of the rooms it's doing its blocking in. You still have to set a
       description for it, of course.

       Definition at line 26 of file blocker.c.

       Referenced by query_block_visible(), and set_block_visible().

   ssttrriinngg ppaassss__mmeessssaaggee
       The message given when someone is allowed to pass, if any.

       Definition at line 20 of file blocker.c.

       Referenced by query_pass_message(), and set_pass_message().


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



Walraven                          8 Jan 2004                        Blocker(3)
