aboutsummaryrefslogtreecommitdiff
path: root/project/src/db-kcl.h
blob: 9108d3dc5c96e4df3ddddeb4af4c956084c62513 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

//
///////////////////////////////////////////////////////////////////////////////
//////   This file is created by a script. Modifications will be lost!   //////
///////////////////////////////////////////////////////////////////////////////

#ifndef SZS_DB_KCL_H
#define SZS_DB_KCL_H 1

#include "types.h"


//
///////////////////////////////////////////////////////////////////////////////
////////////////////////////   enum kcl_attrib_t   ////////////////////////////
///////////////////////////////////////////////////////////////////////////////

typedef enum kcl_attrib_t
{

    KCLT_C_ROAD       = 0x000001,  // normal road
    KCLT_C_OFFROAD    = 0x000002,  // offroad
    KCLT_C_FAST       = 0x000004,  // boost and trick
    KCLT_C_HALFPIPE   = 0x000008,  // halfpipe
    KCLT_C_MOVING     = 0x000010,  // moving terrain
    KCLT_C_WATER      = 0x000020,  // shallow water
    KCLT_C_CANNON     = 0x000040,  // cannon activator
    KCLT_C_WALL       = 0x000080,  // wall
    KCLT_C_FALL       = 0x000100,  // fall or out of bounds
    KCLT_C_EFFECT     = 0x000200,  // sound trigger and other effects
    KCLT_C_ITEM       = 0x000400,  // for items only
    KCLT_C_UNKNOWN    = 0x000800,  // unknown type
     KCLT_M_CLASS     = 0x000fff,  // mask of classes

    KCLT_BORDER       = 0x001000,  // road or wall
    KCLT_DRIVE        = 0x002000,  // is driveable
    KCLT_BOOST        = 0x004000,  // boost
    KCLT_TRICK        = 0x008000,  // trickable
    KCLT_SOUND        = 0x010000,  // sound effect
    KCLT_ITEM         = 0x020000,  // special for items
    KCLT_UNKNOWN      = 0x040000,  // unknown
    KCLT_VARIANT_X    = 0x080000,  // unknown variant
    KCLT_VARIANT_A    = 0x100000,  // variant A
    KCLT_VARIANT_B    = 0x200000,  // variant B
     KCLT_M_FEATURES  = 0x3ff000,  // mask of base features

    KCLT_NONE         = 0x000000,  // none set
    KCLT_M_ALL        = 0x3fffff   // all flags of above

} kcl_attrib_t;

///////////////////////////////////////////////////////////////////////////////

#define N_KCL_CLASS     12
#define N_KCL_TYPE    0x20
#define N_KCL_ATTRIB    22
#define N_KCL_FLAG 0x10000
#define N_KCL_AUTO_FLAGS 200
#define N_KCL_USER_FLAGS 200
#define N_KCL_COLORS 272

#define IS_KCL_TYPE(f,t) ( (f) < N_KCL_FLAG && ((f)&0x1f) == (t) )
#define GET_KCL_TYPE(f) ( (f) < N_KCL_FLAG ? (f)&0x1f : -1 )

enum
{
    KCL_FLAG_UNKNOWN = N_KCL_FLAG,

