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 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 #ifdef GAMEQC
 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 float float2range11(float f);
 160 float float2range01(float f);
 161
 162 float gsl_ran_gaussian(float sigma);
 163
 164 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
 165
 166 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
 167 string get_model_parameters_modelname;
 168 float get_model_parameters_modelskin;
 169 string get_model_parameters_name;
 170 float get_model_parameters_species;
 171 string get_model_parameters_sex;
 172 float get_model_parameters_weight;
 173 float get_model_parameters_age;
 174 bool get_model_parameters_hidden;
 175 string get_model_parameters_description;
 176 string get_model_parameters_bone_upperbody;
 177 string get_model_parameters_bone_weapon;
 178 const int MAX_AIM_BONES = 4;
 179 string get_model_parameters_bone_aim[MAX_AIM_BONES];
 180 float get_model_parameters_bone_aimweight[MAX_AIM_BONES];
 181 float get_model_parameters_fixbone;
 182 string get_model_parameters_desc;
 183 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
 184
 185 #ifdef GAMEQC
 186 vector NearestPointOnBox(entity box, vector org);
 187 #endif
 188
 189 float vercmp(string v1, string v2);
 190
 191 float u8_strsize(string s);
 192
 193 // x-encoding (encoding as zero length invisible string)
 194 // encodes approx. 14 bits into 5 bytes of color code string
 195 const float XENCODE_MAX = 21295; // 2*22*22*22-1
 196 const float XENCODE_LEN = 5;
 197 string xencode(float f);
 198 float xdecode(string s);
 199
 200 #ifdef GAMEQC
 201 string strtolower(string s);
 202 #endif
 203
 204 string MakeConsoleSafe(string input);
 205
 206 // generic shutdown handler
 207 void Shutdown();
 208
 209 #ifdef GAMEQC
 210 .float skeleton_bones;
 211 void Skeleton_SetBones(entity e);
 212 // loops through the tags of model v using counter tagnum
 213 #define FOR_EACH_TAG(v) float tagnum; Skeleton_SetBones(v); for(tagnum = 0; tagnum < v.skeleton_bones; tagnum++, gettaginfo(v, tagnum))
 214 #endif
 215 #ifdef SVQC
 216 void WriteApproxPastTime(float dst, float t);
 217 #endif
 218 #ifdef CSQC
 219 float ReadApproxPastTime();
 220 #endif
 221
 222 // execute-stuff-next-frame subsystem
 223 void execute_next_frame();
 224 void queue_to_execute_next_frame(string s);
 225
 226 // a function f with:
 227 // f(0) = 0
 228 // f(1) = 1
 229 // f'(0) = startspeedfactor
 230 // f'(1) = endspeedfactor
 231 float cubic_speedfunc(float startspeedfactor, float endspeedfactor, float spd);
 232
 233 // checks whether f'(x) = 0 anywhere from 0 to 1
 234 // because if this is the case, the function is not usable for platforms
 235 // as it may exceed 0..1 bounds, or go in reverse
 236 float cubic_speedfunc_is_sane(float startspeedfactor, float endspeedfactor);
 237
 238 USING(findNextEntityNearFunction_t, entity(entity cur, entity near, entity pass));
 239 USING(isConnectedFunction_t, float(entity a, entity b, entity pass));
 240 void FindConnectedComponent(entity e, .entity fld, findNextEntityNearFunction_t nxt, isConnectedFunction_t iscon, entity pass);
 241
 242 // expand multiple arguments into one argument by stripping parenthesis
 243 #define XPD(...) __VA_ARGS__
 244
 245 // Some common varargs functions. Lowercase as they match C.
 246 #define fprintf(file, ...) fputs(file, sprintf(__VA_ARGS__))
 247 #define bprintf(...) bprint(sprintf(__VA_ARGS__))
 248
 249 #ifdef GAMEQC
 250 string CCR(string input);
 251 #endif
 252
 253 #ifdef GAMEQC
 254         #ifdef CSQC
 255                 #define GENTLE (autocvar_cl_gentle || autocvar_cl_gentle_messages)
 256         #else
 257                 #define GENTLE autocvar_sv_gentle
 258         #endif
 259         #define normal_or_gentle(normal, gentle) (GENTLE ? ((gentle != "") ? gentle : normal) : normal)
 260 #endif
 261
 262 #ifdef GAMEQC
 263 vector animfixfps(entity e, vector a, vector b);
 264 #endif
 265
 266 #ifdef GAMEQC
 267 const float CNT_NORMAL = 1;
 268 const float CNT_GAMESTART = 2;
 269 const float CNT_IDLE = 3;
 270 const float CNT_KILL = 4;
 271 const float CNT_RESPAWN = 5;
 272 const float CNT_ROUNDSTART = 6;
 273 entity Announcer_PickNumber(float type, float num);
 274 #endif
 275
 276 #ifdef GAMEQC
 277 int Mod_Q1BSP_SuperContentsFromNativeContents(int nativecontents);
 278 int Mod_Q1BSP_NativeContentsFromSuperContents(int supercontents);
 279 #endif
 280
 281 // Quadratic splines (bezier)
 282 vector bezier_quadratic_getpoint(vector a, vector p, vector b, float t);
 283 vector bezier_quadratic_getderivative(vector a, vector p, vector b, float t);
 284
 285 #define APPEND_TO_STRING(list,sep,add) ((list) = (((list) != "") ? strcat(list, sep, add) : (add)))
 286
 287 // Returns the correct difference between two always increasing numbers
 288 #define COMPARE_INCREASING(to,from) (to < from ? from + to + 2 : to - from)