Coord(3)                                                              Coord(3)



NNAAMMEE
       Coord -

SSYYNNOOPPSSIISS
       Inherited by MMaapp__ppaaiinntt, MMaapprroooomm, and SScceenneerryy.


   PPuubblliicc MMeetthhooddss
       int qquueerryy__ccoooorrdd ()
       void sseett__ccoooorrdd (int i)
       int qquueerryy__xx ()
       int qquueerryy__yy ()
       int qquueerryy__zz ()
       void sseett__xx (int i)
       void sseett__yy (int i)
       void sseett__zz (int i)
       varargs int qquueerryy__aaddjjaacceenntt (mixed x, int y)

   PPuubblliicc AAttttrriibbuutteess
       int ccoooorrdd

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       Inherit this component if your object needs to have coordinates.

       There are two major coordinate systems in the game. The large, global
       one is 'world coordinates', and the smaller local one is 'room
       coordinates'. Both of these coordinate systems have x, y, and z
       components, meaning they are three dimensional. This object is unable
       to distinguish whether it is representing world or room coordinates.

       The world is divided into a 8192x8192x64 grid, and each room is
       assigned one or more positions on that grid. This allows for the MUD to
       reason spatially, which is often important. Each room has a 5x3x1 'sub-
       grid' within each cell that it owns, so a 2x2x1 (world coordinates)
       room has a 10x6x1 interior. If an object is in a room, it naturally has
       the same world coordinates as whatever cell it is in.

       Definition at line 20 of file coord.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vaarraarrggss iinntt qquueerryy__aaddjjaacceenntt ((mmiixxeedd xx,, iinntt yy))
       RReettuurrnnss::
           1 if

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

       _o_b_j    or (an object at x,y) is adjacent to this object

       Definition at line 85 of file coord.c.

       References query_x(), and query_y().

   iinntt qquueerryy__ccoooorrdd (())
       RReettuurrnnss::
           The coded coordinate (32 bits -- z:6 y:13 x:13, from MSB to LSB in
           that order).

       Definition at line 27 of file coord.c.

       References coord.

       Referenced by Door::exit_shape(), Maproom::query_room_desc(),
       query_x(), query_y(), and query_z().

   iinntt qquueerryy__xx (())
       RReettuurrnnss::
           The x coordinate of this object, measuring distance from the
           westmost point (coordinates increase left to right). If the object
           is wider than one unit, this is the leftmost unit of the object.

       Definition at line 47 of file coord.c.

       References query_coord().

       Referenced by Map_paint::paint_map(), query_adjacent(), and
       Maproom::query_fertile().

   iinntt qquueerryy__yy (())
       RReettuurrnnss::
           The y coordinate of this object, measured from the northmost point
           (coordinates increase from far to near, or north to south). If the
           object is deeper than one unit, this is the northernmost unit of
           the object.

       Definition at line 56 of file coord.c.

       References query_coord().

       Referenced by Map_paint::paint_map(), query_adjacent(), and
       Maproom::query_fertile().

   iinntt qquueerryy__zz (())
       RReettuurrnnss::
           The z coordinate of this object, measured from the bottom most
           point (coordinates increase bottom to top). If the object is
           thicker than one unit, this is the bottommost unit.

       Definition at line 65 of file coord.c.

       References query_coord().

       Referenced by Maproom::query_fertile().

   vvooiidd sseett__ccoooorrdd ((iinntt ii))
       Allows you to set the world coordinate with a single call. You do the
       encoding yourself.

       Definition at line 39 of file coord.c.

       References coord.

       Referenced by set_x(), set_y(), and set_z().

   vvooiidd sseett__xx ((iinntt ii))
       Sets the world x coordinate. Values can range from 0-8191. Higher
       values will be wrapped (i.e. 8192->0).

       Definition at line 70 of file coord.c.

       References coord, and set_coord().

   vvooiidd sseett__yy ((iinntt ii))
       Sets the world y coordinate. Values can range from 0-8191. Higher
       values will be wrapped (i.e. 8192->0).

       Definition at line 75 of file coord.c.

       References coord, and set_coord().

   vvooiidd sseett__zz ((iinntt ii))
       Sets the world z coordinate. Values can range from 0-63. Higher values
       will be wrapped (i.e. 64->0).

       Definition at line 80 of file coord.c.

       References coord, and set_coord().

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
   iinntt ccoooorrdd
       The coordinate of this object.

       Definition at line 24 of file coord.c.

       Referenced by Door::exit_shape(), Maproom::id(), query_coord(),
       Maproom::query_fertile(), set_coord(), set_x(), set_y(), and set_z().


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



Walraven                          8 Jan 2004                          Coord(3)
