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