main/effects.h

   1 /* $Id: effects.h,v 1.5 2004-08-28 23:17:45 schaffner Exp $ */
   2 /*
   3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
   4 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
   5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
   6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
   7 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
   8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
   9 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
  10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
  11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
  12 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
  13 */
  14
  15 /*
  16  *
  17  * Headerfile for effects.c
  18  *
  19  */
  20
  21
  22 #ifndef _EFFECTS_H
  23 #define _EFFECTS_H
  24
  25 #include "vclip.h"
  26
  27 #define MAX_EFFECTS 110
  28
  29 //flags for eclips.  If no flags are set, always plays
  30
  31 #define EF_CRITICAL 1   //this doesn't get played directly (only when mine critical)
  32 #define EF_ONE_SHOT 2   //this is a special that gets played once
  33 #define EF_STOPPED  4   //this has been stopped
  34
  35 typedef struct eclip {
  36         vclip   vc;             //imbedded vclip
  37         fix     time_left;      //for sequencing
  38         int     frame_count;    //for sequencing
  39         short   changing_wall_texture;      //Which element of Textures array to replace.
  40         short   changing_object_texture;    //Which element of ObjBitmapPtrs array to replace.
  41         int     flags;          //see above
  42         int     crit_clip;      //use this clip instead of above one when mine critical
  43         int     dest_bm_num;    //use this bitmap when monitor destroyed
  44         int     dest_vclip;     //what vclip to play when exploding
  45         int     dest_eclip;     //what eclip to play when exploding
  46         fix     dest_size;      //3d size of explosion
  47         int     sound_num;      //what sound this makes
  48         int     segnum,sidenum; //what seg & side, for one-shot clips
  49 } __pack__ eclip;
  50
  51 extern int Num_effects;
  52 extern eclip Effects[MAX_EFFECTS];
  53
  54 // Set up special effects.
  55 extern void init_special_effects();
  56
  57 // Clear any active one-shots
  58 void reset_special_effects();
  59
  60 // Function called in game loop to do effects.
  61 extern void do_special_effects();
  62
  63 // Restore bitmap
  64 extern void restore_effect_bitmap_icons();
  65
  66 //stop an effect from animating.  Show first frame.
  67 void stop_effect(int effect_num);
  68
  69 //restart a stopped effect
  70 void restart_effect(int effect_num);
  71
  72 #ifdef FAST_FILE_IO
  73 #define eclip_read_n(ec, n, fp) cfread(ec, sizeof(eclip), n, fp)
  74 #else
  75 /*
  76  * reads n eclip structs from a CFILE
  77  */
  78 extern int eclip_read_n(eclip *ec, int n, CFILE *fp);
  79 #endif
  80
  81 #endif /* _EFFECTS_H */