2 // commonly used, but better make them macros
6 // a dummy macro that prevents the "hanging ;" warning
7 #define ENDS_WITH_CURLY_BRACE
9 #ifdef HAVE_YO_DAWG_CPP
10 // TODO make ascii art pic of xzibit
12 // I HERD YO LIEK MACROS
13 // SO I PUT A MACRO DEFINITION IN YO MACRO DEFINITION
14 // SO YO CAN EXPAND MACROS WHILE YO EXPAND MACROS
15 # define ACCUMULATE_FUNCTION(func,otherfunc) \
17 void __merge__##otherfunc() { func(); otherfunc(); } \
19 #define func __merge__##otherfunc \
21 #define func otherfunc \
23 # define CALL_ACCUMULATED_FUNCTION(func) \
26 # define ACCUMULATE_FUNCTION(func,otherfunc) \
27 .float _ACCUMULATE_##func##__##otherfunc
28 void ACCUMULATE_call(string func)
31 float n = numentityfields();
32 string funcprefix = strcat("_ACCUMULATE_", func, "__");
33 float funcprefixlen = strlen(funcprefix);
34 for(i = 0; i < n; ++i)
36 string name = entityfieldname(i);
37 if(substring(name, 0, funcprefixlen) == funcprefix)
38 callfunction(substring(name, funcprefixlen, -1));
41 # define CALL_ACCUMULATED_FUNCTION(func) \
42 ACCUMULATE_call(#func)
45 // used for simplifying ACCUMULATE_FUNCTIONs
46 #define SET_FIRST_OR_LAST(input,first,count) if(!input) { input = (first + count); }
47 #define SET_FIELD_COUNT(field,first,count) if(!field) { field = (first + count); ++count; }
48 #define CHECK_MAX_COUNT(name,max,count,type) if(count > max) { error(strcat("Maximum ", type, " hit: ", #name, ": ", ftos(count), ".\n")); }
50 // 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
51 // NOTE: s IS allowed to be a tempstring
52 string wordwrap(string s, float l);
55 void wordwrap_sprint(string s, float l);
58 void wordwrap_cb(string s, float l, void(string) callback);
61 string draw_currentSkin;
62 string draw_UseSkinFor(string pic);
65 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
66 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
67 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
69 float median(float a, float b, float c);
71 // converts a number to a string with the indicated number of decimals
72 // works for up to 10 decimals!
73 string ftos_decimals(float number, float decimals);
75 float fexists(string f);
77 vector colormapPaletteColor(float c, float isPants);
79 // unzone the string, and return it as tempstring. Safe to be called on string_null
80 string fstrunzone(string s);
82 // database (NOTE: keys are case sensitive)
83 void db_save(float db, string filename);
84 void db_dump(float db, string pFilename);
86 float db_load(string filename);
87 void db_close(float db);
88 string db_get(float db, string key);
89 void db_put(float db, string key, string value);
91 // stringbuffer loading/saving
92 float buf_load(string filename);
93 void buf_save(float buf, string filename);
97 float mod(float a, float b) { return a - (floor(a / b) * b); }
100 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
101 string format_time(float seconds);
102 string mmsss(float t);
103 string mmssss(float t);
105 #define TIME_DECIMALS 2
106 #define TIME_FACTOR 100
107 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
108 #define RACE_RECORD "/race100record/"
109 #define CTS_RECORD "/cts100record/"
110 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
111 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
113 string ScoreString(float vflags, float value);
115 float dotproduct(vector a, vector b);
116 vector cross(vector a, vector b);
118 void compressShortVector_init();
119 vector decompressShortVector(float data);
120 float compressShortVector(vector vec);
123 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
126 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
127 string mapPriorityList(string order, string(string) mapfunc);
128 string swapInPriorityList(string order, float i, float j);
130 float cvar_value_issafe(string s);
132 float cvar_settemp(string pKey, string pValue);
133 float cvar_settemp_restore();
136 // modes: 0 = trust q3map2 (_mini images)
137 // 1 = trust tracebox (_radar images)
138 // in both modes, mapinfo's "size" overrides
143 void get_mi_min_max(float mode);
145 vector mi_picmin; // adjusted mins that map to the picture (square)
146 vector mi_picmax; // adjusted maxs that map to the picture (square)
147 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
148 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
149 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
150 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
151 void get_mi_min_max_texcoords(float mode);
154 float almost_equals(float a, float b);
155 float almost_in_bounds(float a, float b, float c);
157 float power2of(float e);
158 float log2of(float x);
160 const string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
161 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
162 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
163 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
165 vector rgb_to_hsl(vector rgb);
166 vector hsl_to_rgb(vector hsl);
167 vector rgb_to_hsv(vector rgb);
168 vector hsv_to_rgb(vector hsv);
169 string rgb_to_hexcolor(vector rgb);
171 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
172 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
174 typedef float(string s, vector size) textLengthUpToWidth_widthFunction_t;
175 typedef float(string s) textLengthUpToLength_lenFunction_t;
176 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
177 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
178 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
179 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
181 string getWrappedLine_remaining;
182 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
183 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
185 float isGametypeInFilter(float gt, float tp, float ts, string pattern);
187 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
188 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
189 void shuffle(float n, swapfunc_t swap, entity pass);
190 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
192 string swapwords(string str, float i, float j);
193 string shufflewords(string str);
195 string substring_range(string s, float b, float e);
197 vector solve_quadratic(float a, float b, float c);
200 // z = 1 if a real solution exists, 0 if not
201 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
203 vector solve_shotdirection(vector myorg, vector myvel, vector eorg, vector evel, float spd, float newton_style);
204 vector get_shotvelocity(vector myvel, vector mydir, float spd, float newton_style, float mi, float ma);
206 void check_unacceptable_compiler_bugs();
208 float compressShotOrigin(vector v);
209 vector decompressShotOrigin(float f);
212 string rankings_reply, ladder_reply, lsmaps_reply, maplist_reply; // cached replies
213 string records_reply[10];
216 float RandomSelection_totalweight;
217 float RandomSelection_best_priority;
218 entity RandomSelection_chosen_ent;
219 float RandomSelection_chosen_float;
220 string RandomSelection_chosen_string;
221 void RandomSelection_Init();
222 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
225 vector healtharmor_maxdamage(float h, float a, float armorblock, float deathtype); // returns vector: maxdamage, armorideal, 1 if fully armored
226 vector healtharmor_applydamage(float a, float armorblock, float deathtype, float damage); // returns vector: take, save, 0
229 string getcurrentmod();
234 vector ReadInt48_t();
235 vector ReadInt72_t();
237 void WriteInt24_t(float dest, float val);
238 void WriteInt48_t(float dest, vector val);
239 void WriteInt72_t(float dest, vector val);
245 #define func_null nil
246 #define string_null nil
248 var void func_null(void);
249 var string string_null;
251 float float2range11(float f);
252 float float2range01(float f);
254 float gsl_ran_gaussian(float sigma);
256 string car(string s); // returns first word
257 string cdr(string s); // returns all but first word
258 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
259 float startsWith(string haystack, string needle);
260 float startsWithNocase(string haystack, string needle);
262 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
263 string get_model_parameters_modelname;
264 float get_model_parameters_modelskin;
265 string get_model_parameters_name;
266 float get_model_parameters_species;
267 string get_model_parameters_sex;
268 float get_model_parameters_weight;
269 float get_model_parameters_age;
270 string get_model_parameters_bone_upperbody;
271 string get_model_parameters_bone_weapon;
272 #define MAX_AIM_BONES 4
273 string get_model_parameters_bone_aim[MAX_AIM_BONES];
274 float get_model_parameters_bone_aimweight[MAX_AIM_BONES];
275 float get_model_parameters_fixbone;
276 string get_model_parameters_desc;
277 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
279 vector vec2(vector v);
282 vector NearestPointOnBox(entity box, vector org);
285 float vercmp(string v1, string v2);
287 float u8_strsize(string s);
289 // translation helpers
290 string prvm_language;
291 string language_filename(string s);
292 string CTX(string s);
293 #define ZCTX(s) strzone(CTX(s))
295 // x-encoding (encoding as zero length invisible string)
296 // encodes approx. 14 bits into 5 bytes of color code string
297 const float XENCODE_MAX = 21295; // 2*22*22*22-1
298 const float XENCODE_LEN = 5;
299 string xencode(float f);
300 float xdecode(string s);
302 #ifndef COMPAT_XON010_CHANNELS
303 #define sound(e,c,s,v,a) sound7(e,c,s,v,a,0,0)
306 float lowestbit(float f);
309 entity ReadCSQCEntity();
313 string strtolower(string s);
316 string MakeConsoleSafe(string input);
319 float InterpretBoolean(string input);
322 // generic shutdown handler
326 .float skeleton_bones;
327 void Skeleton_SetBones(entity e);
328 // loops through the tags of model v using counter tagnum
329 #define FOR_EACH_TAG(v) float tagnum; Skeleton_SetBones(v); for(tagnum = 0; tagnum < v.skeleton_bones; tagnum++, gettaginfo(v, tagnum))
332 void WriteApproxPastTime(float dst, float t);
335 float ReadApproxPastTime();
338 // execute-stuff-next-frame subsystem
339 void execute_next_frame();
340 void queue_to_execute_next_frame(string s);
342 // for marking written-to values as unused where it's a good idea to do this
343 noref float unused_float;
345 // a function f with:
348 // f'(0) = startspeedfactor
349 // f'(1) = endspeedfactor
350 float cubic_speedfunc(float startspeedfactor, float endspeedfactor, float x);
352 // checks whether f'(x) = 0 anywhere from 0 to 1
353 // because if this is the case, the function is not usable for platforms
354 // as it may exceed 0..1 bounds, or go in reverse
355 float cubic_speedfunc_is_sane(float startspeedfactor, float endspeedfactor);
357 typedef entity(entity cur, entity near, entity pass) findNextEntityNearFunction_t;
358 typedef float(entity a, entity b, entity pass) isConnectedFunction_t;
359 void FindConnectedComponent(entity e, .entity fld, findNextEntityNearFunction_t nxt, isConnectedFunction_t iscon, entity pass);
361 // expand multiple arguments into one argument by stripping parenthesis
362 #define XPD(...) __VA_ARGS__
365 void backtrace(string msg);
368 // color code replace, place inside of sprintf and parse the string... defaults described as constants
369 // foreground/normal colors
370 var string autocvar_hud_colorset_foreground_1 = "2"; // F1 - Green // primary priority (important names, etc)
371 var string autocvar_hud_colorset_foreground_2 = "3"; // F2 - Yellow // secondary priority (items, locations, numbers, etc)
372 var string autocvar_hud_colorset_foreground_3 = "4"; // F3 - Blue // tertiary priority or relatively inconsequential text
373 var string autocvar_hud_colorset_foreground_4 = "1"; // F4 - Red // notice/attention grabbing texting
375 var string autocvar_hud_colorset_kill_1 = "1"; // K1 - Red // "bad" or "dangerous" text (death messages against you, kill notifications, etc)
376 var string autocvar_hud_colorset_kill_2 = "3"; // K2 - Yellow // similar to above, but less important... OR, a highlight out of above message type
377 var string autocvar_hud_colorset_kill_3 = "4"; // K3 - Blue // "good" or "beneficial" text (you fragging someone, etc)
379 var string autocvar_hud_colorset_background = "7"; // BG - White // neutral/unimportant text
381 string CCR(string input);
385 #define GENTLE (autocvar_cl_gentle || autocvar_cl_gentle_messages)
387 #define GENTLE autocvar_sv_gentle
389 #define normal_or_gentle(normal,gentle) (GENTLE ? ((gentle != "") ? gentle : normal) : normal)
392 // allow writing to also pass through to spectators (like so spectators see the same centerprints as players for example)
393 #define WRITESPECTATABLE_MSG_ONE_VARNAME(varname,statement) entity varname; varname = msg_entity; FOR_EACH_REALCLIENT(msg_entity) if(msg_entity == varname || (msg_entity.classname == STR_SPECTATOR && msg_entity.enemy == varname)) statement msg_entity = varname
394 #define WRITESPECTATABLE_MSG_ONE(statement) WRITESPECTATABLE_MSG_ONE_VARNAME(oldmsg_entity, statement)
395 #define WRITESPECTATABLE(msg,statement) if(msg == MSG_ONE) { WRITESPECTATABLE_MSG_ONE(statement); } else statement float WRITESPECTATABLE_workaround = 0
397 vector vec3(float x, float y, float z);
400 vector animfixfps(entity e, vector a, vector b);
404 void dedicated_print(string input);
407 // todo: better way to do this?
409 #define PROGNAME "MENUQC"
412 #define PROGNAME "SVQC"
414 #define PROGNAME "CSQC"
420 #define CNT_GAMESTART 2
423 #define CNT_RESPAWN 5
424 #define CNT_ROUNDSTART 6
425 float Announcer_PickNumber(float type, float num);