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