Gametypes: propagate entity references, set limit to 24 due to use of bitflags
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / util.qh
1 #ifndef COMMON_UTIL_H
2 #define COMMON_UTIL_H
3
4 #ifndef MENUQC
5
6 vector real_origin(entity ent);
7 #endif
8
9 // 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
10 // NOTE: s IS allowed to be a tempstring
11 string wordwrap(string s, float l);
12 #ifndef MENUQC
13 #ifndef CSQC
14 void wordwrap_sprint(entity to, string s, float l);
15 #endif
16 #endif
17 void wordwrap_cb(string s, float l, void(string) callback);
18
19 #ifndef SVQC
20 string draw_currentSkin;
21 string draw_UseSkinFor(string pic);
22 #endif
23
24 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
25 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
26 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
27
28 float median(float a, float b, float c);
29
30 // converts a number to a string with the indicated number of decimals
31 string ftos_decimals(float number, float decimals);
32 string ftos_mindecimals(float number);
33
34 bool fexists(string f);
35
36 // unzone the string, and return it as tempstring. Safe to be called on string_null
37 string fstrunzone(string s);
38
39 // database (NOTE: keys are case sensitive)
40 void db_save(int db, string filename);
41 void db_dump(int db, string pFilename);
42 int db_create();
43 int db_load(string filename);
44 void db_close(int db);
45 string db_get(int db, string key);
46 void db_put(int db, string key, string value);
47
48 // stringbuffer loading/saving
49 int buf_load(string filename);
50 void buf_save(int buf, string filename);
51
52 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
53 string format_time(float seconds);
54 string mmsss(float t);
55 string mmssss(float t);
56
57 const float TIME_DECIMALS = 2;
58 const float TIME_FACTOR = 100;
59 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
60 #define RACE_RECORD "/race100record/"
61 #define CTS_RECORD "/cts100record/"
62 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
63 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
64
65 string ScoreString(float vflags, float value);
66
67 vector decompressShortVector(float data);
68 float compressShortVector(vector vec);
69
70 #ifndef MENUQC
71 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
72 #endif
73
74 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
75 string mapPriorityList(string order, string(string) mapfunc);
76 string swapInPriorityList(string order, float i, float j);
77
78 float cvar_value_issafe(string s);
79
80 float cvar_settemp(string pKey, string pValue);
81 float cvar_settemp_restore();
82
83 #ifndef MENUQC
84 // modes: 0 = trust q3map2 (_mini images)
85 //        1 = trust tracebox (_radar images)
86 // in both modes, mapinfo's "size" overrides
87
88 string mi_shortname;
89 vector mi_min;
90 vector mi_max;
91 void get_mi_min_max(float mode);
92
93 vector mi_picmin; // adjusted mins that map to the picture (square)
94 vector mi_picmax; // adjusted maxs that map to the picture (square)
95 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
96 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
97 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
98 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
99 void get_mi_min_max_texcoords(float mode);
100 #endif
101
102 float almost_equals(float a, float b);
103 float almost_in_bounds(float a, float b, float c);
104
105 float power2of(float e);
106 float log2of(float x);
107
108 vector rgb_to_hsl(vector rgb);
109 vector hsl_to_rgb(vector hsl);
110 vector rgb_to_hsv(vector rgb);
111 vector hsv_to_rgb(vector hsv);
112 string rgb_to_hexcolor(vector rgb);
113
114 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
115 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
116
117 USING(textLengthUpToWidth_widthFunction_t, float(string s, vector size));
118 USING(textLengthUpToLength_lenFunction_t, float(string s));
119 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
120 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
121 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
122 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
123
124 string getWrappedLine_remaining;
125 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
126 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
127
128 float isGametypeInFilter(entity gt, float tp, float ts, string pattern);
129
130 string swapwords(string str, float i, float j);
131 string shufflewords(string str);
132
133 string substring_range(string s, float b, float e);
134
135 vector solve_quadratic(float a, float b, float c);
136 // solution 1 -> x
137 // solution 2 -> y
138 // z = 1 if a real solution exists, 0 if not
139 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
140
141 vector solve_shotdirection(vector myorg, vector myvel, vector eorg, vector evel, float spd, float newton_style);
142 vector get_shotvelocity(vector myvel, vector mydir, float spd, float newton_style, float mi, float ma);
143
144 float compressShotOrigin(vector v);
145 vector decompressShotOrigin(float f);
146
147 #ifdef SVQC
148 string rankings_reply, ladder_reply, lsmaps_reply, maplist_reply, monsterlist_reply; // cached replies
149 string records_reply[10];
150 #endif
151
152 #ifndef MENUQC
153 vector healtharmor_maxdamage(float h, float a, float armorblock, int deathtype); // returns vector: maxdamage, armorideal, 1 if fully armored
154 vector healtharmor_applydamage(float a, float armorblock, int deathtype, float damage); // returns vector: take, save, 0
155 #endif
156
157 string getcurrentmod();
158
159 #ifndef MENUQC
160 #ifdef CSQC
161 int ReadInt24_t();
162 #else
163 void WriteInt24_t(float dest, float val);
164 void WriteInt48_t(float dest, vector val);
165 void WriteInt72_t(float dest, vector val);
166 #endif
167 #endif
168
169 float float2range11(float f);
170 float float2range01(float f);
171
172 float gsl_ran_gaussian(float sigma);
173
174 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
175
176 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
177 string get_model_parameters_modelname;
178 float get_model_parameters_modelskin;
179 string get_model_parameters_name;
180 float get_model_parameters_species;
181 string get_model_parameters_sex;
182 float get_model_parameters_weight;
183 float get_model_parameters_age;
184 string get_model_parameters_description;
185 string get_model_parameters_bone_upperbody;
186 string get_model_parameters_bone_weapon;
187 const int MAX_AIM_BONES = 4;
188 string get_model_parameters_bone_aim[MAX_AIM_BONES];
189 float get_model_parameters_bone_aimweight[MAX_AIM_BONES];
190 float get_model_parameters_fixbone;
191 string get_model_parameters_desc;
192 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
193
194 #ifndef MENUQC
195 vector NearestPointOnBox(entity box, vector org);
196 #endif
197
198 float vercmp(string v1, string v2);
199
200 float u8_strsize(string s);
201
202 // x-encoding (encoding as zero length invisible string)
203 // encodes approx. 14 bits into 5 bytes of color code string
204 const float XENCODE_MAX = 21295; // 2*22*22*22-1
205 const float XENCODE_LEN = 5;
206 string xencode(float f);
207 float xdecode(string s);
208
209 #ifndef MENUQC
210 string strtolower(string s);
211 #endif
212
213 string MakeConsoleSafe(string input);
214
215 // generic shutdown handler
216 void Shutdown();
217
218 #ifndef MENUQC
219 .float skeleton_bones;
220 void Skeleton_SetBones(entity e);
221 // loops through the tags of model v using counter tagnum
222 #define FOR_EACH_TAG(v) float tagnum; Skeleton_SetBones(v); for(tagnum = 0; tagnum < v.skeleton_bones; tagnum++, gettaginfo(v, tagnum))
223 #endif
224 #ifdef SVQC
225 void WriteApproxPastTime(float dst, float t);
226 #endif
227 #ifdef CSQC
228 float ReadApproxPastTime();
229 #endif
230
231 // execute-stuff-next-frame subsystem
232 void execute_next_frame();
233 void queue_to_execute_next_frame(string s);
234
235 // for marking written-to values as unused where it's a good idea to do this
236 noref float unused_float;
237
238 // a function f with:
239 // f(0) = 0
240 // f(1) = 1
241 // f'(0) = startspeedfactor
242 // f'(1) = endspeedfactor
243 float cubic_speedfunc(float startspeedfactor, float endspeedfactor, float x);
244
245 // checks whether f'(x) = 0 anywhere from 0 to 1
246 // because if this is the case, the function is not usable for platforms
247 // as it may exceed 0..1 bounds, or go in reverse
248 float cubic_speedfunc_is_sane(float startspeedfactor, float endspeedfactor);
249
250 USING(findNextEntityNearFunction_t, entity(entity cur, entity near, entity pass));
251 USING(isConnectedFunction_t, float(entity a, entity b, entity pass));
252 void FindConnectedComponent(entity e, .entity fld, findNextEntityNearFunction_t nxt, isConnectedFunction_t iscon, entity pass);
253
254 // expand multiple arguments into one argument by stripping parenthesis
255 #define XPD(...) __VA_ARGS__
256
257 // Some common varargs functions. Lowercase as they match C.
258 #define fprintf(file, ...) fputs(file, sprintf(__VA_ARGS__))
259 #define bprintf(...) bprint(sprintf(__VA_ARGS__))
260
261 string CCR(string input);
262
263 #ifndef MENUQC
264         #ifdef CSQC
265                 #define GENTLE (autocvar_cl_gentle || autocvar_cl_gentle_messages)
266         #else
267                 #define GENTLE autocvar_sv_gentle
268         #endif
269         #define normal_or_gentle(normal, gentle) (GENTLE ? ((gentle != "") ? gentle : normal) : normal)
270 #endif
271
272 #ifndef MENUQC
273 vector animfixfps(entity e, vector a, vector b);
274 #endif
275
276 #ifndef MENUQC
277 const float CNT_NORMAL = 1;
278 const float CNT_GAMESTART = 2;
279 const float CNT_IDLE = 3;
280 const float CNT_KILL = 4;
281 const float CNT_RESPAWN = 5;
282 const float CNT_ROUNDSTART = 6;
283 entity Announcer_PickNumber(float type, float num);
284 #endif
285
286 #ifndef MENUQC
287 int Mod_Q1BSP_SuperContentsFromNativeContents(int nativecontents);
288 int Mod_Q1BSP_NativeContentsFromSuperContents(int supercontents);
289 #endif
290
291 // Quadratic splines (bezier)
292 vector bezier_quadratic_getpoint(vector a, vector p, vector b, float t);
293 vector bezier_quadratic_getderivative(vector a, vector p, vector b, float t);
294
295 #define APPEND_TO_STRING(list,sep,add) ((list) = (((list) != "") ? strcat(list, sep, add) : (add)))
296
297 // Returns the correct difference between two always increasing numbers
298 #define COMPARE_INCREASING(to,from) (to < from ? from + to + 2 : to - from)
299 #endif