    KCL_FLAG_CKPT_WARNING,
    KCL_FLAG_CKPT_WARNING_T,
    KCL_FLAG_CKPT_WARNING_TT,
    KCL_FLAG_CKPT_LC,
    KCL_FLAG_CKPT_LC_T,
    KCL_FLAG_CKPT_LC_TT,
    KCL_FLAG_CKPT_MD,
    KCL_FLAG_CKPT_MD_T,
    KCL_FLAG_CKPT_MD_TT,
    KCL_FLAG_CKPT_MD5,
    KCL_FLAG_CKPT_MD5_T,
    KCL_FLAG_CKPT_MD5_TT,
    KCL_FLAG_CKPT_ETC,
    KCL_FLAG_CKPT_ETC_T,
    KCL_FLAG_CKPT_ETC_TT,
    KCL_FLAG_CKPT_TIE_LT,
    KCL_FLAG_CKPT_TIE_RT,
    KCL_FLAG_CKPT_TIE_GROUP_LT,
    KCL_FLAG_CKPT_TIE_GROUP_RT,
    KCL_FLAG_CKPT_TIE_NEXT_LT,
    KCL_FLAG_CKPT_TIE_NEXT_RT,
    KCL_FLAG_CKPT_JGPT,
    KCL_FLAG_JGPT,
    KCL_FLAG_JGPT_AREA,
    KCL_FLAG_KTPT,
    KCL_FLAG_KTPT_AREA,
    KCL_FLAG_ENPT,
    KCL_FLAG_ENPT_SINGLE,
    KCL_FLAG_ENPT_TIE_BI,
    KCL_FLAG_ENPT_TIE_NEXT,
    KCL_FLAG_ENPT_TIE_PREV,
    KCL_FLAG_ENPT_DISPATCH,
    KCL_FLAG_ITPT,
    KCL_FLAG_ITPT_SINGLE,
    KCL_FLAG_ITPT_TIE_BI,
    KCL_FLAG_ITPT_TIE_NEXT,
    KCL_FLAG_ITPT_TIE_PREV,
    KCL_FLAG_ITPT_DISPATCH,
    KCL_FLAG_CNPT_LANDING,
    KCL_FLAG_CNPT_WAY,
    KCL_FLAG_AREA_ARROW,
    KCL_FLAG_AREA_BORDER,
    KCL_FLAG_POTI0,
    KCL_FLAG_POTI1,
    KCL_FLAG_POTI2,
    KCL_FLAG_POTI3,
    KCL_FLAG_ITEMBOX,
    KCL_FLAG_ITEMBOX_ENEMY,
    KCL_FLAG_ITEMBOX_PLAYER,
    KCL_FLAG_ITEMROUTE,
    KCL_FLAG_ITEMROUTE_ENEMY,
    KCL_FLAG_ITEMROUTE_PLAYER,
    KCL_FLAG_KINOKO_GREEN,
    KCL_FLAG_KINOKO_RED,
    KCL_FLAG_BRIDGE,
    KCL_FLAG_DOKAN,
    KCL_FLAG_KAREHAYAMA,
    KCL_FLAG_OBAKEBLOCK,
    KCL_FLAG_TREE_CROWN,
    KCL_FLAG_TREE_TRUNK,
    KCL_FLAG_WOODBOX,
    KCL_FLAG_COIN_START,
    KCL_FLAG_COIN_RESPAWN,
    KCL_FLAG_COIN_INVALID,
    KCL_FLAG_SOLIDOBJ,
    KCL_FLAG_SOLID_ROUTE,
    KCL_FLAG_DECORATION,
    KCL_FLAG_ZERO_GROUND_BLACK,
    KCL_FLAG_ZERO_GROUND_WHITE,
    KCL_FLAG_RED,
    KCL_FLAG_RED_T,
    KCL_FLAG_RED_TT,
    KCL_FLAG_RED_ORANGE,
    KCL_FLAG_RED_ORANGE_T,
    KCL_FLAG_RED_ORANGE_TT,
    KCL_FLAG_ORANGE,
    KCL_FLAG_ORANGE_T,
    KCL_FLAG_ORANGE_TT,
    KCL_FLAG_ORANGE_YELLOW,
    KCL_FLAG_ORANGE_YELLOW_T,
    KCL_FLAG_ORANGE_YELLOW_TT,
    KCL_FLAG_YELLOW,
    KCL_FLAG_YELLOW_T,
    KCL_FLAG_YELLOW_TT,
    KCL_FLAG_YELLOW_GREEN,
    KCL_FLAG_YELLOW_GREEN_T,
    KCL_FLAG_YELLOW_GREEN_TT,
    KCL_FLAG_GREEN,
    KCL_FLAG_GREEN_T,
    KCL_FLAG_GREEN_TT,
    KCL_FLAG_GREEN_CYAN,
    KCL_FLAG_GREEN_CYAN_T,
    KCL_FLAG_GREEN_CYAN_TT,
    KCL_FLAG_CYAN,
    KCL_FLAG_CYAN_T,
    KCL_FLAG_CYAN_TT,
    KCL_FLAG_CYAN_BLUE,
    KCL_FLAG_CYAN_BLUE_T,
    KCL_FLAG_CYAN_BLUE_TT,
    KCL_FLAG_BLUE,
    KCL_FLAG_BLUE_T,
    KCL_FLAG_BLUE_TT,
    KCL_FLAG_BLUE_MAGENTA,
    KCL_FLAG_BLUE_MAGENTA_T,
    KCL_FLAG_BLUE_MAGENTA_TT,
    KCL_FLAG_MAGENTA,
    KCL_FLAG_MAGENTA_T,
    KCL_FLAG_MAGENTA_TT,
    KCL_FLAG_MAGENTA_RED,
    KCL_FLAG_MAGENTA_RED_T,
    KCL_FLAG_MAGENTA_RED_TT,
    KCL_FLAG_BROWN,
    KCL_FLAG_BROWN_T,
    KCL_FLAG_BROWN_TT,
    KCL_FLAG_WHITE,
    KCL_FLAG_WHITE_T,
    KCL_FLAG_WHITE_TT,
    KCL_FLAG_GREY,
    KCL_FLAG_GREY_T,
    KCL_FLAG_GREY_TT,
    KCL_FLAG_BLACK,
    KCL_FLAG_BLACK_T,
    KCL_FLAG_BLACK_TT,
    KCL_FLAG_GOLD,
    KCL_FLAG_GOLD_T,
    KCL_FLAG_GOLD_TT,
    KCL_FLAG_SILVER,
    KCL_FLAG_SILVER_T,
    KCL_FLAG_SILVER_TT,
    KCL_FLAG_BRONZE,
    KCL_FLAG_BRONZE_T,
    KCL_FLAG_BRONZE_TT,
    KCL_FLAG_TEST0,
    KCL_FLAG_TEST0_T,
    KCL_FLAG_TEST0_TT,
    KCL_FLAG_TEST1,
    KCL_FLAG_TEST1_T,
    KCL_FLAG_TEST1_TT,
    KCL_FLAG_TEST2,
    KCL_FLAG_TEST2_T,
    KCL_FLAG_TEST2_TT,
    KCL_FLAG_TEST3,
    KCL_FLAG_TEST3_T,
    KCL_FLAG_TEST3_TT,
    KCL_FLAG_TEST4,
    KCL_FLAG_TEST4_T,
    KCL_FLAG_TEST4_TT,
    KCL_FLAG_TEST5,
    KCL_FLAG_TEST5_T,
    KCL_FLAG_TEST5_TT,
    KCL_FLAG_TEST6,
    KCL_FLAG_TEST6_T,
    KCL_FLAG_TEST6_TT,
    KCL_FLAG_TEST7,
    KCL_FLAG_TEST7_T,
    KCL_FLAG_TEST7_TT,
    KCL_FLAG_TEST8,
    KCL_FLAG_TEST8_T,
    KCL_FLAG_TEST8_TT,

