src/game_bd/bd_cave.h

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