src/tools.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 // tools.h
  10 // ============================================================================
  11
  12 #ifndef TOOLS_H
  13 #define TOOLS_H
  14
  15 #include "main.h"
  16 #include "game.h"
  17
  18 /* for SetDrawtoField */
  19 #define DRAW_FIELDBUFFER        1
  20 #define DRAW_BACKBUFFER         2
  21
  22 /* for DrawElementShifted */
  23 #define NO_CUTTING              0
  24 #define CUT_ABOVE               (1 << 0)
  25 #define CUT_BELOW               (1 << 1)
  26 #define CUT_LEFT                (1 << 2)
  27 #define CUT_RIGHT               (1 << 3)
  28
  29 /* for masking functions */
  30 #define NO_MASKING              0
  31 #define USE_MASKING             1
  32
  33 /* for MoveDoor */
  34 #define DOOR_OPEN_1             (1 << 0)
  35 #define DOOR_OPEN_2             (1 << 1)
  36 #define DOOR_CLOSE_1            (1 << 2)
  37 #define DOOR_CLOSE_2            (1 << 3)
  38 #define DOOR_OPEN_ALL           (DOOR_OPEN_1 | DOOR_OPEN_2)
  39 #define DOOR_CLOSE_ALL          (DOOR_CLOSE_1 | DOOR_CLOSE_2)
  40 #define DOOR_ACTION_1           (DOOR_OPEN_1 | DOOR_CLOSE_1)
  41 #define DOOR_ACTION_2           (DOOR_OPEN_2 | DOOR_CLOSE_2)
  42 #define DOOR_ACTION             (DOOR_ACTION_1 | DOOR_ACTION_2)
  43 #define DOOR_COPY_BACK          (1 << 4)
  44 #define DOOR_NO_COPY_BACK       (1 << 5)
  45 #define DOOR_NO_DELAY           (1 << 6)
  46 #define DOOR_FORCE_REDRAW       (1 << 7)
  47 #define DOOR_GET_STATE          (1 << 8)
  48 #define DOOR_SET_STATE          (1 << 9)
  49
  50 #define DOOR_1                  (DOOR_ACTION_1)
  51 #define DOOR_2                  (DOOR_ACTION_2)
  52 #define DOOR_OPEN               (DOOR_OPEN_ALL)
  53 #define DOOR_CLOSE              (DOOR_CLOSE_ALL)
  54
  55 #define DOOR_INDEX_FROM_TOKEN(x)        ((x) == DOOR_1 ? 0 : 1)
  56 #define DOOR_TOKEN_FROM_INDEX(x)        ((x) == 0 ? DOOR_1 ? : DOOR_2)
  57 #define REDRAW_DOOR_FROM_TOKEN(x)       ((x) == DOOR_1 ? REDRAW_DOOR_1 : \
  58                                          REDRAW_DOOR_2)
  59
  60 /* for Request */
  61 #define REQ_ASK                 (1 << 0)
  62 #define REQ_CONFIRM             (1 << 1)
  63 #define REQ_PLAYER              (1 << 2)
  64 #define REQ_STAY_OPEN           (1 << 3)
  65 #define REQ_STAY_CLOSED         (1 << 4)
  66 #define REQ_REOPEN              (1 << 5)
  67
  68 #define REQUEST_WAIT_FOR_INPUT  (REQ_ASK | REQ_CONFIRM | REQ_PLAYER)
  69
  70
  71 void DumpTile(int, int);
  72
  73 void DrawMaskedBorder_FIELD();
  74 void DrawMaskedBorder_DOOR_1();
  75 void DrawMaskedBorder_DOOR_2();
  76 void DrawMaskedBorder_DOOR_3();
  77 void DrawMaskedBorder_ALL();
  78 void DrawMaskedBorder(int);
  79
  80 void SetDrawtoField(int);
  81 void RedrawPlayfield();
  82 void BlitScreenToBitmap_RND(Bitmap *);
  83 void BlitScreenToBitmap(Bitmap *);
  84 void BackToFront();
  85
  86 void FadeIn(int);
  87 void FadeOut(int);
  88 void FadeSetEnterMenu();
  89 void FadeSetLeaveMenu();
  90 void FadeSetEnterScreen();
  91 void FadeSetNextScreen();
  92 void FadeSetLeaveScreen();
  93 void FadeSetFromType(int);
  94 void FadeSetDisabled();
  95 void FadeSkipNextFadeIn();
  96 void FadeSkipNextFadeOut();
  97
  98 Bitmap *getGlobalBorderBitmapFromGameStatus();
  99
 100 void ClearField();
 101 void SetWindowBackgroundImageIfDefined(int);
 102 void SetMainBackgroundImageIfDefined(int);
 103 void SetDoorBackgroundImageIfDefined(int);
 104 void SetWindowBackgroundImage(int);
 105 void SetMainBackgroundImage(int);
 106 void SetDoorBackgroundImage(int);
 107 void SetPanelBackground();
 108 void DrawBackground(int, int, int, int);
 109 void DrawBackgroundForFont(int, int, int, int, int);
 110 void DrawBackgroundForGraphic(int, int, int, int, int);
 111 boolean CheckIfGlobalBorderHasChanged();
 112 void RedrawGlobalBorder();
 113
 114 void MarkTileDirty(int, int);
 115 void SetBorderElement();
 116 void FloodFillLevel(int, int, int, short[MAX_LEV_FIELDX][MAX_LEV_FIELDY],
 117                     int, int);
 118
 119 void SetRandomAnimationValue(int, int);
 120 int getGraphicAnimationFrame(int, int);
 121
 122 void DrawGraphicAnimation(int, int, int);
 123 void DrawGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
 124
 125 void DrawFixedGraphicAnimation(int, int, int);
 126 void DrawFixedGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
 127
 128 void DrawLevelGraphicAnimation(int, int, int);
 129 void DrawLevelElementAnimation(int, int, int);
 130 void DrawLevelGraphicAnimationIfNeeded(int, int, int);
 131 void DrawLevelElementAnimationIfNeeded(int, int, int);
 132
 133 void DrawAllPlayers(void);
 134 void DrawPlayerField(int, int);
 135 void DrawPlayer(struct PlayerInfo *);
 136
 137 void getSizedGraphicSourceExt(int, int, int, Bitmap **, int *, int *, boolean);
 138 void getFixedGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
 139 void getSizedGraphicSource(int, int, int, Bitmap **, int *, int *);
 140 void getFixedGraphicSource(int, int, Bitmap **, int *, int *);
 141 void getMiniGraphicSource(int, Bitmap **, int *, int *);
 142 void getGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
 143 void getGraphicSource(int, int, Bitmap **, int *, int *);
 144
 145 void DrawGraphic(int, int, int, int);
 146 void DrawGraphicExt(DrawBuffer *, int, int, int, int);
 147 void DrawGraphicThruMask(int, int, int, int);
 148 void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
 149
 150 void DrawFixedGraphic(int, int, int, int);
 151 void DrawFixedGraphicExt(DrawBuffer *, int, int, int, int);
 152 void DrawFixedGraphicThruMask(int, int, int, int);
 153 void DrawFixedGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
 154
 155 void DrawSizedGraphic(int, int, int, int, int);
 156 void DrawSizedGraphicExt(DrawBuffer *, int, int, int, int, int);
 157
 158 void DrawMiniGraphic(int, int, int);
 159 void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
 160
 161 void DrawScreenElementExt(int, int, int, int, int, int, int);
 162 void DrawLevelElementExt(int, int, int, int, int, int, int);
 163 void DrawScreenElementShifted(int, int, int, int, int, int);
 164 void DrawLevelElementShifted(int, int, int, int, int, int);
 165 void DrawScreenElementThruMask(int, int, int);
 166 void DrawLevelElementThruMask(int, int, int);
 167 void DrawLevelFieldThruMask(int, int);
 168 void DrawLevelFieldCrumbled(int, int);
 169 void DrawLevelFieldCrumbledDigging(int, int, int, int);
 170 void DrawLevelFieldCrumbledNeighbours(int, int);
 171 void DrawScreenElement(int, int, int);
 172 void DrawLevelElement(int, int, int);
 173 void DrawScreenField(int, int);
 174 void DrawLevelField(int, int);
 175
 176 void DrawSizedElement(int, int, int, int);
 177 void DrawSizedElementOrWall(int, int, int, int, int);
 178
 179 void DrawMiniElement(int, int, int);
 180 void DrawMiniElementOrWall(int, int, int, int);
 181
 182 void ShowEnvelope(int);
 183 void ShowEnvelopeDoor(char *text, int);
 184
 185 void DrawLevel(int);
 186 void DrawSizedLevel(int, int, int, int, int);
 187 void DrawMiniLevel(int, int, int, int);
 188 void DrawPreviewLevelInitial(void);
 189 void DrawPreviewLevelAnimation(void);
 190
 191 void WaitForEventToContinue(void);
 192 boolean Request(char *, unsigned int);
 193 void InitGraphicCompatibilityInfo_Doors(void);
 194 void InitDoors(void);
 195 unsigned int OpenDoor(unsigned int);
 196 unsigned int CloseDoor(unsigned int);
 197 unsigned int GetDoorState(void);
 198 unsigned int SetDoorState(unsigned int);
 199 unsigned int MoveDoor(unsigned int);
 200
 201 void DrawSpecialEditorDoor();
 202 void UndrawSpecialEditorDoor();
 203
 204 void CreateToolButtons();
 205 void FreeToolButtons();
 206
 207 int map_element_RND_to_EM(int);
 208 int map_element_EM_to_RND(int);
 209 int map_direction_RND_to_EM(int);
 210 int map_direction_EM_to_RND(int);
 211
 212 void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
 213 void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
 214
 215 int map_element_RND_to_SP(int);
 216 int map_element_SP_to_RND(int);
 217 int map_action_SP_to_RND(int);
 218
 219 int get_next_element(int);
 220 int el_act_dir2img(int, int, int);
 221 int el_act2img(int, int);
 222 int el_dir2img(int, int);
 223 int el2baseimg(int);
 224 int el2img(int);
 225 int el2edimg(int);
 226 int el2preimg(int);
 227 int el2panelimg(int);
 228 int font2baseimg(int);
 229
 230 int getBeltNrFromBeltElement(int);
 231 int getBeltNrFromBeltActiveElement(int);
 232 int getBeltNrFromBeltSwitchElement(int);
 233 int getBeltDirNrFromBeltElement(int);
 234 int getBeltDirNrFromBeltSwitchElement(int);
 235 int getBeltDirFromBeltElement(int);
 236 int getBeltDirFromBeltSwitchElement(int);
 237 int getBeltElementFromBeltNrAndBeltDirNr(int, int);
 238 int getBeltElementFromBeltNrAndBeltDir(int, int);
 239 int getBeltSwitchElementFromBeltNrAndBeltDirNr(int, int);
 240 int getBeltSwitchElementFromBeltNrAndBeltDir(int, int);
 241
 242 unsigned int InitRND(int);
 243 void InitGraphicInfo_EM(void);
 244
 245 void PlayMenuSoundExt(int);
 246 void PlayMenuSound();
 247 void PlayMenuSoundStereo(int, int);
 248 void PlayMenuSoundIfLoopExt(int);
 249 void PlayMenuSoundIfLoop();
 250 void PlayMenuMusicExt(int);
 251 void PlayMenuMusic();
 252 void PlaySoundActivating();
 253 void PlaySoundSelecting();
 254
 255 void ToggleFullscreenOrChangeWindowScalingIfNeeded();
 256 void ChangeViewportPropertiesIfNeeded();
 257
 258 #endif  /* TOOLS_H */