    NN_KCL_FLAG,

    KCL_FLAG_AUTO_0   = NN_KCL_FLAG,
    KCL_FLAG_AUTO_MAX = KCL_FLAG_AUTO_0 + N_KCL_AUTO_FLAGS - 1,
    KCL_FLAG_USER_0   = KCL_FLAG_AUTO_MAX + 1,
    KCL_FLAG_USER_MAX = KCL_FLAG_USER_0 + N_KCL_USER_FLAGS - 1,
    NNN_KCL_FLAG
};

ccp GetFlagName ( uint kcl_flag );
ccp GetFlagGroupName ( uint kcl_flag );

static inline bool IsAutoFlagKCL ( uint flag )
	    { return flag >= KCL_FLAG_AUTO_0 && flag <= KCL_FLAG_AUTO_MAX; }

static inline bool IsUserFlagKCL ( uint flag )
	    { return flag >= KCL_FLAG_USER_0 && flag <= KCL_FLAG_USER_MAX; }


//
///////////////////////////////////////////////////////////////////////////////
////////////////////////   struct kcl_attrib_name_t   /////////////////////////
///////////////////////////////////////////////////////////////////////////////

typedef struct kcl_attrib_name_t
{
	kcl_attrib_t	attrib;		// attribute
	ccp		name;		// name of attribute

} kcl_attrib_name_t;

extern const kcl_attrib_name_t kcl_attrib_name[N_KCL_ATTRIB+1];


//
///////////////////////////////////////////////////////////////////////////////
///////////////////////////   struct kcl_class_t   ////////////////////////////
///////////////////////////////////////////////////////////////////////////////

typedef struct kcl_class_t
{
	u16		cls;		// class id, index to self
	u16		ncol;		// number of colors in mtl
	u16		color_index;	// first index into kcl_colors[]
	ccp		name;		// short name
	ccp		info;		// description
	kcl_attrib_t	attrib;		// attributes

} kcl_class_t;

extern const kcl_class_t kcl_class[N_KCL_CLASS+1];
extern const u8 kcl_color[N_KCL_COLORS][4];


//
///////////////////////////////////////////////////////////////////////////////
////////////////////////////   struct kcl_type_t   ////////////////////////////
///////////////////////////////////////////////////////////////////////////////

typedef struct kcl_type_t
{
	u16		type;		// type id, index to self
	u16		cls;		// class index
	ccp		info;		// description
	kcl_attrib_t	attrib;		// attributes

} kcl_type_t;

extern const kcl_type_t kcl_type[N_KCL_TYPE+1];


//
///////////////////////////////////////////////////////////////////////////////
///////////////////////////   kcl_color_key_tab[]   ///////////////////////////
///////////////////////////////////////////////////////////////////////////////

extern const KeywordTab_t kcl_color_key_tab[];


//
///////////////////////////////////////////////////////////////////////////////
//////////////////////////////////   E N D   //////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

#endif // SZS_DB_KCL_H