home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / games / gamesuite / !Amnesia / AmsHelp / OverView < prev    next >
Text File  |  1995-01-29  |  3KB  |  81 lines

  1.  
  2. Amnesia - Version 1.10
  3. ======================
  4.  
  5. Overview
  6. --------
  7.  
  8. Amnesia is a module which is part of a set of modules designed to speed up
  9. the process of game writing.  At the basic level it provides memory
  10. management for the programmer where blocks of memory can be allocated,
  11. extended and released.  Amnesia also provides a structure for handling tables
  12. of objects.  An explanation follows later in this document.
  13.  
  14. The module may be used under the following conditions:
  15. ------------------------------------------------------
  16.  
  17. (1) The module may be freely included in commercial or non-commercial
  18. software with no liability for royalty payments.
  19.  
  20. (2) My copyright notice and contact address should not be removed from the
  21. module.
  22.  
  23. (3) The module is supplied as is, and no liabilty can be accepted for damage
  24. or loss resulting from the use or misuse of the software.
  25.  
  26. The Module
  27. ----------
  28.  
  29. Amnesia supplies a set of memory allocation routines which should serve for
  30. most purposes.  It also contains versatile object handling routines.  As far
  31. as Amnesia is concerned an object is a small chunk of memory, usually 40
  32. bytes or so.  An object is very general in Amnesia, but will usually have the
  33. following properties:
  34.  
  35. •  It will represent a sprite on the screen, be it a moving ball, a missile
  36. or bullet, the player, stars in the background, scrolling text etc.
  37.  
  38. •  The object will usually be plotted by the module FastSpr.
  39.  
  40. •  The object may perform a wide variety of actions.  It may move about, be
  41. animated, perform an action after a certain time, produce other objects etc.
  42.  
  43. •  It may be collision checked with a number of other objects.
  44.  
  45. A table is the space allocated for a number of objects.  All objects in the
  46. table are the same length, but they need not have the same properties.  For
  47. example, aliens and explosions could be in the same table.
  48.  
  49. Collision checking
  50. ------------------
  51.  
  52. The module will collision check objects as instructed by the user.  It has a
  53. notion of the size of an object (which it will deduce from the sprite file if
  54. necessary) and will usually check if the bounding boxes (rectangles which
  55. completely enclose the relevant sprite) overlap.  The objects are then
  56. pointed out to the user who can deal with them.
  57.  
  58. Coordinates
  59. -----------
  60.  
  61. The module uses the same coordinates as FastSpr, but shifted left 12 places
  62. (ie multiplied by 4096).  FastSpr uses memory-like coordinates.  The top left
  63. of the screen is (0,0), and the bottom right of a mode 13 screen would be
  64. (320,256).  Therefore to Amnesia the bottom right of the screen is
  65. (320<<12,256<<12).
  66.  
  67. Versatility
  68. -----------
  69.  
  70. All properties of an object can be disabled by the user.  The use of the
  71. first eight bytes of an object is fixed, but the rest is up to you.  If the
  72. features listed above are enabled, the module expects the first few words of
  73. an object to be in a standard form.
  74.  
  75. Support
  76. -------
  77.  
  78. Enquiries, bug reports and requests for help should be sent by post to Andy
  79. Southgate, at 14 Madingley Road, Cambridge until 10/95, and thereafter to 5
  80. Longview, Sutton, Cambs.
  81.