fixed unexpected behaviour with solving levels with Sokoban elements
[rocksndiamonds.git] / src / game.h
1 // ============================================================================
2 // Rocks'n'Diamonds - McDuffin Strikes Back!
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // game.h
10 // ============================================================================
11
12 #ifndef GAME_H
13 #define GAME_H
14
15 // (not included here due to collisions with Emerald Mine engine definitions)
16 // #include "main.h"
17
18 #define MAX_INVENTORY_SIZE              1000
19
20 #define MAX_HEALTH                      100
21
22 #define STD_NUM_KEYS                    4
23 #define MAX_NUM_KEYS                    8
24
25 #define NUM_BELTS                       4
26 #define NUM_BELT_PARTS                  3
27
28 #define NUM_PANEL_INVENTORY             8
29 #define NUM_PANEL_GRAPHICS              8
30 #define NUM_PANEL_ELEMENTS              8
31 #define NUM_PANEL_CE_SCORE              8
32
33 #define STR_SNAPSHOT_MODE_OFF           "off"
34 #define STR_SNAPSHOT_MODE_EVERY_STEP    "every_step"
35 #define STR_SNAPSHOT_MODE_EVERY_MOVE    "every_move"
36 #define STR_SNAPSHOT_MODE_EVERY_COLLECT "every_collect"
37 #define STR_SNAPSHOT_MODE_DEFAULT       STR_SNAPSHOT_MODE_OFF
38
39 #define SNAPSHOT_MODE_OFF               0
40 #define SNAPSHOT_MODE_EVERY_STEP        1
41 #define SNAPSHOT_MODE_EVERY_MOVE        2
42 #define SNAPSHOT_MODE_EVERY_COLLECT     3
43 #define SNAPSHOT_MODE_DEFAULT           SNAPSHOT_MODE_OFF
44
45
46 struct GamePanelInfo
47 {
48   struct TextPosInfo level_number;
49   struct TextPosInfo gems;
50   struct TextPosInfo inventory_count;
51   struct TextPosInfo inventory_first[NUM_PANEL_INVENTORY];
52   struct TextPosInfo inventory_last[NUM_PANEL_INVENTORY];
53   struct TextPosInfo key[MAX_NUM_KEYS];
54   struct TextPosInfo key_white;
55   struct TextPosInfo key_white_count;
56   struct TextPosInfo score;
57   struct TextPosInfo highscore;
58   struct TextPosInfo time;
59   struct TextPosInfo time_hh;
60   struct TextPosInfo time_mm;
61   struct TextPosInfo time_ss;
62   struct TextPosInfo time_anim;
63   struct TextPosInfo health;
64   struct TextPosInfo health_anim;
65   struct TextPosInfo frame;
66   struct TextPosInfo shield_normal;
67   struct TextPosInfo shield_normal_time;
68   struct TextPosInfo shield_deadly;
69   struct TextPosInfo shield_deadly_time;
70   struct TextPosInfo exit;
71   struct TextPosInfo emc_magic_ball;
72   struct TextPosInfo emc_magic_ball_switch;
73   struct TextPosInfo light_switch;
74   struct TextPosInfo light_switch_time;
75   struct TextPosInfo timegate_switch;
76   struct TextPosInfo timegate_switch_time;
77   struct TextPosInfo switchgate_switch;
78   struct TextPosInfo emc_lenses;
79   struct TextPosInfo emc_lenses_time;
80   struct TextPosInfo emc_magnifier;
81   struct TextPosInfo emc_magnifier_time;
82   struct TextPosInfo balloon_switch;
83   struct TextPosInfo dynabomb_number;
84   struct TextPosInfo dynabomb_size;
85   struct TextPosInfo dynabomb_power;
86   struct TextPosInfo penguins;
87   struct TextPosInfo sokoban_objects;
88   struct TextPosInfo sokoban_fields;
89   struct TextPosInfo robot_wheel;
90   struct TextPosInfo conveyor_belt[NUM_BELTS];
91   struct TextPosInfo conveyor_belt_switch[NUM_BELTS];
92   struct TextPosInfo magic_wall;
93   struct TextPosInfo magic_wall_time;
94   struct TextPosInfo gravity_state;
95   struct TextPosInfo graphic[NUM_PANEL_GRAPHICS];
96   struct TextPosInfo element[NUM_PANEL_ELEMENTS];
97   struct TextPosInfo element_count[NUM_PANEL_ELEMENTS];
98   struct TextPosInfo ce_score[NUM_PANEL_CE_SCORE];
99   struct TextPosInfo ce_score_element[NUM_PANEL_CE_SCORE];
100   struct TextPosInfo player_name;
101   struct TextPosInfo level_name;
102   struct TextPosInfo level_author;
103
104   // value to determine if panel will be updated or not
105   boolean active;
106 };
107
108 struct GameButtonInfo
109 {
110   struct XY stop;
111   struct XY pause;
112   struct XY play;
113
114   struct XY undo;
115   struct XY redo;
116
117   struct XY save;
118   struct XY pause2;
119   struct XY load;
120
121   struct XY sound_music;
122   struct XY sound_loops;
123   struct XY sound_simple;
124
125   struct XY panel_stop;
126   struct XY panel_pause;
127   struct XY panel_play;
128
129   struct XY panel_sound_music;
130   struct XY panel_sound_loops;
131   struct XY panel_sound_simple;
132 };
133
134 struct GameSnapshotInfo
135 {
136   int mode;
137
138   byte last_action[MAX_PLAYERS];
139   boolean changed_action;
140   boolean collected_item;
141
142   boolean save_snapshot;
143 };
144
145 struct GameInfo
146 {
147   // values for control panel
148   struct GamePanelInfo panel;
149   struct GameButtonInfo button;
150
151   // values for graphics engine customization
152   int graphics_engine_version;
153   boolean use_native_emc_graphics_engine;
154   boolean use_native_sp_graphics_engine;
155   boolean use_masked_pushing;
156   int forced_scroll_delay_value;
157   int scroll_delay_value;
158   int tile_size;
159
160   // constant within running game
161   int engine_version;
162   int emulation;
163   int initial_move_delay[MAX_PLAYERS];
164   int initial_move_delay_value[MAX_PLAYERS];
165   int initial_push_delay_value;
166
167   // flag for single or multi-player mode (needed for playing tapes)
168   // (when playing/recording games, this is identical to "setup.team_mode"
169   boolean team_mode;
170
171   // flags to handle bugs in and changes between different engine versions
172   // (for the latest engine version, these flags should always be "FALSE")
173   boolean use_change_when_pushing_bug;
174   boolean use_block_last_field_bug;
175   boolean max_num_changes_per_frame;
176   boolean use_reverse_scan_direction;
177
178   // variable within running game
179   int yamyam_content_nr;
180   boolean robot_wheel_active;
181   boolean magic_wall_active;
182   int magic_wall_time_left;
183   int light_time_left;
184   int timegate_time_left;
185   int belt_dir[4];
186   int belt_dir_nr[4];
187   int switchgate_pos;
188   int wind_direction;
189   boolean explosions_delayed;
190   boolean envelope_active;
191   boolean no_time_limit;        // (variable only in very special case)
192
193   // values for the new EMC elements
194   int lenses_time_left;
195   int magnify_time_left;
196   boolean ball_state;
197   int ball_content_nr;
198
199   // values for player idle animation (no effect on engine)
200   int player_boring_delay_fixed;
201   int player_boring_delay_random;
202   int player_sleeping_delay_fixed;
203   int player_sleeping_delay_random;
204
205   // values for special game initialization control
206   boolean restart_level;
207
208   // trigger message to ask for restarting the game
209   char *restart_game_message;
210
211   // values for special request dialog control
212   boolean request_active;
213
214   // values for special game control
215   int centered_player_nr;
216   int centered_player_nr_next;
217   boolean set_centered_player;
218
219   // values for random number generator initialization after snapshot
220   unsigned int num_random_calls;
221
222   // values for game engine snapshot control
223   struct GameSnapshotInfo snapshot;
224 };
225
226 struct PlayerInfo
227 {
228   boolean present;              // player present in level playfield
229   boolean connected_locally;    // player connected (locally)
230   boolean connected_network;    // player connected (network)
231   boolean connected;            // player connected (locally or via network)
232   boolean active;               // player present and connected
233   boolean mapped;               // player already mapped to input device
234
235   boolean killed;               // player maybe present/active, but killed
236   boolean reanimated;           // player maybe killed, but reanimated
237
238   int index_nr;                 // player number (0 to 3)
239   int index_bit;                // player number bit (1 << 0 to 1 << 3)
240   int element_nr;               // element (EL_PLAYER_1 to EL_PLAYER_4)
241   int client_nr;                // network client identifier
242
243   byte action;                  // action from local input device
244   byte mapped_action;           // action mapped from device to player
245   byte effective_action;        /* action acknowledged from network server
246                                    or summarized over all configured input
247                                    devices when in single player mode */
248   byte programmed_action;       /* action forced by game itself (like moving
249                                    through doors); overrides other actions */
250
251   struct MouseActionInfo mouse_action;           // (used by MM engine only)
252   struct MouseActionInfo effective_mouse_action; // (used by MM engine only)
253
254   int jx, jy, last_jx, last_jy;
255   int MovDir, MovPos, GfxDir, GfxPos;
256   int Frame, StepFrame;
257
258   int GfxAction;
259
260   int initial_element;          // EL_PLAYER_1 to EL_PLAYER_4 or EL_SP_MURPHY
261   int artwork_element;
262   boolean use_murphy;
263
264   boolean block_last_field;
265   int block_delay_adjustment;   // needed for different engine versions
266
267   boolean can_fall_into_acid;
268
269   boolean gravity;
270
271   boolean LevelSolved, GameOver;
272
273   boolean LevelSolved_GameWon;
274   boolean LevelSolved_GameEnd;
275   boolean LevelSolved_SaveTape;
276   boolean LevelSolved_SaveScore;
277
278   int LevelSolved_CountingTime;
279   int LevelSolved_CountingScore;
280   int LevelSolved_CountingHealth;
281
282   int last_move_dir;
283
284   boolean is_active;
285
286   boolean is_waiting;
287   boolean is_moving;
288   boolean is_auto_moving;
289   boolean is_digging;
290   boolean is_snapping;
291   boolean is_collecting;
292   boolean is_pushing;
293   boolean is_switching;
294   boolean is_dropping;
295   boolean is_dropping_pressed;
296
297   boolean is_bored;
298   boolean is_sleeping;
299
300   boolean was_waiting;
301   boolean was_moving;
302   boolean was_snapping;
303   boolean was_dropping;
304
305   boolean cannot_move;
306
307   boolean force_dropping;       // needed for single step mode
308
309   int frame_counter_bored;
310   int frame_counter_sleeping;
311
312   int anim_delay_counter;
313   int post_delay_counter;
314
315   int dir_waiting;
316   int action_waiting, last_action_waiting;
317   int special_action_bored;
318   int special_action_sleeping;
319
320   int num_special_action_bored;
321   int num_special_action_sleeping;
322
323   int switch_x, switch_y;
324   int drop_x, drop_y;
325
326   int show_envelope;
327
328   int move_delay;
329   int move_delay_value;
330   int move_delay_value_next;
331   int move_delay_reset_counter;
332
333   int push_delay;
334   int push_delay_value;
335
336   unsigned int actual_frame_counter;
337
338   int drop_delay;
339   int drop_pressed_delay;
340
341   int step_counter;
342
343   int score;
344   int score_final;
345
346   int health;
347   int health_final;
348
349   int gems_still_needed;
350   int sokoban_fields_still_needed;
351   int sokoban_objects_still_needed;
352   int lights_still_needed;
353   int players_still_needed;
354   int friends_still_needed;
355   int key[MAX_NUM_KEYS];
356   int num_white_keys;
357   int dynabomb_count, dynabomb_size, dynabombs_left, dynabomb_xl;
358   int shield_normal_time_left;
359   int shield_deadly_time_left;
360
361   int inventory_element[MAX_INVENTORY_SIZE];
362   int inventory_infinite_element;
363   int inventory_size;
364 };
365
366 extern struct GameInfo          game;
367 extern struct PlayerInfo        stored_player[MAX_PLAYERS], *local_player;
368
369
370 #ifdef DEBUG
371 void DEBUG_SetMaximumDynamite(void);
372 #endif
373
374 void GetPlayerConfig(void);
375 int GetElementFromGroupElement(int);
376
377 int getPlayerInventorySize(int);
378
379 void DrawGameValue_Time(int);
380 void DrawGameDoorValues(void);
381
382 void UpdateAndDisplayGameControlValues(void);
383
384 void InitGameSound(void);
385 void InitGame(void);
386
387 void UpdateEngineValues(int, int, int, int);
388 void GameWon(void);
389 void GameEnd(void);
390
391 void InitPlayerGfxAnimation(struct PlayerInfo *, int, int);
392 void Moving2Blocked(int, int, int *, int *);
393 void Blocked2Moving(int, int, int *, int *);
394 void DrawDynamite(int, int);
395
396 void StartGameActions(boolean, boolean, int);
397
398 void GameActions(void);
399 void GameActions_EM_Main(void);
400 void GameActions_SP_Main(void);
401 void GameActions_MM_Main(void);
402 void GameActions_RND_Main(void);
403 void GameActions_RND(void);
404
405 void ScrollLevel(int, int);
406
407 void InitPlayLevelSound(void);
408 void PlayLevelSound_EM(int, int, int, int);
409 void PlayLevelSound_SP(int, int, int, int);
410 void PlayLevelSound_MM(int, int, int, int);
411 void PlaySound_MM(int);
412 void PlaySoundLoop_MM(int);
413 void StopSound_MM(int);
414
415 void RaiseScore(int);
416 void RaiseScoreElement(int);
417
418 void RequestQuitGameExt(boolean, boolean, char *);
419 void RequestQuitGame(boolean);
420 void RequestRestartGame(char *);
421 void CheckGameOver(void);
422
423 boolean checkGameSolved(void);
424 boolean checkGameFailed(void);
425 boolean checkGameEnded(void);
426
427 unsigned int InitEngineRandom_RND(int);
428 unsigned int RND(int);
429
430 void FreeEngineSnapshotSingle(void);
431 void FreeEngineSnapshotList(void);
432 void LoadEngineSnapshotSingle(void);
433 void SaveEngineSnapshotSingle(void);
434 boolean CheckSaveEngineSnapshotToList(void);
435 void SaveEngineSnapshotToList(void);
436 void SaveEngineSnapshotToListInitial(void);
437 boolean CheckEngineSnapshotSingle(void);
438 boolean CheckEngineSnapshotList(void);
439
440 void CreateGameButtons(void);
441 void FreeGameButtons(void);
442 void MapUndoRedoButtons(void);
443 void UnmapUndoRedoButtons(void);
444 void MapGameButtons(void);
445 void UnmapGameButtons(void);
446 void RedrawGameButtons(void);
447 void MapGameButtonsOnTape(void);
448 void UnmapGameButtonsOnTape(void);
449 void RedrawGameButtonsOnTape(void);
450
451 void HandleSoundButtonKeys(Key);
452
453 #endif