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 #ifdef RACE_100THS
  65 #define TIME_DECIMALS 2
  66 #define TIME_FACTOR 100
  67 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
  68 #define RACE_RECORD "/race100record/"
  69 #define CTS_RECORD "/cts100record/"
  70 #else
  71 #define TIME_DECIMALS 1
  72 #define TIME_FACTOR 10
  73 #define TIME_ENCODED_TOSTRING(n) mmsss(n)
  74 #define RACE_RECORD "/racerecord/"
  75 #define CTS_RECORD "/ctsrecord/"
  76 #endif
  77 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
  78 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
  79
  80 string ScoreString(float vflags, float value);
  81
  82 vector cross(vector a, vector b);
  83
  84 void compressShortVector_init();
  85 vector decompressShortVector(float data);
  86 float compressShortVector(vector vec);
  87
  88 #ifndef MENUQC
  89 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
  90
  91 void fixedmakevectors(vector a);
  92 #define fixedvectoangles2 vectoangles2
  93 #define fixedvectoangles vectoangles
  94 #endif
  95
  96 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
  97 string swapInPriorityList(string order, float i, float j);
  98
  99 float cvar_value_issafe(string s);
 100
 101 void cvar_settemp(string pKey, string pValue);
 102 void cvar_settemp_restore();
 103
 104 #ifndef MENUQC
 105 // modes: 0 = trust q3map2 (_mini images)
 106 //        1 = trust tracebox (_radar images)
 107 // in both modes, mapinfo's "size" overrides
 108
 109 string mi_shortname;
 110 vector mi_min;
 111 vector mi_max;
 112 void get_mi_min_max(float mode);
 113
 114 vector mi_picmin; // adjusted mins that map to the picture (square)
 115 vector mi_picmax; // adjusted maxs that map to the picture (square)
 116 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
 117 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
 118 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
 119 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
 120 void get_mi_min_max_texcoords(float mode);
 121 #endif
 122
 123 #define FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(x) void reference_##x() { x = x; }
 124
 125 float almost_equals(float a, float b);
 126 float almost_in_bounds(float a, float b, float c);
 127
 128 float power2of(float e);
 129 float log2of(float x);
 130
 131 string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
 132 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
 133 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
 134 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
 135
 136 vector rgb_to_hsl(vector rgb);
 137 vector hsl_to_rgb(vector hsl);
 138 vector rgb_to_hsv(vector rgb);
 139 vector hsv_to_rgb(vector hsv);
 140 string rgb_to_hexcolor(vector rgb);
 141
 142 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
 143 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
 144
 145 #ifndef MENUQC
 146 vector AnglesTransform_Apply(vector transform, vector v);
 147 vector AnglesTransform_Multiply(vector t1, vector t2);
 148 vector AnglesTransform_Invert(vector transform);
 149 vector AnglesTransform_TurnDirection(vector transform);
 150 vector AnglesTransform_Divide(vector to_transform, vector from_transform);
 151 #endif
 152
 153 typedef float(string s, vector size) textLengthUpToWidth_widthFunction_t;
 154 typedef float(string s) textLengthUpToLength_lenFunction_t;
 155 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
 156 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
 157 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
 158 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
 159
 160 string getWrappedLine_remaining;
 161 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
 162 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
 163
 164 float isGametypeInFilter(float gt, float tp, string pattern);
 165
 166 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
 167 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
 168 void shuffle(float n, swapfunc_t swap, entity pass);
 169 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
 170
 171 string swapwords(string str, float i, float j);
 172 string shufflewords(string str);
 173
 174 string substring_range(string s, float b, float e);
 175
 176 vector solve_quadratic(float a, float b, float c);
 177 // solution 1 -> x
 178 // solution 2 -> y
 179 // z = 1 if a real solution exists, 0 if not
 180 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
 181
 182 void check_unacceptable_compiler_bugs();
 183
 184 float compressShotOrigin(vector v);
 185 vector decompressShotOrigin(float f);
 186
 187 string records_reply, lsmaps_reply, maplist_reply; // cached replies
 188
 189 float RandomSelection_totalweight;
 190 float RandomSelection_best_priority;
 191 entity RandomSelection_chosen_ent;
 192 float RandomSelection_chosen_float;
 193 string RandomSelection_chosen_string;
 194 void RandomSelection_Init();
 195 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
 196
 197 vector healtharmor_maxdamage(float h, float a, float armorblock); // returns vector: maxdamage, armorideal, 1 if fully armored
 198 vector healtharmor_applydamage(float a, float armorblock, float damage); // returns vector: take, save, 0
 199
 200 string getcurrentmod();