Desc(3)                                                                Desc(3)



NNAAMMEE
       Desc - Inheritable component for defining descriptions.

SSYYNNOOPPSSIISS
       Inherited by AArreeaa, BBaannkk, Building, DDoooorr, Food [private], LLiivviinngg,
       MMaaiillmmssgg, MMaappaarreeaa, MMaapprroooomm, QQuuaannttiittyy, RReessoouurrccee, RRoooomm, SScceenneerryy, TTrriinnkkeett,
       VVooiidd, and WWeeaappoonnOObbjj.


   PPuubblliicc MMeetthhooddss
       string ddeesscc__iinnffoo ()
       object iidd (string str)

       SSeettss
       Functions for setting the variables used to describe an object.

           void sseett__llooookk (string str)
           void sseett__lloonngg (string str)
           void sseett__sshhoorrtt (string str)
           void sseett__ddiissttaanntt (string str)
           void sseett__ssppeecciiffiicc (string str)
           void sseett__ttaassttee (string str)
           void sseett__pplluurraall (string str)
           void sseett__nnaammee (string str)
           void sseett__aalltt__nnaammee (string *str)
           void aadddd__aalltt__nnaammee (string str)
           void sseett__aalltt__pplluurraall (string *str)
           void aadddd__aalltt__pplluurraall (string str)
           void rreemmoovvee__aalltt__nnaammee (string str)
           void sseett__ttyyppee (string str)

       QQuueerriieess
       Functions used for querying description-related variables. See the
       'set' functions for more detailed information.

           string qquueerryy__ddeeffaauulltt__nnaammee ()
           string qquueerryy__nnaammee ()
           string qquueerryy__ddeeffaauulltt__sshhoorrtt ()
           string qquueerryy__ddeeffaauulltt__ddiissttaanntt ()
           string qquueerryy__ddeeffaauulltt__ssppeecciiffiicc ()
           string qquueerryy__ddeeffaauulltt__pplluurraall ()
           string qquueerryy__lloonngg ()
           string qquueerryy__sshhoorrtt ()
           string qquueerryy__ddiissttaanntt ()
           string qquueerryy__ssppeecciiffiicc ()
           string qquueerryy__ttaassttee ()
           string qquueerryy__llooookk ()
           string qquueerryy__pplluurraall ()
           string * qquueerryy__aalltt__nnaammee ()
           string * qquueerryy__aalltt__pplluurraall ()
           int qquueerryy__iiss__pplluurraall (string str)
           string qquueerryy__ccaapp__nnaammee ()
           string qquueerryy__ttyyppee ()

   PPuubblliicc AAttttrriibbuutteess
       string nnaammee

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       Inheritable component for defining descriptions.

       #include <desc.h> to use this file.

       Inheriting this object lets the derived object have a description. The
       large majority of game objects have a description, so they will inherit
       this object. You should include desc.h to use these functions.

       Definition at line 13 of file desc.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
   vvooiidd aadddd__aalltt__nnaammee ((ssttrriinngg ssttrr))
       Allows you to tag additional alternative names onto this object. The
       alt_name list is stored as an array of strings.

       Definition at line 97 of file desc.c.

       References query_alt_name().

   vvooiidd aadddd__aalltt__pplluurraall ((ssttrriinngg ssttrr))
       Add an alternative plural name to whatever ones are currently set. May
       be called repeatedly to define multiple names, though passing an array
       into set_alt_plural is usually easiest.

       Definition at line 117 of file desc.c.

       References query_alt_plural().

   ssttrriinngg ddeesscc__iinnffoo (())
       RReettuurrnnss::
           A list (string separated by \n's) of variables with set/query pairs
           in this object.This function is used by the object editor. You may
           call this if you wish to know whether a derived object inherits
           this one.

       Definition at line 230 of file desc.c.

   oobbjjeecctt iidd ((ssttrriinngg ssttrr))
       RReettuurrnnss::
           true if the str 'identifies' this object.

       WWaarrnniinngg::
           If you override the iidd(()) function, you should call iidd(()) as well so
           that the values set in the object will still be checked for
           identification.

       Reimplemented in DDoooorr, LLiivviinngg, VVooiidd, and MMaapprroooomm.

       Definition at line 241 of file desc.c.

       References query_alt_name(), query_alt_plural(), query_distant(),
       query_plural(), query_specific(), and query_type().

   ssttrriinngg** qquueerryy__aalltt__nnaammee (())
       Alternative name(s) for this object -- for typing convenience.
       Guarantees returning an array.

       Definition at line 195 of file desc.c.

       Referenced by add_alt_name(), id(), and remove_alt_name().

   ssttrriinngg** qquueerryy__aalltt__pplluurraall (())
       Alternative plural name(s) for this object. Guarantees an array, even
       if empty.

       Definition at line 202 of file desc.c.

       Referenced by add_alt_plural(), id(), and query_is_plural().

   ssttrriinngg qquueerryy__ccaapp__nnaammee (())
       RReettuurrnnss::
           The name of this object capitalized.

       Definition at line 218 of file desc.c.

       Referenced by Living::adopt_best_form(), Player::query_distant(),
       Player::query_specific(), Player::quit(), and Player::set_name().

   ssttrriinngg qquueerryy__ddeeffaauulltt__ddiissttaanntt (())
       Automatically generated. Before vowels, 'an'; otherwise, 'a'.

       Definition at line 161 of file desc.c.

       Referenced by query_distant().

   ssttrriinngg qquueerryy__ddeeffaauulltt__nnaammee (())
       The name of this object; generally just one word.

       Definition at line 145 of file desc.c.

   ssttrriinngg qquueerryy__ddeeffaauulltt__pplluurraall (())
       Automatically generated.

       Definition at line 171 of file desc.c.

       Referenced by query_plural().

   ssttrriinngg qquueerryy__ddeeffaauulltt__sshhoorrtt (())
       A brief description of the object from inside (room title).

       Definition at line 158 of file desc.c.

       Referenced by query_short().

   ssttrriinngg qquueerryy__ddeeffaauulltt__ssppeecciiffiicc (())
       Automatically generated.

       Definition at line 168 of file desc.c.

       Referenced by query_specific().

   ssttrriinngg qquueerryy__ddiissttaanntt (())
       This object as a list item (include indefinite article: 'a box').

       Reimplemented in LLiivviinngg, and PPllaayyeerr.

       Definition at line 180 of file desc.c.

       References query_default_distant().

       Referenced by id().

   iinntt qquueerryy__iiss__pplluurraall ((ssttrriinngg ssttrr))
       RReettuurrnnss::
           True if _s_t_r is a plural form for the name of this object; false
           otherwise.

       Definition at line 211 of file desc.c.

       References query_alt_plural(), and query_plural().

   ssttrriinngg qquueerryy__lloonngg (())
       The string given when you look at an object from inside.

       Definition at line 174 of file desc.c.

       Referenced by Room::query_room_desc().

   ssttrriinngg qquueerryy__llooookk (())
       The string given when you look at an object from outside.

       Reimplemented in LLiivviinngg.

       Definition at line 189 of file desc.c.

   ssttrriinngg qquueerryy__pplluurraall (())
       The name of this object, pluralized (sock->socks).

       Reimplemented in LLiivviinngg.

       Definition at line 192 of file desc.c.

       References query_default_plural().

       Referenced by id(), and query_is_plural().

   ssttrriinngg qquueerryy__sshhoorrtt (())
       A brief description of the object from inside (room title).

       Definition at line 177 of file desc.c.

       References query_default_short().

       Referenced by Maproom::query_room_desc().

   ssttrriinngg qquueerryy__ssppeecciiffiicc (())
       The definite article version of the distant. Automatically generated.

       Reimplemented in LLiivviinngg, and PPllaayyeerr.

       Definition at line 183 of file desc.c.

       References query_default_specific().

       Referenced by id(), and Door::on_action().

   ssttrriinngg qquueerryy__ttaassttee (())
       The taste of the object, optional.

       Definition at line 186 of file desc.c.

   ssttrriinngg qquueerryy__ttyyppee (())
       The 'type' of this object. Sometimes used for special purposes (armour,
       players, etc).

       Definition at line 221 of file desc.c.

       Referenced by id().

   vvooiidd rreemmoovvee__aalltt__nnaammee ((ssttrriinngg ssttrr))
       Removes names from the list of alternative names. This is simply
       dropping items from the list.

       Definition at line 124 of file desc.c.

       References query_alt_name().

   vvooiidd sseett__aalltt__nnaammee ((ssttrriinngg ** ssttrr))
       (Optional) Sets an alternative name. If your object is a mercenary
       soldier, and the name is mercenary, you can set alt_name to soldier so
       that the MUDlib is able to identify this object under either
       description.

       You may also pass in an array of alternative names, such as ({
       'soldier', 'mercenary' }) and then all of them will be checked.

       Definition at line 87 of file desc.c.

   vvooiidd sseett__aalltt__pplluurraall ((ssttrriinngg ** ssttrr))
       Set the entire array of alt_plurals directly. If you pass in a string,
       it will become the only alt_plural.

       Definition at line 106 of file desc.c.

   vvooiidd sseett__ddiissttaanntt ((ssttrriinngg ssttrr))
       Sets the 'distant' description of an object. This is a short,
       undetailed description of an object. It must include an indefinite
       article, like 'a dog' or 'an orange,' unless the word makes no sense
       with an article, like 'Bob's sword'. The article should not be
       capitalized.

       Definition at line 49 of file desc.c.

       Referenced by Door::create().

   vvooiidd sseett__lloonngg ((ssttrriinngg ssttrr))
       Sets the long description of a room-style object. The long description
       is given to players or monsters who are inside the object when they
       look around.

       Definition at line 35 of file desc.c.

       Referenced by Bank::create().

   vvooiidd sseett__llooookk ((ssttrriinngg ssttrr))
       Sets the description you get when you look at an object. When a player
       looks at this object, they will get this description. For the
       description on the inside of the object, use set_long.

       Definition at line 28 of file desc.c.

       Referenced by Door::create().

   vvooiidd sseett__nnaammee ((ssttrriinngg ssttrr))
       Gives the object a name. This should be a short, simple name, usually
       one word, by which players and wizards can identify the object.

       Reimplemented in PPllaayyeerr.

       Definition at line 77 of file desc.c.

       References name.

       Referenced by Trinket::create(), Door::create(), Bank::create(), and
       Area::create().

   vvooiidd sseett__pplluurraall ((ssttrriinngg ssttrr))
       Sets the plural description of an object. This should be the plural
       form of the name of this object, so if the object is named 'soldier'
       this should be 'soldiers.'

       Definition at line 71 of file desc.c.

       Referenced by Door::create().

   vvooiidd sseett__sshhoorrtt ((ssttrriinngg ssttrr))
       Sets the short (or 'brief') description for a room-style object. Given
       as the title of a room when looking.

       Definition at line 41 of file desc.c.

       Referenced by Bank::create().

   vvooiidd sseett__ssppeecciiffiicc ((ssttrriinngg ssttrr))
       (Optional) Sets the specific description of an object. This is the same
       as set_distant, except that it uses the definite article -- 'the dog'
       or 'the orange'. You don't usually need to set this, as it will be
       generated automatically if you leave it blank. The article should not
       be capitalized, unless it is a proper name, like 'The Red Sword of
       Illinden.'

       Definition at line 59 of file desc.c.

       Referenced by Door::create().

   vvooiidd sseett__ttaassttee ((ssttrriinngg ssttrr))
       (Optional) Sets the taste of an object; used for the lick soul

       Definition at line 64 of file desc.c.

   vvooiidd sseett__ttyyppee ((ssttrriinngg ssttrr))
       (Optional) Sets the object's type. This is another string by which
       players may identify the object. Some objects which inherit this one
       give special meaning to this variable (armour type, player character
       type, etc).

       Definition at line 135 of file desc.c.

       Referenced by Player::set_testchar().

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 nnaammee
       The name of this object; generally just one word.

       Definition at line 16 of file desc.c.

       Referenced by Player::add_ignore(), Living::add_recognize(),
       World::create(), Maparea::create(), Mailmsg::create(),
       Player::display_file(), Player::enter_world(), Area::get_room_ob(),
       Player::load_self(), Player::make_bubble(),
       Player::make_path_absolute(), Player::on_paint(),
       Living::query_env_var(), Player::query_ignore(), World::query_name(),
       Player::query_path(), Player::query_real_name(),
       Living::query_recognize(), Player::remove_ignore(),
       Living::remove_recognize(), Living::reroll(), Player::restore_bubble(),
       Player::save_self(), Player::set_name(), set_name(),
       Player::valid_read(), and Player::valid_write().


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



Walraven                          8 Jan 2004                           Desc(3)
