home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / evntshell / Docs / Sprites < prev    next >
Encoding:
Text File  |  1995-03-12  |  2.1 KB  |  89 lines
  1. --------------------------------------------------------
  2.  
  3. FNshell_SpriteAreaLoad()
  4. Params =>
  5.          str file name of sprite file
  6.        <=
  7.          int address of loaded file 
  8.  
  9. --------------------------------------------------------
  10.  
  11. PROCshell_SpriteAreaSave()
  12. Params =>
  13.          int address of spritearea (as returned
  14.              by FNshell_SpriteAreaLoad>
  15.          str file name
  16.  
  17. --------------------------------------------------------
  18.  
  19. FNshell_UserSpritesBase
  20. Params =>
  21.          None
  22.  
  23.        <=
  24.          int address that user sprite file has
  25.              been loaded at
  26.              
  27. --------------------------------------------------------
  28. FNshell_SpriteGetPtr()
  29. Params =>
  30.          int address of spritearea (as returned
  31.              by FNshell_SpriteAreaLoad>
  32.          str name of sprite
  33.        <=
  34.          int pointer to sprite
  35.  
  36. This call is used to get a pointer to a sprite
  37. that can be passed to other routines. 
  38.  
  39. --------------------------------------------------------
  40.  
  41. PROCshell_SpriteRename()
  42. Params =>
  43.          int address of spritearea (as returned
  44.              by FNshell_SpriteAreaLoad
  45.          str old name of sprite
  46.          str new name of sprite
  47.  
  48. --------------------------------------------------------
  49.  
  50. FNshell_SpriteExists
  51. Params =>
  52.          int  address of spritearea (1 for wimp
  53.               pool, FNshell_UserSpritesBase for
  54.               user area)
  55.          str  sprite name
  56.  
  57.        <=
  58.          bool  TRUE or FALSE
  59.  
  60. It is probably better to use the two associated
  61. calls FNshell_SpriteExistsInWimpPool and
  62. FNshell_SpriteExistsInUserArea as it makes it
  63. more obvious what the call is doing.
  64.  
  65. --------------------------------------------------------
  66.  
  67. FNshell_SpriteExistsInWimpPool
  68. Params =>
  69.          str  sprite name
  70.  
  71.        <=
  72.          bool  TRUE or FALSE
  73.  
  74. Effectively checks whether the sprite has been
  75. defined in the !Sprites/!Sprites22 file.
  76.  
  77. --------------------------------------------------------
  78.  
  79. FNshell_SpriteExistsInUserArea
  80. Params =>
  81.          str  sprite name
  82.  
  83.        <=
  84.          bool  TRUE or FALSE
  85.  
  86. Effectively checks whether the sprite has been
  87. defined in the Sprites/Sprites22 file.
  88.  
  89. --------------------------------------------------------