shadowmapping menu option
[divverent/nexuiz.git] / data / qcsrc / common / util.qh
1 // note: this is in util.qh so it is included as early as possible.
2 var void(string s, ...) dprint;
3 void dprint_null() { }
4 void dprint_load()
5 {
6         if(cvar("developer") > 0)
7                 dprint = print;
8         else
9                 dprint = dprint_null;
10 }
11
12 // 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
13 // NOTE: s IS allowed to be a tempstring
14 string wordwrap(string s, float l);
15 #ifndef MENUQC
16 #ifndef CSQC
17 void wordwrap_sprint(string s, float l);
18 #endif
19 #endif
20 void wordwrap_cb(string s, float l, void(string) callback)
21
22 float GameCommand_Generic(string cmd);
23 // returns TRUE if handled, FALSE otherwise
24 // uses tokenize on its argument!
25
26 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
27 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
28 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
29
30 float median(float a, float b, float c);
31
32 // converts a number to a string with the indicated number of decimals
33 // works for up to 10 decimals!
34 string ftos_decimals(float number, float decimals);
35
36 vector colormapPaletteColor(float c, float isPants);
37
38 // unzone the string, and return it as tempstring. Safe to be called on string_null
39 string fstrunzone(string s);
40
41 // database (NOTE: keys are case sensitive)
42 void db_save(float db, string filename);
43 void db_dump(float db, string pFilename);
44 float db_create();
45 float db_load(string filename);
46 void db_close(float db);
47 string db_get(float db, string key);
48 void db_put(float db, string key, string value);
49
50 // stringbuffer loading/saving
51 float buf_load(string filename);
52 void buf_save(float buf, string filename);
53
54 // modulo function
55 #ifndef MENUQC
56 float mod(float a, float b) { return a - (floor(a / b) * b); }   
57 #endif
58
59 string GametypeNameFromType(float g);
60 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
61 string mmsss(float t);
62 string mmssss(float t);
63
64 #define TIME_DECIMALS 2
65 #define TIME_FACTOR 100
66 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
67 #define RACE_RECORD "/race100record/"
68 #define CTS_RECORD "/cts100record/"
69 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
70 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
71
72 string ScoreString(float vflags, float value);
73
74 vector cross(vector a, vector b);
75
76 void compressShortVector_init();
77 vector decompressShortVector(float data);
78 float compressShortVector(vector vec);
79
80 #ifndef MENUQC
81 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
82
83 void fixedmakevectors(vector a);
84 #define fixedvectoangles2 vectoangles2
85 #define fixedvectoangles vectoangles
86 #endif
87
88 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
89 string swapInPriorityList(string order, float i, float j);
90
91 float cvar_value_issafe(string s);
92
93 void cvar_settemp(string pKey, string pValue);
94 void cvar_settemp_restore();
95
96 #ifndef MENUQC
97 // modes: 0 = trust q3map2 (_mini images)
98 //        1 = trust tracebox (_radar images)
99 // in both modes, mapinfo's "size" overrides
100
101 string mi_shortname;
102 vector mi_min;
103 vector mi_max;
104 void get_mi_min_max(float mode);
105
106 vector mi_picmin; // adjusted mins that map to the picture (square)
107 vector mi_picmax; // adjusted maxs that map to the picture (square)
108 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
109 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
110 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
111 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
112 void get_mi_min_max_texcoords(float mode);
113 #endif
114
115 #define FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(x) void reference_##x() { x = x; }
116
117 float almost_equals(float a, float b);
118 float almost_in_bounds(float a, float b, float c);
119
120 float power2of(float e);
121 float log2of(float x);
122
123 string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
124 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
125 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
126 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
127
128 vector rgb_to_hsl(vector rgb);
129 vector hsl_to_rgb(vector hsl);
130 vector rgb_to_hsv(vector rgb);
131 vector hsv_to_rgb(vector hsv);
132 string rgb_to_hexcolor(vector rgb);
133
134 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
135 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
136
137 #ifndef MENUQC
138 vector AnglesTransform_Apply(vector transform, vector v);
139 vector AnglesTransform_Multiply(vector t1, vector t2);
140 vector AnglesTransform_Invert(vector transform);
141 vector AnglesTransform_TurnDirection(vector transform);
142 vector AnglesTransform_Divide(vector to_transform, vector from_transform);
143 #endif
144
145 typedef float(string s) textLengthUpToWidth_widthFunction_t;
146 float textLengthUpToWidth(string theText, float maxWidth, textLengthUpToWidth_widthFunction_t tw);
147 string textShortenToWidth(string theText, float maxWidth, textLengthUpToWidth_widthFunction_t tw);
148
149 string getWrappedLine_remaining;
150 string getWrappedLine(float w, textLengthUpToWidth_widthFunction_t tw);
151
152 float isGametypeInFilter(float gt, float tp, string pattern);
153
154 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
155 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
156 void shuffle(float n, swapfunc_t swap, entity pass);
157 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
158
159 string swapwords(string str, float i, float j);
160 string shufflewords(string str);
161
162 string substring_range(string s, float b, float e);
163
164 vector solve_quadratic(float a, float b, float c);
165 // solution 1 -> x
166 // solution 2 -> y
167 // z = 1 if a real solution exists, 0 if not
168 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
169
170 void check_unacceptable_compiler_bugs();
171
172 float compressShotOrigin(vector v);
173 vector decompressShotOrigin(float f);
174
175 string records_reply, lsmaps_reply, maplist_reply; // cached replies
176
177 float RandomSelection_totalweight;
178 float RandomSelection_best_priority;
179 entity RandomSelection_chosen_ent;
180 float RandomSelection_chosen_float;
181 string RandomSelection_chosen_string;
182 void RandomSelection_Init();
183 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
184
185 vector healtharmor_maxdamage(float h, float a, float armorblock); // returns vector: maxdamage, armorideal, 1 if fully armored
186 vector healtharmor_applydamage(float a, float armorblock, float damage); // returns vector: take, save, 0
187
188 string getcurrentmod();
189
190 #ifndef MENUQC
191 #ifdef CSQC
192 float ReadInt24_t();
193 #else
194 void WriteInt24_t(float dest, float val);
195 #endif
196 #endif
197
198 // the NULL function
199 const var void func_null(void);
200 const var string string_null;