added functions to get level position (tile) from screen position (pixel)
[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_REDRAW       (1 << 7)
44 #define DOOR_GET_STATE          (1 << 8)
45 #define DOOR_SET_STATE          (1 << 9)
46
47 #define DOOR_1                  (DOOR_ACTION_1)
48 #define DOOR_2                  (DOOR_ACTION_2)
49 #define DOOR_OPEN               (DOOR_OPEN_ALL)
50 #define DOOR_CLOSE              (DOOR_CLOSE_ALL)
51
52 #define DOOR_INDEX_FROM_TOKEN(x)        ((x) == DOOR_1 ? 0 : 1)
53 #define DOOR_TOKEN_FROM_INDEX(x)        ((x) == 0 ? DOOR_1 ? : DOOR_2)
54 #define REDRAW_DOOR_FROM_TOKEN(x)       ((x) == DOOR_1 ? REDRAW_DOOR_1 : \
55                                          REDRAW_DOOR_2)
56
57 /* for Request */
58 #define REQ_ASK                 (1 << 0)
59 #define REQ_CONFIRM             (1 << 1)
60 #define REQ_PLAYER              (1 << 2)
61 #define REQ_STAY_OPEN           (1 << 3)
62 #define REQ_STAY_CLOSED         (1 << 4)
63 #define REQ_REOPEN              (1 << 5)
64
65 #define REQUEST_WAIT_FOR_INPUT  (REQ_ASK | REQ_CONFIRM | REQ_PLAYER)
66
67
68 int getLevelFromScreenX(int);
69 int getLevelFromScreenY(int);
70
71 void DumpTile(int, int);
72 void DumpTileFromScreen(int, int);
73
74 void DrawMaskedBorder_FIELD();
75 void DrawMaskedBorder_DOOR_1();
76 void DrawMaskedBorder_DOOR_2();
77 void DrawMaskedBorder_DOOR_3();
78 void DrawMaskedBorder_ALL();
79 void DrawMaskedBorder(int);
80 void DrawMaskedBorderToTarget(int);
81
82 void SetDrawtoField(int);
83 void RedrawPlayfield();
84 void BlitScreenToBitmap_RND(Bitmap *);
85 void BlitScreenToBitmap(Bitmap *);
86 void BackToFront();
87 void BackToFront_WithFrameDelay(unsigned int);
88
89 void FadeIn(int);
90 void FadeOut(int);
91 void FadeSetEnterMenu();
92 void FadeSetLeaveMenu();
93 void FadeSetEnterScreen();
94 void FadeSetNextScreen();
95 void FadeSetLeaveScreen();
96 void FadeSetFromType(int);
97 void FadeSetDisabled();
98 void FadeSkipNextFadeIn();
99 void FadeSkipNextFadeOut();
100
101 Bitmap *getGlobalBorderBitmapFromStatus(int);
102
103 void ClearField();
104 void SetWindowBackgroundImageIfDefined(int);
105 void SetMainBackgroundImageIfDefined(int);
106 void SetDoorBackgroundImageIfDefined(int);
107 void SetWindowBackgroundImage(int);
108 void SetMainBackgroundImage(int);
109 void SetDoorBackgroundImage(int);
110 void SetPanelBackground();
111 void DrawBackground(int, int, int, int);
112 void DrawBackgroundForFont(int, int, int, int, int);
113 void DrawBackgroundForGraphic(int, int, int, int, int);
114 boolean CheckIfGlobalBorderHasChanged();
115 void RedrawGlobalBorder();
116
117 void MarkTileDirty(int, int);
118 void SetBorderElement();
119 void FloodFillLevel(int, int, int, short[MAX_LEV_FIELDX][MAX_LEV_FIELDY],
120                     int, int);
121
122 void SetRandomAnimationValue(int, int);
123 int getGraphicAnimationFrame(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 getGraphicSourceBitmap(int, int, Bitmap **);
138 void getGraphicSourceXY(int, int, int *, int *, boolean);
139 void getSizedGraphicSourceExt(int, int, int, Bitmap **, int *, int *, boolean);
140 void getFixedGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
141 void getSizedGraphicSource(int, int, int, Bitmap **, int *, int *);
142 void getFixedGraphicSource(int, int, Bitmap **, int *, int *);
143 void getMiniGraphicSource(int, Bitmap **, int *, int *);
144 void getGraphicSource(int, int, Bitmap **, int *, int *);
145
146 void DrawGraphic(int, int, int, int);
147 void DrawGraphicExt(DrawBuffer *, int, int, int, int);
148 void DrawGraphicThruMask(int, int, int, int);
149 void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
150
151 void DrawFixedGraphic(int, int, int, int);
152 void DrawFixedGraphicExt(DrawBuffer *, int, int, int, int);
153 void DrawFixedGraphicThruMask(int, int, int, int);
154 void DrawFixedGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
155
156 void DrawSizedGraphic(int, int, int, int, int);
157 void DrawSizedGraphicExt(DrawBuffer *, int, int, int, int, int);
158
159 void DrawMiniGraphic(int, int, int);
160 void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
161
162 void DrawScreenElementExt(int, int, int, int, int, int, int);
163 void DrawLevelElementExt(int, int, int, int, int, int, int);
164 void DrawScreenElementShifted(int, int, int, int, int, int);
165 void DrawLevelElementShifted(int, int, int, int, int, int);
166 void DrawScreenElementThruMask(int, int, int);
167 void DrawLevelElementThruMask(int, int, int);
168 void DrawLevelFieldThruMask(int, int);
169 void DrawLevelFieldCrumbled(int, int);
170 void DrawLevelFieldCrumbledDigging(int, int, int, int);
171 void DrawLevelFieldCrumbledNeighbours(int, int);
172 void DrawScreenElement(int, int, int);
173 void DrawLevelElement(int, int, int);
174 void DrawScreenField(int, int);
175 void DrawLevelField(int, int);
176
177 void DrawSizedElement(int, int, int, int);
178 void DrawSizedElementOrWall(int, int, int, int, int);
179
180 void DrawMiniElement(int, int, int);
181 void DrawMiniElementOrWall(int, int, int, int);
182
183 void ShowEnvelope(int);
184 void ShowEnvelopeDoor(char *text, int);
185
186 void DrawLevel(int);
187 void DrawSizedLevel(int, int, int, int, int);
188 void DrawMiniLevel(int, int, int, int);
189 void DrawPreviewLevelInitial(void);
190 void DrawPreviewLevelAnimation(void);
191
192 void WaitForEventToContinue(void);
193 boolean Request(char *, unsigned int);
194 void InitGraphicCompatibilityInfo_Doors(void);
195 void InitDoors(void);
196 unsigned int OpenDoor(unsigned int);
197 unsigned int CloseDoor(unsigned int);
198 unsigned int GetDoorState(void);
199 unsigned int SetDoorState(unsigned int);
200 unsigned int MoveDoor(unsigned int);
201
202 void DrawSpecialEditorDoor();
203 void UndrawSpecialEditorDoor();
204
205 void CreateToolButtons();
206 void FreeToolButtons();
207
208 int map_element_RND_to_EM(int);
209 int map_element_EM_to_RND(int);
210 int map_direction_RND_to_EM(int);
211 int map_direction_EM_to_RND(int);
212
213 void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
214 void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
215
216 int map_element_RND_to_SP(int);
217 int map_element_SP_to_RND(int);
218 int map_action_SP_to_RND(int);
219
220 int get_next_element(int);
221 int el_act_dir2img(int, int, int);
222 int el_act2img(int, int);
223 int el_dir2img(int, int);
224 int el2baseimg(int);
225 int el2img(int);
226 int el2edimg(int);
227 int el2preimg(int);
228 int el2panelimg(int);
229 int font2baseimg(int);
230
231 int getBeltNrFromBeltElement(int);
232 int getBeltNrFromBeltActiveElement(int);
233 int getBeltNrFromBeltSwitchElement(int);
234 int getBeltDirNrFromBeltElement(int);
235 int getBeltDirNrFromBeltSwitchElement(int);
236 int getBeltDirFromBeltElement(int);
237 int getBeltDirFromBeltSwitchElement(int);
238 int getBeltElementFromBeltNrAndBeltDirNr(int, int);
239 int getBeltElementFromBeltNrAndBeltDir(int, int);
240 int getBeltSwitchElementFromBeltNrAndBeltDirNr(int, int);
241 int getBeltSwitchElementFromBeltNrAndBeltDir(int, int);
242
243 unsigned int InitRND(int);
244 void InitGraphicInfo_EM(void);
245
246 void PlayMenuSoundExt(int);
247 void PlayMenuSound();
248 void PlayMenuSoundStereo(int, int);
249 void PlayMenuSoundIfLoopExt(int);
250 void PlayMenuSoundIfLoop();
251 void PlayMenuMusicExt(int);
252 void PlayMenuMusic();
253 void PlaySoundActivating();
254 void PlaySoundSelecting();
255
256 void SetAnimStatus(int);
257 void SetGameStatus(int);
258 void SetFontStatus(int);
259 void ResetFontStatus();
260
261 void ToggleFullscreenOrChangeWindowScalingIfNeeded();
262 void ChangeViewportPropertiesIfNeeded();
263
264 #endif  /* TOOLS_H */