d1323f0e4589aaaac4cf41292dcb56d7f7a4123f
[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 //                  https://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   struct XY touch_stop;
134   struct XY touch_pause;
135 };
136
137 struct GameSnapshotInfo
138 {
139   int mode;
140
141   byte last_action[MAX_PLAYERS];
142   boolean changed_action;
143   boolean collected_item;
144
145   boolean save_snapshot;
146 };
147
148 struct GameInfo
149 {
150   // values for control panel
151   struct GamePanelInfo panel;
152   struct GameButtonInfo button;
153
154   // values for graphics engine customization
155   int graphics_engine_version;
156   boolean use_native_emc_graphics_engine;
157   boolean use_native_sp_graphics_engine;
158   boolean use_masked_pushing;
159   int forced_scroll_delay_value;
160   int scroll_delay_value;
161   int tile_size;
162
163   // constant within running game
164   int engine_version;
165   int emulation;
166   int initial_move_delay[MAX_PLAYERS];
167   int initial_move_delay_value[MAX_PLAYERS];
168   int initial_push_delay_value;
169
170   // flag for single or multi-player mode (needed for playing tapes)
171   // (when playing/recording games, this is identical to "setup.team_mode"
172   boolean team_mode;
173
174   // flags to handle bugs in and changes between different engine versions
175   // (for the latest engine version, these flags should always be "FALSE")
176   boolean use_change_when_pushing_bug;
177   boolean use_block_last_field_bug;
178   boolean max_num_changes_per_frame;
179   boolean use_reverse_scan_direction;
180
181   // flags to indicate which game actions are used in this game
182   boolean use_key_actions;
183   boolean use_mouse_actions;
184
185   // variable within running game
186   int yamyam_content_nr;
187   boolean robot_wheel_active;
188   boolean magic_wall_active;
189   int magic_wall_time_left;
190   int light_time_left;
191   int timegate_time_left;
192   int belt_dir[4];
193   int belt_dir_nr[4];
194   int switchgate_pos;
195   int wind_direction;
196
197   boolean explosions_delayed;
198   boolean envelope_active;
199   boolean no_time_limit;        // (variable only in very special case)
200
201   int score;
202   int score_final;
203
204   int health;
205   int health_final;
206
207   int gems_still_needed;
208   int sokoban_fields_still_needed;
209   int sokoban_objects_still_needed;
210   int lights_still_needed;
211   int players_still_needed;
212   int friends_still_needed;
213
214   int robot_wheel_x, robot_wheel_y;
215   int exit_x, exit_y;
216
217   boolean all_players_gone;
218
219   // values for the new EMC elements
220   int lenses_time_left;
221   int magnify_time_left;
222   boolean ball_active;
223   int ball_content_nr;
224
225   // values for player idle animation (no effect on engine)
226   int player_boring_delay_fixed;
227   int player_boring_delay_random;
228   int player_sleeping_delay_fixed;
229   int player_sleeping_delay_random;
230
231   // values for special game initialization control
232   boolean restart_level;
233
234   // trigger message to ask for restarting the game
235   char *restart_game_message;
236
237   // values for special request dialog control
238   boolean request_active;
239   boolean request_active_or_moving;
240
241   // values for special game control
242   int centered_player_nr;
243   int centered_player_nr_next;
244   boolean set_centered_player;
245   boolean set_centered_player_wrap;
246
247   // values for single step mode control
248   boolean enter_single_step_mode;
249
250   // values for random number generator initialization after snapshot
251   unsigned int num_random_calls;
252
253   // values for game engine snapshot control
254   struct GameSnapshotInfo snapshot;
255
256   // values for handling states for solved level and game over
257   boolean LevelSolved;
258   boolean GamePlayed;
259   boolean GameOver;
260
261   boolean LevelSolved_GameWon;
262   boolean LevelSolved_GameEnd;
263   boolean LevelSolved_SaveTape;
264   boolean LevelSolved_SaveScore;
265
266   int LevelSolved_CountingTime;
267   int LevelSolved_CountingScore;
268   int LevelSolved_CountingHealth;
269 };
270
271 struct PlayerInfo
272 {
273   boolean present;              // player present in level playfield
274   boolean connected_locally;    // player connected (locally)
275   boolean connected_network;    // player connected (network)
276   boolean connected;            // player connected (locally or via network)
277   boolean active;               // player present and connected
278   boolean mapped;               // player already mapped to input device
279
280   boolean killed;               // player maybe present/active, but killed
281   boolean reanimated;           // player maybe killed, but reanimated
282   boolean buried;               // player finally killed and removed
283
284   int index_nr;                 // player number (0 to 3)
285   int index_bit;                // player number bit (1 << 0 to 1 << 3)
286   int element_nr;               // element (EL_PLAYER_1 to EL_PLAYER_4)
287   int client_nr;                // network client identifier
288
289   byte action;                  // action from local input device
290   byte effective_action;        /* action acknowledged from network server
291                                    or summarized over all configured input
292                                    devices when in single player mode */
293   byte programmed_action;       /* action forced by game itself (like moving
294                                    through doors); overrides other actions */
295   byte snap_action;             // action from TAS snap keys
296
297   struct MouseActionInfo mouse_action;           // (used by MM engine only)
298   struct MouseActionInfo effective_mouse_action; // (used by MM engine only)
299
300   int jx, jy, last_jx, last_jy;
301   int MovDir, MovPos, GfxDir, GfxPos;
302   int Frame, StepFrame;
303
304   int GfxAction;
305
306   int initial_element;          // EL_PLAYER_1 to EL_PLAYER_4 or EL_SP_MURPHY
307   int artwork_element;
308   boolean use_murphy;
309
310   boolean block_last_field;
311   int block_delay_adjustment;   // needed for different engine versions
312
313   boolean can_fall_into_acid;
314
315   boolean gravity;
316
317   int last_move_dir;
318
319   boolean is_active;
320
321   boolean is_waiting;
322   boolean is_moving;
323   boolean is_auto_moving;
324   boolean is_digging;
325   boolean is_snapping;
326   boolean is_collecting;
327   boolean is_pushing;
328   boolean is_switching;
329   boolean is_dropping;
330   boolean is_dropping_pressed;
331
332   boolean is_bored;
333   boolean is_sleeping;
334
335   boolean was_waiting;
336   boolean was_moving;
337   boolean was_snapping;
338   boolean was_dropping;
339
340   boolean cannot_move;
341
342   boolean force_dropping;       // needed for single step mode
343
344   int frame_counter_bored;
345   int frame_counter_sleeping;
346
347   int anim_delay_counter;
348   int post_delay_counter;
349
350   int dir_waiting;
351   int action_waiting, last_action_waiting;
352   int special_action_bored;
353   int special_action_sleeping;
354
355   int num_special_action_bored;
356   int num_special_action_sleeping;
357
358   int switch_x, switch_y;
359   int drop_x, drop_y;
360
361   int show_envelope;
362
363   int move_delay;
364   int move_delay_value;
365   int move_delay_value_next;
366   int move_delay_reset_counter;
367
368   int push_delay;
369   int push_delay_value;
370
371   unsigned int actual_frame_counter;
372
373   int drop_delay;
374   int drop_pressed_delay;
375
376   int step_counter;
377
378   int key[MAX_NUM_KEYS];
379   int num_white_keys;
380   int dynabomb_count, dynabomb_size, dynabombs_left, dynabomb_xl;
381   int shield_normal_time_left;
382   int shield_deadly_time_left;
383
384   int inventory_element[MAX_INVENTORY_SIZE];
385   int inventory_infinite_element;
386   int inventory_size;
387 };
388
389 extern struct GameInfo          game;
390 extern struct PlayerInfo        stored_player[MAX_PLAYERS], *local_player;
391
392
393 #ifdef DEBUG
394 void DEBUG_SetMaximumDynamite(void);
395 #endif
396
397 void GetPlayerConfig(void);
398 int GetElementFromGroupElement(int);
399
400 int getPlayerInventorySize(int);
401
402 void DrawGameValue_Time(int);
403 void DrawGameDoorValues(void);
404
405 void UpdateAndDisplayGameControlValues(void);
406
407 void InitGameSound(void);
408 void InitGame(void);
409
410 void UpdateEngineValues(int, int, int, int);
411 void GameWon(void);
412 void GameEnd(void);
413
414 void InitPlayerGfxAnimation(struct PlayerInfo *, int, int);
415 void Moving2Blocked(int, int, int *, int *);
416 void Blocked2Moving(int, int, int *, int *);
417 void DrawDynamite(int, int);
418
419 void StartGameActions(boolean, boolean, int);
420
421 void GameActions(void);
422 void GameActions_EM_Main(void);
423 void GameActions_SP_Main(void);
424 void GameActions_MM_Main(void);
425 void GameActions_RND_Main(void);
426 void GameActions_RND(void);
427
428 void ScrollLevel(int, int);
429
430 void InitPlayLevelSound(void);
431 void PlayLevelSound_EM(int, int, int, int);
432 void PlayLevelSound_SP(int, int, int, int);
433 void PlayLevelSound_MM(int, int, int, int);
434 void PlaySound_MM(int);
435 void PlaySoundLoop_MM(int);
436 void StopSound_MM(int);
437
438 void RaiseScore(int);
439 void RaiseScoreElement(int);
440
441 void RequestQuitGameExt(boolean, boolean, char *);
442 void RequestQuitGame(boolean);
443 void RequestRestartGame(char *);
444 void CheckGameOver(void);
445
446 boolean checkGameSolved(void);
447 boolean checkGameFailed(void);
448 boolean checkGameEnded(void);
449
450 unsigned int InitEngineRandom_RND(int);
451 unsigned int RND(int);
452
453 void FreeEngineSnapshotSingle(void);
454 void FreeEngineSnapshotList(void);
455 void LoadEngineSnapshotSingle(void);
456 void SaveEngineSnapshotSingle(void);
457 boolean CheckSaveEngineSnapshotToList(void);
458 void SaveEngineSnapshotToList(void);
459 void SaveEngineSnapshotToListInitial(void);
460 boolean CheckEngineSnapshotSingle(void);
461 boolean CheckEngineSnapshotList(void);
462
463 void CreateGameButtons(void);
464 void FreeGameButtons(void);
465 void MapUndoRedoButtons(void);
466 void UnmapUndoRedoButtons(void);
467 void ModifyPauseButtons(void);
468 void MapGameButtons(void);
469 void UnmapGameButtons(void);
470 void RedrawGameButtons(void);
471 void MapGameButtonsOnTape(void);
472 void UnmapGameButtonsOnTape(void);
473 void RedrawGameButtonsOnTape(void);
474
475 void HandleSoundButtonKeys(Key);
476
477 #endif