Scenedesc(3)                                                      Scenedesc(3)



NNAAMMEE
       Scenedesc -

SSYYNNOOPPSSIISS
       Inherited by Building, and SScceenneerryy.


   PPuubblliicc MMeetthhooddss
       sscceenneeddeesscc__iinnffoo ()
       string qquueerryy__pphhrraassee ()
       qquueerryy__ppoossiittiioonn ()
       qquueerryy__pprreeppoossiittiioonn ()
       void sseett__pphhrraassee (string x)
       sseett__ppoossiittiioonn (x)
       void sseett__pprreeppoossiittiioonn (string x)
       string ggeett__iinnvveenn__lliisstt ()
       string qquueerryy__sscceennee__pphhrraassee ()
       int qquueerryy__sscceenneerryy ()

   PPuubblliicc AAttttrriibbuutteess
       string pphhrraassee
       string ppoossiittiioonn
       string pprreeppoossiittiioonn
       string cclloossiinngg__pphhrraassee

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       This object holds basic scenery information -- basically a set of four
       variables used to add the extra descriptions that scenery needs in
       order to work. Any object that inherits this one will act like a piece
       of scenery (meaning it will be a part of the room description, rather
       than attached to the list at the end of the description ... except in
       brief mode).

       Definition at line 10 of file scenedesc.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 ggeett__iinnvveenn__lliisstt (())
       RReettuurrnnss::
           A string describing the inventory of this object, in brief. May be
           used as a sentence component.

       Definition at line 59 of file scenedesc.c.

   ssttrriinngg qquueerryy__pphhrraassee (())
       RReettuurrnnss::
           The phrase associated with this piece of scenery. This is generally
           a complete phrase, such as 'There is a big rock ~plac.'

       Definition at line 22 of file scenedesc.c.

       References phrase.

       Referenced by query_scene_phrase(), and query_scenery().

   qquueerryy__ppoossiittiioonn (())
       RReettuurrnnss::
           The string describing this scenery's location; 'here' is typical.
           This replaces ~plac in the phrase.

       Definition at line 33 of file scenedesc.c.

       References position.

   qquueerryy__pprreeppoossiittiioonn (())
       The preposition appropriate for objects associating with this scenery
       -- on, in, under, etc.

       Definition at line 38 of file scenedesc.c.

       References preposition.

   ssttrriinngg qquueerryy__sscceennee__pphhrraassee (())
       RReettuurrnnss::
           The completely processed phrase describing this piece of scenery.
           The return value from this is used in the room description.

       Definition at line 74 of file scenedesc.c.

       References position, query_phrase(), and set_phrase().

   iinntt qquueerryy__sscceenneerryy (())
       RReettuurrnnss::
           True, if the phrase is set; false otherwise. Allows a piece of
           scenery to revert to a normal object, if desired.

       Definition at line 89 of file scenedesc.c.

       References query_phrase().

   sscceenneeddeesscc__iinnffoo (())
       Used by an object editor to know what is editable on this object.

       Definition at line 17 of file scenedesc.c.

   vvooiidd sseett__pphhrraassee ((ssttrriinngg xx))
       Sets the phrase this scenery adds to the room description.

       Definition at line 42 of file scenedesc.c.

       Referenced by Door::create(), and query_scene_phrase().

   sseett__ppoossiittiioonn ((xx))
       Sets the scenery's position; the position replaces ~plac in the phrase.

       Definition at line 49 of file scenedesc.c.

       References position.

       Referenced by Door::create().

   vvooiidd sseett__pprreeppoossiittiioonn ((ssttrriinngg xx))
       Sets the appropriate preposition to use with this scenery. 'on' for
       tables, 'in' for chests or drawers.

       Definition at line 54 of file scenedesc.c.

       References preposition.

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 cclloossiinngg__pphhrraassee
       Scenedesc variables; see their functions for more information.

       Definition at line 14 of file scenedesc.c.

   ssttrriinngg pphhrraassee
       Scenedesc variables; see their functions for more information.

       Definition at line 14 of file scenedesc.c.

       Referenced by query_phrase().

   ssttrriinngg ppoossiittiioonn
       Scenedesc variables; see their functions for more information.

       Definition at line 14 of file scenedesc.c.

       Referenced by query_position(), query_scene_phrase(), and
       set_position().

   ssttrriinngg pprreeppoossiittiioonn
       Scenedesc variables; see their functions for more information.

       Definition at line 14 of file scenedesc.c.

       Referenced by query_preposition(), and set_preposition().


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



Walraven                          8 Jan 2004                      Scenedesc(3)
