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