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