2 * Copyright (c) 2007, 2008, 2009, Czirkos Zoltan <cirix@fw.hu>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 #include "bd_elements.h"
27 typedef guint32 GdColor;
32 1 for c64 colors (bb=index)
33 3 for c64dtv (bb=index)
34 2 for atari colors (bb=index)
37 typedef enum _color_type
39 GD_COLOR_TYPE_RGB = 0,
40 GD_COLOR_TYPE_C64 = 1,
41 GD_COLOR_TYPE_C64DTV = 2,
42 GD_COLOR_TYPE_ATARI = 3,
44 GD_COLOR_TYPE_UNKNOWN /* should be the last one */
47 /* traditional c64 color indexes. */
48 #define GD_COLOR_INDEX_BLACK (0)
49 #define GD_COLOR_INDEX_WHITE (1)
50 #define GD_COLOR_INDEX_RED (2)
51 #define GD_COLOR_INDEX_CYAN (3)
52 #define GD_COLOR_INDEX_PURPLE (4)
53 #define GD_COLOR_INDEX_GREEN (5)
54 #define GD_COLOR_INDEX_BLUE (6)
55 #define GD_COLOR_INDEX_YELLOW (7)
56 #define GD_COLOR_INDEX_ORANGE (8)
57 #define GD_COLOR_INDEX_BROWN (9)
58 #define GD_COLOR_INDEX_LIGHTRED (10)
59 #define GD_COLOR_INDEX_GRAY1 (11)
60 #define GD_COLOR_INDEX_GRAY2 (12)
61 #define GD_COLOR_INDEX_LIGHTGREEN (13)
62 #define GD_COLOR_INDEX_LIGHTBLUE (14)
63 #define GD_COLOR_INDEX_GRAY3 (15)
65 #define GD_GDASH_BLACK (0x000000)
66 #define GD_GDASH_WHITE (0xFFFFFF)
67 #define GD_GDASH_RED (0x880000)
68 #define GD_GDASH_CYAN (0xAAFFEE)
69 #define GD_GDASH_PURPLE (0xCC44CC)
70 #define GD_GDASH_GREEN (0x00CC55)
71 #define GD_GDASH_BLUE (0x0000AA)
72 #define GD_GDASH_YELLOW (0xEEEE77)
73 #define GD_GDASH_ORANGE (0xDD8855)
74 #define GD_GDASH_BROWN (0x664400)
75 #define GD_GDASH_LIGHTRED (0xFF7777)
76 #define GD_GDASH_GRAY1 (0x333333)
77 #define GD_GDASH_GRAY2 (0x777777)
78 #define GD_GDASH_LIGHTGREEN (0xAAFF66)
79 #define GD_GDASH_LIGHTBLUE (0x0088FF)
80 #define GD_GDASH_GRAY3 (0xBBBBBB)
82 #define GD_COLOR_INVALID (0xFFFFFFFF)
85 /******************************************
91 /* possible types handled */
94 /* not real types, only used by editor to build ui */
99 GD_TYPE_STRING, /* static string, fixed array of characters */
100 GD_TYPE_LONGSTRING, /* long string which has its own notebook page in
106 GD_TYPE_PROBABILITY, /* probabilities are stored in parts per million,
107 ie. *1E6, converted to int. */
114 enum _gd_property_flags
116 GD_ALWAYS_SAVE = 1 << 0,
117 GD_DONT_SAVE = 1 << 1,
118 GD_DONT_SHOW_IN_EDITOR = 1 << 2,
119 GD_SHOW_LEVEL_LABEL = 1 << 3,
120 GD_COMPATIBILITY_SETTING = 1 << 4,
123 typedef struct _gd_struct_descriptor
125 char *identifier; /* bdcff identifier */
126 GdType type; /* data type */
127 int flags; /* flags for bdcff saving/loading */
128 char *name; /* name in editor */
129 int offset; /* byte offset in a GdCave structure. use the CAVE_OFFSET macro */
130 int count; /* size of array; usually 1, for non-arrays. */
131 char *tooltip; /* tooltip text in editor */
132 int min, max; /* integers have minimum and maximum */
133 } GdStructDescriptor;
135 typedef struct _gd_property_default
137 int offset; /* data offset (bytes) in a cave structure */
138 int defval; /* default value, converted to int. if type is a float, *1000000 */
140 int property_index; /* index in gd_cave_properties; created at runtime */
144 void gd_struct_set_defaults_from_array(gpointer str, const GdStructDescriptor *properties, GdPropertyDefault *defaults);
146 /* these define the number of the cells in the png file */
147 #define GD_NUM_OF_CELLS_X 8
148 #define GD_NUM_OF_CELLS_Y 46
150 /* +80: placeholder for cells which are rendered by the game;
151 for example diamond + arrow = falling diamond */
152 #define GD_NUM_OF_CELLS (GD_NUM_OF_CELLS_X*GD_NUM_OF_CELLS_Y+80)
154 extern const GdColor gd_flash_color;
155 extern const GdColor gd_select_color;
157 enum _element_property
159 E_P_SLOPED_LEFT, /* stones and diamonds roll down to left on this */
160 E_P_SLOPED_RIGHT, /* stones and diamonds roll down to right on this */
163 E_P_BLADDER_SLOPED, /* element act sloped also for the bladder */
165 E_P_AMOEBA_CONSUMES, /* amoeba can eat this */
166 E_P_DIRT, /* it is dirt, or something similar (dirt2 or sloped dirt) */
167 E_P_BLOWS_UP_FLIES, /* flies blow up, if they touch this */
168 E_P_EXPLODES_BY_HIT, /* explodes if hit by a stone */
170 E_P_EXPLOSION, /* set for every stage of every explosion. */
171 E_P_EXPLOSION_FIRST_STAGE, /* set for first stage of every explosion.
172 helps slower/faster explosions changing */
174 E_P_NON_EXPLODABLE, /* selfexplaining */
175 E_P_CCW, /* this creature has a default counterclockwise
176 rotation (for example, o_fire_1) */
177 E_P_CAN_BE_HAMMERED, /* can be broken by pneumatic hammer */
178 E_P_VISUAL_EFFECT, /* if the element can use a visual effect.
179 used to check consistency of the code */
180 E_P_PLAYER, /* easier to find out if it is a player element */
181 E_P_MOVED_BY_CONVEYOR_TOP, /* can be moved by conveyor belt */
182 E_P_MOVED_BY_CONVEYOR_BOTTOM, /* can be moved UNDER the conveyor belt */
184 E_P_COLLECTIBLE, /* can be collected */
188 #define P_SLOPED_LEFT (1 << E_P_SLOPED_LEFT)
189 #define P_SLOPED_RIGHT (1 << E_P_SLOPED_RIGHT)
190 #define P_SLOPED_UP (1 << E_P_SLOPED_UP)
191 #define P_SLOPED_DOWN (1 << E_P_SLOPED_DOWN)
193 /* flag to say "any direction" */
194 #define P_SLOPED (P_SLOPED_LEFT | \
199 #define P_BLADDER_SLOPED (1 << E_P_BLADDER_SLOPED)
201 #define P_AMOEBA_CONSUMES (1 << E_P_AMOEBA_CONSUMES)
202 #define P_DIRT (1 << E_P_DIRT)
203 #define P_BLOWS_UP_FLIES (1 << E_P_BLOWS_UP_FLIES)
205 #define P_EXPLODES_BY_HIT (1 << E_P_EXPLODES_BY_HIT)
206 #define P_EXPLOSION (1 << E_P_EXPLOSION)
207 #define P_EXPLOSION_FIRST_STAGE (1 << E_P_EXPLOSION_FIRST_STAGE)
209 #define P_NON_EXPLODABLE (1 << E_P_NON_EXPLODABLE)
210 #define P_CCW (1 << E_P_CCW)
211 #define P_CAN_BE_HAMMERED (1 << E_P_CAN_BE_HAMMERED)
212 #define P_VISUAL_EFFECT (1 << E_P_VISUAL_EFFECT)
213 #define P_PLAYER (1 << E_P_PLAYER)
214 #define P_MOVED_BY_CONVEYOR_TOP (1 << E_P_MOVED_BY_CONVEYOR_TOP)
215 #define P_MOVED_BY_CONVEYOR_BOTTOM (1 << E_P_MOVED_BY_CONVEYOR_BOTTOM)
217 #define P_COLLECTIBLE (1 << E_P_COLLECTIBLE)
219 /* These are states of the magic wall. */
220 typedef enum _magic_wall_state
222 GD_MW_DORMANT, /* Starting with this. */
223 GD_MW_ACTIVE, /* Boulder or diamond dropped into. */
224 GD_MW_EXPIRED /* Turned off after magic_wall_milling_time. */
227 /* These are states of Player. */
228 typedef enum _player_state
230 GD_PL_NOT_YET, /* Not yet living. Beginning of cave time. */
231 GD_PL_LIVING, /* Ok. */
232 GD_PL_TIMEOUT, /* Time is up */
233 GD_PL_DIED, /* Died. */
234 GD_PL_EXITED /* Exited the cave, proceed to next one */
237 /* States of amoeba */
238 typedef enum _amoeba_state
240 GD_AM_SLEEPING, /* sleeping - not yet let out. */
241 GD_AM_AWAKE, /* living, growing */
242 GD_AM_TOO_BIG, /* grown too big, will convert to stones */
243 GD_AM_ENCLOSED, /* enclosed, will convert to diamonds */
246 typedef enum _direction
256 GD_MV_DOWN_RIGHT = 4,
262 /* to be able to type GD_MV_TWICE + GD_MV_DOWN, for example */
267 GD_MV_UP_RIGHT_2 = 10,
269 GD_MV_DOWN_RIGHT_2 = 12,
271 GD_MV_DOWN_LEFT_2 = 14,
273 GD_MV_UP_LEFT_2 = 16,
280 GD_REPLAY_MOVE_MASK = 0x0f,
281 GD_REPLAY_FIRE_MASK = 0x10,
282 GD_REPLAY_SUICIDE_MASK = 0x20,
286 /* ELEMENTS DESCRIPTION */
287 typedef struct _elements
289 GdElement element; /* element number. for example O_DIRT */
290 char *name; /* name in editor, for example "Dirt". some have
291 different names than their real engine meaning! */
292 unsigned int properties; /* engine properties, like P_SLOPED or P_EXPLODES */
293 char *filename; /* name in bdcff file, like "DIRT" */
294 char character; /* character representation in bdcff file, like '.' */
295 int image; /* image in editor (index in cells.png) */
296 int image_simple; /* image for simple view in editor, and for combo box (index in cells.png) */
297 int image_game; /* image for game. negative if animated */
298 int ckdelay; /* ckdelay ratio - how much time required for a c64 to
299 process this element - in microseconds. */
301 char *lowercase_name; /* lowercase of translated name. for editor; generated inside the game. */
302 char character_new; /* character given automatically for elements which
303 don't have one defined in original bdcff description */
307 typedef char GdString[128];
309 typedef struct _highscore
315 /* maximum seed value for the cave random generator. should be smaller than a signed int. */
316 #define GD_CAVE_SEED_MAX (1 << 30)
318 typedef struct _gd_cave_replay
320 int level; /* replay for level n */
321 guint32 seed; /* seed the cave is to be rendered with */
322 boolean saved; /* also store it in the saved bdcff */
323 GdString recorded_with; /* recorded with - application name and version */
325 GdString player_name; /* who played this */
326 GdString date; /* when played */
327 char *comment; /* some comments from the player */
329 int score; /* score collected */
330 int duration; /* number of seconds played */
331 boolean success; /* successful playing of cave? */
332 guint32 checksum; /* checksum of the rendered cave. */
334 boolean wrong_checksum;
335 GByteArray *movements;
336 int current_playing_pos;
339 typedef enum _gd_scheduling
341 GD_SCHEDULING_MILLISECONDS,
346 GD_SCHEDULING_BD1_ATARI,
347 GD_SCHEDULING_BD2_PLCK_ATARI,
351 typedef struct _gd_c64_random_generator
353 int rand_seed_1, rand_seed_2;
354 } GdC64RandomGenerator;
357 Structure holding all data belonging to a cave.
360 #define GD_HIGHSCORE_NUM 20
362 typedef struct _gd_cave
364 /* Defined by the editor. public data :) */
365 GdString name; /* Name of cave */
366 GdString description; /* Some words about the cave */
367 GdString author; /* Author */
368 GdString difficulty; /* difficulty of the game, for info purposes */
369 GdString www; /* link to author's webpage */
370 GdString date; /* date of creation */
371 char *story; /* story for the cave - will be shown when the cave is played. */
372 char *remark; /* some note */
374 GdString charset; /* these are not used by gdash */
377 /* and this one the highscores */
378 GdHighScore highscore[GD_HIGHSCORE_NUM];
380 GHashTable *tags; /* stores read-but-not-understood strings from bdcff, so we can save them later. */
382 GdElement **map; /* pointer to data for map, non-null if has a map */
386 boolean intermission; /* is this cave an intermission? */
387 boolean intermission_instantlife; /* one life extra, if the intermission is reached */
388 boolean intermission_rewardlife; /* one life extra, if the intermission is successfully finished */
389 boolean selectable; /* is this selectable as an initial cave for a game? */
390 boolean diagonal_movements; /* are diagonal movements allowed? */
391 GdElement snap_element; /* snapping (press fire+move) usually leaves space behind, but can be other */
392 boolean short_explosions; /* in >=1stb, diamond and creature explosions were of 5 stages */
394 GdScheduling scheduling; /* scheduling type; see above */
395 boolean pal_timing; /* use faster seconds */
397 boolean active_is_first_found; /* active player is the uppermost. */
398 boolean lineshift; /* true is line shifting emulation, false is perfect borders emulation */
399 boolean border_scan_first_and_last; /* if true, scans the first and last line of the border. false for plck */
400 boolean wraparound_objects; /* if this is true, object drawing (cave rendering) will wraparound as well. */
402 GdElement initial_fill;
403 GdElement initial_border;
404 GdElement random_fill[4]; /* Random fill elements. */
405 int random_fill_probability[4]; /* Random fill, probability of each element. */
407 int level_rand[5]; /* Random seed. */
408 int level_diamonds[5]; /* Must collect diamonds, on level x */
409 int level_speed[5]; /* Time between game cycles in ms */
410 int level_ckdelay[5]; /* Timing in original game units */
411 int level_time[5]; /* Available time, per level */
412 int level_timevalue[5]; /* points for each second remaining, when exiting level */
414 int max_time; /* the maximum time in seconds. if above, it overflows */
416 int w, h; /* Sizes of cave, width and height. */
417 int x1,y1,x2,y2; /* Visible part of the cave */
418 GdColor colorb; /* border color */
419 GdColor color0, color1, color2, color3, color4, color5; /* c64-style colors; 4 and 5 are amoeba and slime. */
421 int diamond_value; /* Score for a diamond. */
422 int extra_diamond_value; /* Score for a diamond, when gate is open. */
426 boolean diamond_sound;
428 boolean falling_wall_sound;
429 boolean expanding_wall_sound;
430 boolean bladder_spender_sound;
431 boolean bladder_convert_sound;
433 int level_magic_wall_time[5]; /* magic wall 'on' state for each level (seconds) */
434 boolean magic_wall_stops_amoeba; /* Turning on magic wall changes amoeba to diamonds. Original BD: yes, constkit: no */
435 boolean magic_timer_wait_for_hatching; /* magic wall timer does not start before player's birth */
436 boolean magic_wall_sound; /* magic wall has sound */
438 int level_amoeba_time[5]; /* amoeba time for each level */
439 int amoeba_growth_prob; /* Amoeba slow growth probability */
440 int amoeba_fast_growth_prob; /* Amoeba fast growth probability */
441 int level_amoeba_threshold[5]; /* amoeba turns to stones; if count is bigger than this (number of cells) */
442 GdElement amoeba_enclosed_effect; /* an enclosed amoeba converts to this element */
443 GdElement amoeba_too_big_effect; /* an amoeba grown too big converts to this element */
445 int level_amoeba_2_time[5]; /* amoeba time for each level */
446 int amoeba_2_growth_prob; /* Amoeba slow growth probability */
447 int amoeba_2_fast_growth_prob; /* Amoeba fast growth probability */
448 int level_amoeba_2_threshold[5]; /* amoeba turns to stones; if count is bigger than this (number of cells) */
449 GdElement amoeba_2_enclosed_effect; /* an enclosed amoeba converts to this element */
450 GdElement amoeba_2_too_big_effect; /* an amoeba grown too big converts to this element */
451 boolean amoeba_2_explodes_by_amoeba; /* amoeba 2 will explode if touched by amoeba1 */
452 GdElement amoeba_2_explosion_effect; /* amoeba 2 explosion ends in ... */
453 GdElement amoeba_2_looks_like; /* an amoeba 2 looks like this element */
455 boolean amoeba_timer_started_immediately; /* FALSE: amoeba will start life at the first possibility of growing. */
456 boolean amoeba_timer_wait_for_hatching; /* amoeba timer does not start before player's birth */
457 boolean amoeba_sound; /* if the living amoeba has sound. */
459 GdElement acid_eats_this; /* acid eats this element */
460 int acid_spread_ratio; /* Probability of acid blowing up, each frame */
461 boolean acid_spread_sound; /* acid has sound */
462 GdElement acid_turns_to; /* whether acid converts to explosion on spreading or other */
464 GdElement nut_turns_to_when_crushed; /* when a nut is hit by a stone, it converts to this element */
466 int level_slime_permeability[5]; /* true random slime */
467 int level_slime_permeability_c64[5]; /* Appearing in bd 2 */
468 int level_slime_seed_c64[5]; /* predictable slime random seed */
469 boolean slime_predictable; /* predictable random start for slime. yes for plck. */
470 GdElement slime_eats_1, slime_converts_1; /* slime eats element x and converts to element x; for example diamond -> falling diamond */
471 GdElement slime_eats_2, slime_converts_2; /* this is usually stone -> stone_f */
472 GdElement slime_eats_3, slime_converts_3; /* this is usually nut -> nut_f */
473 boolean slime_sound; /* slime has sound */
475 boolean lava_sound; /* elements sinking in lava have sound */
477 int level_hatching_delay_frame[5]; /* Scan frames before Player's birth. */
478 int level_hatching_delay_time[5]; /* Scan frames before Player's birth. */
480 int level_bonus_time[5]; /* bonus time for clock collected. */
481 int level_penalty_time[5]; /* Time penalty when voodoo destroyed. */
482 boolean voodoo_collects_diamonds; /* Voodoo can collect diamonds */
483 boolean voodoo_dies_by_stone; /* Voodoo can be killed by a falling stone */
484 boolean voodoo_disappear_in_explosion; /* Voodoo can be destroyed by and explosion */
485 boolean voodoo_any_hurt_kills_player; /* If any of the voodoos are hurt in any way, the player is killed. */
487 boolean water_does_not_flow_down; /* if true, water will not grow downwards, only in other directions. */
488 boolean water_sound; /* water has sound */
490 boolean bladder_sound; /* bladder moving and pushing has sound */
491 GdElement bladder_converts_by; /* bladder converts to clock by touching this element */
493 int biter_delay_frame; /* frame count biters do move */
494 GdElement biter_eat; /* biters eat this */
495 boolean biter_sound; /* biters have sound */
497 boolean expanding_wall_changed; /* expanding wall direction is changed */
499 int replicator_delay_frame; /* replicator delay in frames (number of frames to wait between creating a new element) */
500 boolean replicators_active; /* replicators are active. */
501 boolean replicator_sound; /* when replicating an element, play sound or not. */
503 boolean conveyor_belts_active;
504 boolean conveyor_belts_direction_changed;
507 GdElement explosion_effect; /* explosion converts to this element after its last stage. diego effect. */
508 GdElement diamond_birth_effect; /* a diamond birth converts to this element after its last stage. diego effect. */
509 GdElement bomb_explosion_effect; /* bombs explode to this element. diego effect (almost). */
510 GdElement nitro_explosion_effect; /* nitros explode to this */
512 GdElement firefly_explode_to; /* fireflies explode to this when hit by a stone */
513 GdElement alt_firefly_explode_to; /* alternative fireflies explode to this when hit by a stone */
514 GdElement butterfly_explode_to; /* butterflies explode to this when hit by a stone */
515 GdElement alt_butterfly_explode_to; /* alternative butterflies explode to this when hit by a stone */
516 GdElement stonefly_explode_to; /* stoneflies explode to this when hit by a stone */
517 GdElement dragonfly_explode_to; /* dragonflies explode to this when hit by a stone */
519 GdElement stone_falling_effect; /* a falling stone converts to this element. diego effect. */
520 GdElement diamond_falling_effect; /* a falling diamond converts to this element. diego effect. */
521 GdElement stone_bouncing_effect; /* a bouncing stone converts to this element. diego effect. */
522 GdElement diamond_bouncing_effect; /* a bouncing diamond converts to this element. diego effect. */
524 GdElement expanding_wall_looks_like; /* an expanding wall looks like this element. diego effect. */
525 GdElement dirt_looks_like; /* dirt looks like this element. diego effect. */
527 GdElement magic_stone_to; /* magic wall converts falling stone to */
528 GdElement magic_diamond_to; /* magic wall converts falling diamond to */
529 GdElement magic_mega_stone_to; /* magic wall converts a falling mega stone to */
530 GdElement magic_nitro_pack_to; /* magic wall converts a falling nitro pack to */
531 GdElement magic_nut_to; /* magic wall converts a falling nut to */
532 GdElement magic_flying_stone_to; /* flying stones are converted to */
533 GdElement magic_flying_diamond_to; /* flying diamonds are converted to */
535 int pushing_stone_prob; /* probability of pushing stone */
536 int pushing_stone_prob_sweet; /* probability of pushing, after eating sweet */
537 boolean mega_stones_pushable_with_sweet; /* mega stones may be pushed with sweet */
539 boolean creatures_backwards; /* creatures changed direction */
540 boolean creatures_direction_auto_change_on_start; /* the change occurs also at the start signal */
541 int creatures_direction_auto_change_time; /* creatures automatically change direction every x seconds */
542 boolean creature_direction_auto_change_sound; /* automatically changing creature direction may have the sound of the creature dir switch */
544 int skeletons_needed_for_pot; /* how many skeletons to be collected, to use a pot */
545 int skeletons_worth_diamonds; /* for crazy dream 7 compatibility: collecting skeletons might open the cave door. */
548 int gravity_change_time;
549 boolean gravity_change_sound;
550 boolean gravity_affects_all; /* if true, gravity also affects falling wall, bladder and waiting stones */
551 boolean gravity_switch_active; /* true if gravity switch is activated, and can be used. */
553 boolean hammered_walls_reappear;
554 int pneumatic_hammer_frame;
555 int hammered_wall_reappear_frame;
556 boolean pneumatic_hammer_sound;
558 /* internal variables, used during the game. private data :) */
560 /* returns range corrected x/y position (points to perfect or line shifting get function) */
561 int (*getx) (const struct _gd_cave*, int x, int y);
562 int (*gety) (const struct _gd_cave*, int x, int y);
564 /* returns pointer to element at x, y (points to perfect border or a line shifting get function) */
565 GdElement* (*getp) (const struct _gd_cave*, int x, int y);
567 boolean hatched; /* hatching has happened. (timers may run, ...) */
568 boolean gate_open; /* self-explaining */
569 guint32 render_seed; /* the seed value, which was used to render the cave, is saved here. will be used by record&playback */
570 GRand *random; /* random number generator of rendered cave */
571 int rendered; /* if not zero, rendered at level x */
572 int timing_factor; /* number of "milliseconds" in each second :) 1000 for ntsc, 1200 for pal. */
573 gpointer **objects_order; /* two-dimensional map of cave; each cell is a pointer to the drawing object, which created this element. NULL if map or random. */
574 int **hammered_reappear; /* integer map of cave; if non-zero, a brick wall will appear there */
576 int speed; /* Time between game cycles in ms */
577 int c64_timing; /* a ckdelay value for the level this cave is rendered for */
578 int ckdelay; /* ckdelay value for the current iteration */
579 int ckdelay_extra_for_animation; /* bd1 and similar engines had animation bits in cave data, to set which elements to animate (firefly, butterfly, amoeba).
580 animating an element also caused some delay each frame; according to my measurements, around 2.6 ms/element. */
584 int hatching_delay_frame;
585 int hatching_delay_time;
586 int time_bonus; /* bonus time for clock collected. */
587 int time_penalty; /* Time penalty when voodoo destroyed. */
588 int time; /* milliseconds remaining to finish cave */
589 int timevalue; /* points for remaining seconds - for current level */
590 int diamonds_needed; /* diamonds needed to open outbox */
591 int diamonds_collected; /* diamonds collected */
592 int skeletons_collected; /* number of skeletons collected */
593 int gate_open_flash; /* flashing of screen when gate opens */
594 int score; /* Score got this frame. */
595 int amoeba_time; /* Amoeba growing slow (low probability, default 3%) for milliseconds. After that, fast growth default (25%) */
596 int amoeba_2_time; /* Amoeba growing slow (low probability, default 3%) for milliseconds. After that, fast growth default (25%) */
597 int amoeba_max_count; /* selected amoeba 1 threshold for this level */
598 int amoeba_2_max_count; /* selected amoeba 2 threshold for this level */
599 GdAmoebaState amoeba_state; /* state of amoeba 1 */
600 GdAmoebaState amoeba_2_state; /* state of amoeba 2 */
601 int magic_wall_time; /* magic wall 'on' state for seconds */
602 int slime_permeability; /* true random slime */
603 int slime_permeability_c64; /* Appearing in bd 2 */
604 GdMagicWallState magic_wall_state; /* State of magic wall */
605 GdPlayerState player_state; /* Player state. not yet living, living, exited... */
606 int player_seen_ago; /* player was seen this number of scans ago */
607 boolean voodoo_touched; /* as its name says */
608 boolean kill_player; /* Voodoo died, or used pressed escape to restart level. */
609 boolean sweet_eaten; /* player ate sweet, he's strong. prob_sweet applies, and also able to push chasing stones */
610 int player_x, player_y; /* Coordinates of player (for scrolling) */
611 int px[16], py[16]; /* coordinates of player, for chasing stone */
612 int key1, key2, key3; /* The player is holding this number of keys of each color */
613 boolean diamond_key_collected; /* Key collected, so trapped diamonds convert to diamonds */
614 boolean inbox_flash_toggle; /* negated every scan. helps drawing inboxes, and making players be born at different times. */
615 GdDirection last_direction; /* last direction player moved. used by draw routines */
616 GdDirection last_horizontal_direction;
617 int biters_wait_frame; /* number of frames to wait until biters will move again */
618 int replicators_wait_frame; /* number of frames to wait until replicators are activated again */
619 int creatures_direction_will_change; /* creatures automatically change direction every x seconds */
620 GdC64RandomGenerator c64_rand; /* used for predictable random generator during the game. */
622 int gravity_will_change; /* gravity will change in this number of milliseconds */
623 boolean gravity_disabled; /* when the player is stirring the pot, there is no gravity. */
624 GdDirection gravity_next_direction; /* next direction when the gravity changes. will be set by the player "getting" a gravity switch */
625 boolean got_pneumatic_hammer; /* true if the player has a pneumatic hammer */
626 int pneumatic_hammer_active_delay; /* number of frames to wait, till pneumatic hammer will destroy the wall */
627 GdSound sound1, sound2, sound3; /* sound set for 3 channels after each iteration */
631 #define CAVE_OFFSET(property) (G_STRUCT_OFFSET(GdCave, property))
633 /* arrays for movements */
634 /* also no1 and bd2 cave data import helpers; line direction coordinates */
635 extern const int gd_dx[], gd_dy[];
637 extern GdElement gd_char_to_element[];
639 void gd_create_char_to_element_table(void);
640 GdElement gd_get_element_from_character(guint8 character);
641 GdElement gd_get_element_from_string(const char *string);
643 /* init cave engine */
644 void gd_cave_init(void);
646 /* for cave tags hash table */
647 int str_case_equal(void *s1, void *s2);
648 unsigned int str_case_hash(void *v);
650 /* for cave tags hash table */
651 boolean gd_str_case_equal(gconstpointer s1, gconstpointer s2);
652 guint gd_str_case_hash(gconstpointer v);
654 /* cave highscore functions */
655 int gd_highscore_compare(gconstpointer a, gconstpointer b);
656 boolean gd_is_highscore(GdHighScore *scores, int score);
657 int gd_add_highscore(GdHighScore *highscores, const char *name, int score);
658 void gd_clear_highscore(GdHighScore *hs);
659 boolean gd_has_highscore(GdHighScore *hs);
661 /* cave creator and destructor functions */
662 GdCave *gd_cave_new(void);
663 GdCave *gd_cave_new_from_cave(const GdCave *orig);
664 void gd_cave_copy(GdCave *dest, const GdCave *src);
665 void gd_cave_free(GdCave *cave);
667 /* cave manipulation */
668 void gd_cave_set_gdash_defaults(GdCave *cave);
669 void gd_cave_set_defaults_from_array(GdCave* cave, GdPropertyDefault *defaults);
670 void gd_cave_correct_visible_size(GdCave *cave);
671 void gd_cave_auto_shrink(GdCave *cave);
673 void gd_cave_setup_for_game(GdCave *cave);
674 void gd_cave_count_diamonds(GdCave *cave);
676 /* c64 random generator support for cave fill */
677 unsigned int gd_c64_random(GdC64RandomGenerator *rand);
678 unsigned int gd_cave_c64_random(GdCave *);
679 void gd_c64_random_set_seed(GdC64RandomGenerator *rand, int seed1, int seed2);
680 void gd_cave_c64_random_set_seed(GdCave *cave, int seed1, int seed2);
683 gpointer gd_cave_map_new_for_cave(const GdCave *cave, const int cell_size);
684 gpointer gd_cave_map_dup_size(const GdCave * cave, const gpointer map, const int cell_size);
685 #define gd_cave_map_new(CAVE, TYPE) ((TYPE **)gd_cave_map_new_for_cave((CAVE), sizeof(TYPE)))
686 #define gd_cave_map_dup(CAVE, MAP) ((gpointer)gd_cave_map_dup_size((CAVE), (gpointer *)(CAVE)->MAP, sizeof((CAVE)->MAP[0][0])))
687 void gd_cave_map_free(gpointer map);
689 void gd_cave_store_rc(GdCave * cave, int x, int y, const GdElement element, const void* order);
690 GdElement gd_cave_get_rc (const GdCave *cave, int x, int y);
693 const char *gd_direction_get_visible_name(GdDirection dir);
694 const char *gd_direction_get_filename(GdDirection dir);
695 GdDirection gd_direction_from_string(const char *str);
698 const char *gd_scheduling_get_visible_name(GdScheduling sched);
699 const char *gd_scheduling_get_filename(GdScheduling sched);
700 GdScheduling gd_scheduling_from_string(const char *str);
702 /* game playing helpers */
703 #define GD_REDRAW (1 << 10)
705 void gd_drawcave_game(const GdCave *cave, int **element_buffer, int **gfx_buffer,
706 boolean bonus_life_flash, int animcycle, boolean hate_invisible_outbox);
708 /* function to copy a GdString */
710 gd_strcpy(GdString dest, const GdString src)
712 return g_strlcpy(dest, src, sizeof(GdString));
715 int gd_cave_time_show(const GdCave *cave, int internal_time);
717 GdReplay *gd_replay_new(void);
718 GdReplay *gd_replay_new_from_replay(GdReplay *orig);
719 void gd_replay_free(GdReplay *replay);
720 void gd_replay_store_movement(GdReplay *replay, GdDirection player_move, boolean player_fire, boolean suicide);
722 guint32 gd_cave_adler_checksum(GdCave *cave);
723 void gd_cave_adler_checksum_more(GdCave *cave, guint32 *a, guint32 *b);
725 GdColor gd_c64_color(int);