1 // a dummy macro that prevents the "hanging ;" warning
2 #define ENDS_WITH_CURLY_BRACE
4 #ifdef HAVE_YO_DAWG_CPP
5 // TODO make ascii art pic of xzibit
7 // I HERD YO LIEK MACROS
8 // SO I PUT A MACRO DEFINITION IN YO MACRO DEFINITION
9 // SO YO CAN EXPAND MACROS WHILE YO EXPAND MACROS
10 # define ACCUMULATE_FUNCTION(func,otherfunc) \
12 void __merge__##otherfunc() { func(); otherfunc(); } \
14 #define func __merge__##otherfunc \
16 #define func otherfunc \
18 # define CALL_ACCUMULATED_FUNCTION(func) \
21 # define ACCUMULATE_FUNCTION(func,otherfunc) \
22 .void _ACCUMULATE_##func##__##otherfunc;
23 void ACCUMULATE_call(string func)
26 float n = numentityfields();
27 string funcprefix = strcat("_ACCUMULATE_", func, "__");
28 float funcprefixlen = strlen(funcprefix);
29 for(i = 0; i < n; ++i)
31 string name = entityfieldname(i);
32 if(substring(name, 0, funcprefixlen) == funcprefix)
33 callfunction(substring(name, funcprefixlen, -1));
36 # define CALL_ACCUMULATED_FUNCTION(func) \
37 ACCUMULATE_call(#func)
40 // this returns a tempstring containing a copy of s with additional \n newlines added, it also replaces \n in the text with a real newline
41 // NOTE: s IS allowed to be a tempstring
42 string wordwrap(string s, float l);
45 void wordwrap_sprint(string s, float l);
48 void wordwrap_cb(string s, float l, void(string) callback);
51 string draw_currentSkin;
52 string draw_UseSkinFor(string pic);
55 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
56 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
57 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
59 float median(float a, float b, float c);
61 // converts a number to a string with the indicated number of decimals
62 // works for up to 10 decimals!
63 string ftos_decimals(float number, float decimals);
65 float fexists(string f);
67 vector colormapPaletteColor(float c, float isPants);
69 // unzone the string, and return it as tempstring. Safe to be called on string_null
70 string fstrunzone(string s);
72 // database (NOTE: keys are case sensitive)
73 void db_save(float db, string filename);
74 void db_dump(float db, string pFilename);
76 float db_load(string filename);
77 void db_close(float db);
78 string db_get(float db, string key);
79 void db_put(float db, string key, string value);
81 // stringbuffer loading/saving
82 float buf_load(string filename);
83 void buf_save(float buf, string filename);
87 float mod(float a, float b) { return a - (floor(a / b) * b); }
90 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
91 string mmsss(float t);
92 string mmssss(float t);
94 #define TIME_DECIMALS 2
95 #define TIME_FACTOR 100
96 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
97 #define RACE_RECORD "/race100record/"
98 #define CTS_RECORD "/cts100record/"
99 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
100 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
102 string ScoreString(float vflags, float value);
104 float dotproduct(vector a, vector b);
105 vector cross(vector a, vector b);
107 void compressShortVector_init();
108 vector decompressShortVector(float data);
109 float compressShortVector(vector vec);
112 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
115 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
116 string mapPriorityList(string order, string(string) mapfunc);
117 string swapInPriorityList(string order, float i, float j);
119 float cvar_value_issafe(string s);
121 float cvar_settemp(string pKey, string pValue);
122 float cvar_settemp_restore();
125 // modes: 0 = trust q3map2 (_mini images)
126 // 1 = trust tracebox (_radar images)
127 // in both modes, mapinfo's "size" overrides
132 void get_mi_min_max(float mode);
134 vector mi_picmin; // adjusted mins that map to the picture (square)
135 vector mi_picmax; // adjusted maxs that map to the picture (square)
136 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
137 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
138 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
139 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
140 void get_mi_min_max_texcoords(float mode);
144 #define FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(x) void reference_##x() { x = x; }
146 #define FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(x)
149 float almost_equals(float a, float b);
150 float almost_in_bounds(float a, float b, float c);
152 float power2of(float e);
153 float log2of(float x);
155 string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
156 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
157 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
158 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
160 vector rgb_to_hsl(vector rgb);
161 vector hsl_to_rgb(vector hsl);
162 vector rgb_to_hsv(vector rgb);
163 vector hsv_to_rgb(vector hsv);
164 string rgb_to_hexcolor(vector rgb);
166 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
167 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
169 typedef float(string s, vector size) textLengthUpToWidth_widthFunction_t;
170 typedef float(string s) textLengthUpToLength_lenFunction_t;
171 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
172 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
173 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
174 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
176 string getWrappedLine_remaining;
177 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
178 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
180 float isGametypeInFilter(float gt, float tp, float ts, string pattern);
182 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
183 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
184 void shuffle(float n, swapfunc_t swap, entity pass);
185 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
187 string swapwords(string str, float i, float j);
188 string shufflewords(string str);
190 string substring_range(string s, float b, float e);
192 vector solve_quadratic(float a, float b, float c);
195 // z = 1 if a real solution exists, 0 if not
196 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
198 vector solve_shotdirection(vector myorg, vector myvel, vector eorg, vector evel, float spd, float newton_style);
199 vector get_shotvelocity(vector myvel, vector mydir, float spd, float newton_style, float mi, float ma);
201 void check_unacceptable_compiler_bugs();
203 float compressShotOrigin(vector v);
204 vector decompressShotOrigin(float f);
207 string rankings_reply, ladder_reply, lsmaps_reply, lsnewmaps_reply, maplist_reply; // cached replies
208 string records_reply[10];
211 float RandomSelection_totalweight;
212 float RandomSelection_best_priority;
213 entity RandomSelection_chosen_ent;
214 float RandomSelection_chosen_float;
215 string RandomSelection_chosen_string;
216 void RandomSelection_Init();
217 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
219 vector healtharmor_maxdamage(float h, float a, float armorblock); // returns vector: maxdamage, armorideal, 1 if fully armored
220 vector healtharmor_applydamage(float a, float armorblock, float damage); // returns vector: take, save, 0
222 string getcurrentmod();
228 void WriteInt24_t(float dest, float val);
233 var void func_null(void); FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(func_null)
234 var string string_null;
235 float float2range11(float f);
236 float float2range01(float f);
238 float gsl_ran_gaussian(float sigma);
240 string car(string s); // returns first word
241 string cdr(string s); // returns all but first word
242 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
243 float startsWith(string haystack, string needle);
244 float startsWithNocase(string haystack, string needle);
246 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
247 string get_model_parameters_modelname;
248 float get_model_parameters_modelskin;
249 string get_model_parameters_name;
250 float get_model_parameters_species;
251 string get_model_parameters_sex;
252 float get_model_parameters_weight;
253 float get_model_parameters_age;
254 string get_model_parameters_desc;
255 float get_model_parameters(string mod, float skn); // call with string_null to clear; skin -1 means mod is the filename of the txt file and is to be split
257 // stupid stupid stupid FTEQCC has a max limit on macro sizes, let's work around by splitting the macro into two macros! :(
258 #define HUD_Panel_GetName_Part2(id) \
260 case HUD_PANEL_ENGINEINFO: panel_name = HUD_PANELNAME_ENGINEINFO; break; \
261 case HUD_PANEL_INFOMESSAGES: panel_name = HUD_PANELNAME_INFOMESSAGES; break; \
262 case HUD_PANEL_PHYSICS: panel_name = HUD_PANELNAME_PHYSICS; break; \
263 case HUD_PANEL_CENTERPRINT: panel_name = HUD_PANELNAME_CENTERPRINT; break; \
264 } ENDS_WITH_CURLY_BRACE
266 // Get name of specified panel id
267 #define HUD_Panel_GetName(id) \
269 case HUD_PANEL_WEAPONS: panel_name = HUD_PANELNAME_WEAPONS; break; \
270 case HUD_PANEL_AMMO: panel_name = HUD_PANELNAME_AMMO; break; \
271 case HUD_PANEL_POWERUPS: panel_name = HUD_PANELNAME_POWERUPS; break; \
272 case HUD_PANEL_HEALTHARMOR: panel_name = HUD_PANELNAME_HEALTHARMOR; break; \
273 case HUD_PANEL_NOTIFY: panel_name = HUD_PANELNAME_NOTIFY; break; \
274 case HUD_PANEL_TIMER: panel_name = HUD_PANELNAME_TIMER; break; \
275 case HUD_PANEL_RADAR: panel_name = HUD_PANELNAME_RADAR; break; \
276 case HUD_PANEL_SCORE: panel_name = HUD_PANELNAME_SCORE; break; \
277 case HUD_PANEL_RACETIMER: panel_name = HUD_PANELNAME_RACETIMER; break; \
278 case HUD_PANEL_VOTE: panel_name = HUD_PANELNAME_VOTE; break; \
279 case HUD_PANEL_MODICONS: panel_name = HUD_PANELNAME_MODICONS; break; \
280 case HUD_PANEL_PRESSEDKEYS: panel_name = HUD_PANELNAME_PRESSEDKEYS; break; \
281 case HUD_PANEL_CHAT: panel_name = HUD_PANELNAME_CHAT; break; \
282 default: HUD_Panel_GetName_Part2(id)\
285 vector vec2(vector v);
288 vector NearestPointOnBox(entity box, vector org);
291 float vercmp(string v1, string v2);
293 float u8_strsize(string s);
295 // translation helpers
296 string prvm_language;
297 string language_filename(string s);
298 string CTX(string s);
299 #define ZCTX(s) strzone(CTX(s))
301 // x-encoding (encoding as zero length invisible string)
302 // encodes approx. 14 bits into 5 bytes of color code string
303 const float XENCODE_MAX = 21295; // 2*22*22*22-1
304 const float XENCODE_LEN = 5;
305 string xencode(float f);
306 float xdecode(string s);
308 #ifndef COMPAT_XON010_CHANNELS
309 #define sound(e,c,s,v,a) sound7(e,c,s,v,a,0,0)
312 float lowestbit(float f);
315 entity ReadCSQCEntity();
319 string strtolower(string s);
322 string MakeConsoleSafe(string input);
325 float InterpretBoolean(string input);
328 // generic shutdown handler
332 .float skeleton_bones;
333 void Skeleton_SetBones(entity e);
334 // loops through the tags of model v using counter tagnum
335 #define FOR_EACH_TAG(v) float tagnum; Skeleton_SetBones(v); for(tagnum = 0; tagnum < v.skeleton_bones; tagnum++, gettaginfo(v, tagnum))
338 void WriteApproxPastTime(float dst, float t);
341 float ReadApproxPastTime();
344 // execute-stuff-next-frame subsystem
345 void execute_next_frame();
346 void queue_to_execute_next_frame(string s);
348 // for marking written-to values as unused where it's a good idea to do this
349 noref float unused_float;
353 // a function f with:
356 // f'(0) = startspeedfactor
357 // f'(1) = endspeedfactor
358 float cubic_speedfunc(float startspeedfactor, float endspeedfactor, float x);
360 // checks whether f'(x) = 0 anywhere from 0 to 1
361 // because if this is the case, the function is not usable for platforms
362 // as it may exceed 0..1 bounds, or go in reverse
363 float cubic_speedfunc_is_sane(float startspeedfactor, float endspeedfactor);
365 typedef entity(entity cur, entity near, entity pass) findNextEntityNearFunction_t;
366 typedef float(entity a, entity b, entity pass) isConnectedFunction_t;
367 void FindConnectedComponent(entity e, .entity fld, findNextEntityNearFunction_t nxt, isConnectedFunction_t iscon, entity pass);