rnd-20060816-3-src
[rocksndiamonds.git] / src / tools.h
1 /***********************************************************
2 * Rocks'n'Diamonds -- McDuffin Strikes Back!               *
3 *----------------------------------------------------------*
4 * (c) 1995-2002 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_DIRECT             0
22 #define DRAW_BUFFERED           1
23 #define DRAW_BACKBUFFER         2
24
25 /* for DrawElementShifted */
26 #define NO_CUTTING              0
27 #define CUT_ABOVE               (1 << 0)
28 #define CUT_BELOW               (1 << 1)
29 #define CUT_LEFT                (1 << 2)
30 #define CUT_RIGHT               (1 << 3)
31
32 /* for masking functions */
33 #define NO_MASKING              0
34 #define USE_MASKING             1
35  
36 /* for MoveDoor */
37 #define DOOR_OPEN_1             (1 << 0)
38 #define DOOR_OPEN_2             (1 << 1)
39 #define DOOR_CLOSE_1            (1 << 2)
40 #define DOOR_CLOSE_2            (1 << 3)
41 #define DOOR_OPEN_ALL           (DOOR_OPEN_1 | DOOR_OPEN_2)
42 #define DOOR_CLOSE_ALL          (DOOR_CLOSE_1 | DOOR_CLOSE_2)
43 #define DOOR_ACTION_1           (DOOR_OPEN_1 | DOOR_CLOSE_1)
44 #define DOOR_ACTION_2           (DOOR_OPEN_2 | DOOR_CLOSE_2)
45 #define DOOR_ACTION             (DOOR_ACTION_1 | DOOR_ACTION_2)
46 #define DOOR_COPY_BACK          (1 << 4)
47 #define DOOR_NO_COPY_BACK       (1 << 5)
48 #define DOOR_NO_DELAY           (1 << 6)
49 #define DOOR_FORCE_REDRAW       (1 << 7)
50 #define DOOR_GET_STATE          (1 << 8)
51 #define DOOR_SET_STATE          (1 << 9)
52
53 /* for Request */
54 #define REQ_ASK                 (1 << 0)
55 #define REQ_CONFIRM             (1 << 1)
56 #define REQ_PLAYER              (1 << 2)
57 #define REQ_STAY_OPEN           (1 << 3)
58 #define REQ_STAY_CLOSED         (1 << 4)
59 #define REQ_REOPEN              (1 << 5)
60
61 #define REQUEST_WAIT_FOR_INPUT  (REQ_ASK | REQ_CONFIRM | REQ_PLAYER)
62
63 void DumpTile(int, int);
64
65 void SetDrawtoField(int);
66 void RedrawPlayfield(boolean, int, int, int, int);
67 void BackToFront();
68 void FadeToFront();
69
70 void FadeIn(int);
71 void FadeOut(int);
72 void FadeCross(int);
73 void FadeCrossSaveBackbuffer();
74
75 void ClearWindow();
76 void SetMainBackgroundImageIfDefined(int);
77 void SetMainBackgroundImage(int);
78 void SetDoorBackgroundImage(int);
79 void SetPanelBackground();
80 void DrawBackground(int, int, int, int);
81
82 void MarkTileDirty(int, int);
83 void SetBorderElement();
84
85 void SetRandomAnimationValue(int, int);
86 int getGraphicAnimationFrame(int, int);
87 void DrawGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
88 void DrawGraphicAnimation(int, int, int);
89 void DrawLevelGraphicAnimation(int, int, int);
90 void DrawLevelElementAnimation(int, int, int);
91 void DrawLevelGraphicAnimationIfNeeded(int, int, int);
92 void DrawLevelElementAnimationIfNeeded(int, int, int);
93
94 void DrawAllPlayers(void);
95 void DrawPlayerField(int, int);
96 void DrawPlayer(struct PlayerInfo *);
97
98 void getGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
99 void getGraphicSource(int, int, Bitmap **, int *, int *);
100 void DrawGraphic(int, int, int, int);
101 void DrawGraphicExt(DrawBuffer *, int, int, int, int);
102 void DrawGraphicThruMask(int, int, int, int);
103 void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
104
105 void DrawMiniGraphic(int, int, int);
106 void getMiniGraphicSource(int, Bitmap **, int *, int *);
107 void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
108
109 void DrawScreenElementExt(int, int, int, int, int, int, int);
110 void DrawLevelElementExt(int, int, int, int, int, int, int);
111 void DrawScreenElementShifted(int, int, int, int, int, int);
112 void DrawLevelElementShifted(int, int, int, int, int, int);
113 void DrawScreenElementThruMask(int, int, int);
114 void DrawLevelElementThruMask(int, int, int);
115 void DrawLevelFieldThruMask(int, int);
116 void DrawLevelFieldCrumbledSand(int, int);
117 void DrawLevelFieldCrumbledSandDigging(int, int, int, int);
118 void DrawLevelFieldCrumbledSandNeighbours(int, int);
119 void DrawScreenElement(int, int, int);
120 void DrawLevelElement(int, int, int);
121 void DrawScreenField(int, int);
122 void DrawLevelField(int, int);
123
124 void DrawMiniElement(int, int, int);
125 void DrawMiniElementOrWall(int, int, int, int);
126
127 void ShowEnvelope();
128
129 void DrawLevel(void);
130 void DrawMiniLevel(int, int, int, int);
131 void DrawPreviewLevel(boolean);
132
133 void WaitForEventToContinue();
134 boolean Request(char *, unsigned int);
135 unsigned int OpenDoor(unsigned int);
136 unsigned int CloseDoor(unsigned int);
137 unsigned int GetDoorState(void);
138 unsigned int SetDoorState(unsigned int);
139 unsigned int MoveDoor(unsigned int);
140
141 void DrawSpecialEditorDoor();
142 void UndrawSpecialEditorDoor();
143
144 void CreateToolButtons();
145 void FreeToolButtons();
146
147 int map_element_RND_to_EM(int);
148 int map_element_EM_to_RND(int);
149 int map_direction_RND_to_EM(int);
150 int map_direction_EM_to_RND(int);
151
152 void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
153 void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
154
155 int get_next_element(int);
156 int el_act_dir2img(int, int, int);
157 int el_act2img(int, int);
158 int el_dir2img(int, int);
159 int el2baseimg(int);
160 int el2img(int);
161 int el2edimg(int);
162 int el2preimg(int);
163 int font2baseimg(int);
164
165 unsigned int InitRND(long);
166 void InitGraphicInfo_EM(void);
167
168 void PlayMenuSound();
169 void PlayMenuSoundStereo(int, int);
170 void PlayMenuSoundIfLoop();
171 void PlayMenuMusic();
172
173 void ToggleFullscreenIfNeeded();
174
175 #endif  /* TOOLS_H */