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