cleanup of unused SP engine declarations
[rocksndiamonds.git] / src / game_sp / export.h
1 #ifndef GAME_SP_EXPORT_H
2 #define GAME_SP_EXPORT_H
3
4 // ============================================================================
5 // functions and definitions exported from game_sp to main program
6 // ============================================================================
7
8 // ----------------------------------------------------------------------------
9 // constant definitions
10 // ----------------------------------------------------------------------------
11
12 #define SP_MAX_PLAYFIELD_WIDTH          MAX_PLAYFIELD_WIDTH
13 #define SP_MAX_PLAYFIELD_HEIGHT         MAX_PLAYFIELD_HEIGHT
14
15 #define SP_NUM_LEVELS_PER_PACKAGE       111
16
17 #define SP_STD_PLAYFIELD_WIDTH          60
18 #define SP_STD_PLAYFIELD_HEIGHT         24
19 #define SP_LEVEL_NAME_LEN               23
20 #define SP_MAX_SPECIAL_PORTS            10
21
22 #define SP_HEADER_SIZE                  96
23 #define SP_STD_PLAYFIELD_SIZE           (SP_STD_PLAYFIELD_WIDTH *       \
24                                          SP_STD_PLAYFIELD_HEIGHT)
25 #define SP_MAX_PLAYFIELD_SIZE           (SP_MAX_PLAYFIELD_WIDTH *       \
26                                          SP_MAX_PLAYFIELD_HEIGHT)
27 #define SP_STD_LEVEL_SIZE               (SP_HEADER_SIZE + SP_STD_PLAYFIELD_SIZE)
28
29 #define SP_FRAMES_PER_SECOND            35
30
31 // use a much higher value to be able to load ultra-long MPX demo files
32 // (like for level collection 78, level 88 ("WAITING FOR GODOT AGAIN"))
33 // #define SP_MAX_TAPE_LEN                      500000
34 #define SP_MAX_TAPE_LEN                 64010   // (see "spfix63.doc")
35
36
37 // sound actions
38
39 #define actActive                       0
40 #define actImpact                       1
41 #define actExploding                    2
42 #define actDigging                      3
43 #define actSnapping                     4
44 #define actCollecting                   5
45 #define actPassing                      6
46 #define actPushing                      7
47 #define actDropping                     8
48
49
50 // ----------------------------------------------------------------------------
51 // data structure definitions
52 // ----------------------------------------------------------------------------
53
54 #ifndef HAS_SpecialPortType
55 typedef struct
56 {
57   short PortLocation; // = 2*(x+(y*60))         // big endian format
58   byte Gravity; // 1 = turn on, anything else (0) = turn off
59   byte FreezeZonks; // 2 = turn on, anything else (0) = turn off  (1=off!)
60   byte FreezeEnemies; // 1 = turn on, anything else (0) = turn off
61   byte UnUsed;
62 } SpecialPortType;
63 #define HAS_SpecialPortType
64 #endif
65
66 #ifndef HAS_LevelInfoType
67 typedef struct
68 {
69   byte UnUsed[4];
70   byte InitialGravity; // 1=on, anything else (0) = off
71   byte Version; // SpeedFixVersion XOR &H20
72   char LevelTitle[23];
73   byte InitialFreezeZonks; // 2=on, anything else (0) = off.  (1=off too!)
74   byte InfotronsNeeded;
75
76   // Number of Infotrons needed. 0 means that Supaplex will count the total
77   // amount of Infotrons in the level, and use the low byte of that number.
78   // (A multiple of 256 Infotrons will then result in 0-to-eat, etc.!)
79   byte SpecialPortCount; // Maximum 10 allowed!
80   SpecialPortType SpecialPort[10];
81   byte SpeedByte; // = Speed XOR Highbyte(RandomSeed)
82   byte CheckSumByte; // = CheckSum XOR SpeedByte
83   short DemoRandomSeed;                         // little endian format
84 } LevelInfoType;
85 #define HAS_LevelInfoType
86 #endif
87
88 struct GameInfo_SP
89 {
90   boolean level_solved;
91   boolean game_over;
92
93   // needed for updating panel
94   int time_played;
95   int infotrons_still_needed;
96   int red_disk_count;
97   int score;
98
99   // needed for engine snapshots
100   char **preceding_buffer;
101   int preceding_buffer_size;
102
103   int scroll_xoffset, scroll_yoffset;
104 };
105
106 struct DemoInfo_SP
107 {
108   boolean is_available;         // structure contains valid demo
109
110   int level_nr;                 // number of corresponding level
111
112   int length;                   // number of demo entries
113   byte data[SP_MAX_TAPE_LEN];   // array of demo entries
114 };
115
116 struct LevelInfo_SP
117 {
118   LevelInfoType header;
119   byte header_raw_bytes[SP_HEADER_SIZE];
120
121   int width, height;
122
123   byte playfield[SP_MAX_PLAYFIELD_WIDTH][SP_MAX_PLAYFIELD_HEIGHT];
124
125   struct DemoInfo_SP demo;
126
127   // used for runtime values
128   struct GameInfo_SP *game_sp;
129 };
130
131 struct GraphicInfo_SP
132 {
133   Bitmap *bitmap;
134   int src_x, src_y;
135   int src_offset_x, src_offset_y;
136   int dst_offset_x, dst_offset_y;
137   int width, height;
138
139   Bitmap *crumbled_bitmap;
140   int crumbled_src_x, crumbled_src_y;
141   int crumbled_border_size;
142
143   boolean has_crumbled_graphics;
144   boolean preserve_background;
145
146   int unique_identifier;        // used to identify needed screen updates
147 };
148
149 struct EngineSnapshotInfo_SP
150 {
151   struct GameInfo_SP game_sp;
152
153   int PlayField16[SP_MAX_PLAYFIELD_SIZE + SP_HEADER_SIZE];
154   byte PlayField8[SP_MAX_PLAYFIELD_SIZE + SP_HEADER_SIZE];
155   byte DisPlayField[SP_MAX_PLAYFIELD_SIZE + SP_HEADER_SIZE];
156
157   int AnimationPosTable[SP_MAX_PLAYFIELD_SIZE];
158   byte AnimationSubTable[SP_MAX_PLAYFIELD_SIZE];
159   byte TerminalState[SP_MAX_PLAYFIELD_SIZE + SP_HEADER_SIZE];
160 };
161
162
163 // ----------------------------------------------------------------------------
164 // exported functions
165 // ----------------------------------------------------------------------------
166
167 extern struct GameInfo_SP game_sp;
168 extern struct LevelInfo_SP native_sp_level;
169 extern struct EngineSnapshotInfo_SP engine_snapshot_sp;
170
171 void sp_open_all(void);
172 void sp_close_all(void);
173
174 void InitPrecedingPlayfieldMemory(void);
175 void InitGfxBuffers_SP(void);
176
177 void InitGameEngine_SP(void);
178 void GameActions_SP(byte *, boolean);
179
180 unsigned int InitEngineRandom_SP(int);
181
182 void setLevelInfoToDefaults_SP(void);
183 void copyInternalEngineVars_SP(void);
184 boolean LoadNativeLevel_SP(char *, int, boolean);
185 void SaveNativeLevel_SP(char *);
186
187 int getFieldbufferOffsetX_SP(void);
188 int getFieldbufferOffsetY_SP(void);
189
190 void BlitScreenToBitmap_SP(Bitmap *);
191 void RedrawPlayfield_SP(boolean);
192
193 void LoadEngineSnapshotValues_SP(void);
194 void SaveEngineSnapshotValues_SP(ListNode **);
195
196 int map_key_RND_to_SP(int);
197 int map_key_SP_to_RND(int);
198
199 int getRedDiskReleaseFlag_SP(void);
200
201 #endif  // GAME_SP_EXPORT_H