moved level set info structure to game library layer
[rocksndiamonds.git] / 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 void DrawTileCursor(int);
86
87 void SetDrawtoField(int);
88 void RedrawPlayfield();
89 void BlitScreenToBitmap_RND(Bitmap *);
90 void BlitScreenToBitmap(Bitmap *);
91 void BackToFront();
92 void BackToFront_WithFrameDelay(unsigned int);
93
94 void FadeIn(int);
95 void FadeOut(int);
96 void FadeSetEnterMenu();
97 void FadeSetLeaveMenu();
98 void FadeSetEnterScreen();
99 void FadeSetNextScreen();
100 void FadeSetLeaveScreen();
101 void FadeSetFromType(int);
102 void FadeSetDisabled();
103 void FadeSkipNextFadeIn();
104 void FadeSkipNextFadeOut();
105
106 Bitmap *getGlobalBorderBitmapFromStatus(int);
107
108 void ClearField();
109 void SetWindowBackgroundImageIfDefined(int);
110 void SetMainBackgroundImageIfDefined(int);
111 void SetDoorBackgroundImageIfDefined(int);
112 void SetWindowBackgroundImage(int);
113 void SetMainBackgroundImage(int);
114 void SetDoorBackgroundImage(int);
115 void SetPanelBackground();
116 void DrawBackground(int, int, int, int);
117 void DrawBackgroundForFont(int, int, int, int, int);
118 void DrawBackgroundForGraphic(int, int, int, int, int);
119 boolean CheckIfGlobalBorderHasChanged();
120 void RedrawGlobalBorder();
121
122 void MarkTileDirty(int, int);
123 void SetBorderElement();
124 void FloodFillLevel(int, int, int, short[][MAX_LEV_FIELDY], int, int);
125 void FloodFillLevelExt(int, int, int, int, int y, short field[][y], int, int);
126
127 void SetRandomAnimationValue(int, int);
128 int getGraphicAnimationFrame(int, int);
129
130 void DrawFixedGraphicAnimation(int, int, int);
131 void DrawFixedGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
132
133 void DrawLevelGraphicAnimation(int, int, int);
134 void DrawLevelElementAnimation(int, int, int);
135 void DrawLevelGraphicAnimationIfNeeded(int, int, int);
136 void DrawLevelElementAnimationIfNeeded(int, int, int);
137
138 void DrawAllPlayers(void);
139 void DrawPlayerField(int, int);
140 void DrawPlayer(struct PlayerInfo *);
141
142 void getGraphicSourceBitmap(int, int, Bitmap **);
143 void getGraphicSourceXY(int, int, int *, int *, boolean);
144 void getSizedGraphicSourceExt(int, int, int, Bitmap **, int *, int *, boolean);
145 void getSizedGraphicSource(int, int, int, Bitmap **, int *, int *);
146 void getFixedGraphicSource(int, int, Bitmap **, int *, int *);
147 void getMiniGraphicSource(int, Bitmap **, int *, int *);
148 void getGraphicSource(int, int, Bitmap **, int *, int *);
149
150 void DrawGraphic(int, int, int, int);
151 void DrawGraphicExt(DrawBuffer *, int, int, int, int);
152 void DrawGraphicThruMask(int, int, int, int);
153 void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
154
155 void DrawFixedGraphic(int, int, int, int);
156 void DrawFixedGraphicExt(DrawBuffer *, int, int, int, int);
157 void DrawFixedGraphicThruMask(int, int, int, int);
158 void DrawFixedGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
159
160 void DrawSizedGraphic(int, int, int, int, int);
161 void DrawSizedGraphicExt(DrawBuffer *, int, int, int, int, int);
162 void DrawSizedGraphicThruMask(int, int, int, int, int);
163 void DrawSizedGraphicThruMaskExt(DrawBuffer *, int, int, int, int, int);
164
165 void DrawMiniGraphic(int, int, int);
166 void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
167
168 void DrawScreenElementExt(int, int, int, int, int, int, int);
169 void DrawLevelElementExt(int, int, int, int, int, int, int);
170 void DrawScreenElementShifted(int, int, int, int, int, int);
171 void DrawLevelElementShifted(int, int, int, int, int, int);
172 void DrawScreenElementThruMask(int, int, int);
173 void DrawLevelElementThruMask(int, int, int);
174 void DrawLevelFieldThruMask(int, int);
175 void DrawLevelFieldCrumbled(int, int);
176 void DrawLevelFieldCrumbledDigging(int, int, int, int);
177 void DrawLevelFieldCrumbledNeighbours(int, int);
178 void DrawScreenElement(int, int, int);
179 void DrawLevelElement(int, int, int);
180 void DrawScreenField(int, int);
181 void DrawLevelField(int, int);
182
183 void DrawSizedWallParts_MM(int, int, int, int, boolean, int);
184 void DrawSizedElement(int, int, int, int);
185 void DrawSizedElementThruMask(int, int, int, int);
186 void DrawSizedElementOrWall(int, int, int, int, int);
187
188 void DrawMiniElement(int, int, int);
189 void DrawMiniElementOrWall(int, int, int, int);
190
191 void ShowEnvelope(int);
192 void ShowEnvelopeDoor(char *text, int);
193
194 void DrawLevel(int);
195 void DrawSizedLevel(int, int, int, int, int);
196 void DrawMiniLevel(int, int, int, int);
197 void DrawPreviewLevelInitial(void);
198 void DrawPreviewLevelAnimation(void);
199
200 void DrawNetworkPlayers(void);
201 void ClearNetworkPlayers(void);
202
203 void WaitForEventToContinue(void);
204 boolean Request(char *, unsigned int);
205 void InitGraphicCompatibilityInfo_Doors(void);
206 void InitDoors(void);
207 unsigned int OpenDoor(unsigned int);
208 unsigned int CloseDoor(unsigned int);
209 unsigned int GetDoorState(void);
210 unsigned int SetDoorState(unsigned int);
211 unsigned int MoveDoor(unsigned int);
212
213 void DrawSpecialEditorDoor();
214 void UndrawSpecialEditorDoor();
215
216 void CreateToolButtons();
217 void FreeToolButtons();
218
219 int map_element_RND_to_EM(int);
220 int map_element_EM_to_RND(int);
221 int map_direction_RND_to_EM(int);
222 int map_direction_EM_to_RND(int);
223
224 void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
225 void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
226
227 int map_element_RND_to_SP(int);
228 int map_element_SP_to_RND(int);
229 int map_action_SP_to_RND(int);
230
231 int map_element_RND_to_MM(int);
232 int map_element_MM_to_RND(int);
233 int map_action_MM_to_RND(int);
234 int map_sound_MM_to_RND(int);
235 int map_mm_wall_element(int);
236 int map_mm_wall_element_editor(int);
237
238 int get_next_element(int);
239 int el_act_dir2img(int, int, int);
240 int el_act2img(int, int);
241 int el_dir2img(int, int);
242 int el2baseimg(int);
243 int el2img(int);
244 int el2edimg(int);
245 int el2preimg(int);
246 int el2panelimg(int);
247 int font2baseimg(int);
248
249 int getBeltNrFromBeltElement(int);
250 int getBeltNrFromBeltActiveElement(int);
251 int getBeltNrFromBeltSwitchElement(int);
252 int getBeltDirNrFromBeltElement(int);
253 int getBeltDirNrFromBeltSwitchElement(int);
254 int getBeltDirFromBeltElement(int);
255 int getBeltDirFromBeltSwitchElement(int);
256 int getBeltElementFromBeltNrAndBeltDirNr(int, int);
257 int getBeltElementFromBeltNrAndBeltDir(int, int);
258 int getBeltSwitchElementFromBeltNrAndBeltDirNr(int, int);
259 int getBeltSwitchElementFromBeltNrAndBeltDir(int, int);
260
261 unsigned int InitRND(int);
262 void InitGraphicInfo_EM(void);
263
264 void PlayMenuSoundExt(int);
265 void PlayMenuSound();
266 void PlayMenuSoundStereo(int, int);
267 void PlayMenuSoundIfLoopExt(int);
268 void PlayMenuSoundIfLoop();
269 void PlayMenuMusicExt(int);
270 void PlayMenuMusic();
271 void PlayMenuSoundsAndMusic();
272 void FadeMenuSoundsAndMusic();
273 void PlaySoundActivating();
274 void PlaySoundSelecting();
275
276 void SetAnimStatus(int);
277 void SetGameStatus(int);
278 void SetFontStatus(int);
279 void ResetFontStatus();
280
281 void ToggleFullscreenOrChangeWindowScalingIfNeeded();
282 void ChangeViewportPropertiesIfNeeded();
283
284 boolean CheckIfPlayfieldViewportHasChanged();
285 boolean CheckIfGlobalBorderOrPlayfieldViewportHasChanged();
286
287 #endif  /* TOOLS_H */