4b56257a09a42e475e367a3c1aab853eb3079393
[xonotic/xonotic-data.pk3dir.git] / qcsrc / dpdefs / menudefs.qc
1 //////////////////////////////////////////////////////////
2 // sys globals
3
4 entity self;
5
6 /////////////////////////////////////////////////////////
7 void            end_sys_globals;
8 /////////////////////////////////////////////////////////
9 // sys fields
10
11 /////////////////////////////////////////////////////////
12 void            end_sys_fields;
13 /////////////////////////////////////////////////////////
14 // sys functions
15
16 void() m_init;
17 void(float keynr, float ascii) m_keydown;
18 void() m_draw;
19 void(float mode) m_toggle;
20 void() m_shutdown;
21
22 /////////////////////////////////////////////////////////
23 // sys constants
24 ///////////////////////////
25 // key dest constants
26
27 float KEY_UNKNOWN       =       -1;
28 float KEY_GAME          =       0;
29 float KEY_MENU          =       2;
30 float KEY_MENU_GRABBED  =       3;
31
32 ///////////////////////////
33 // file constants
34
35 float FILE_READ = 0;
36 float FILE_APPEND = 1;
37 float FILE_WRITE = 2;
38
39 ///////////////////////////
40 // logical constants (just for completeness)
41
42 float TRUE      = 1;
43 float FALSE = 0;
44
45 ///////////////////////////
46 // boolean constants
47
48 float true = 1;
49 float false = 0;
50
51 ///////////////////////////
52 // msg constants
53
54 float MSG_BROADCAST             = 0;            // unreliable to all
55 float MSG_ONE                   = 1;            // reliable to one (msg_entity)
56 float MSG_ALL                   = 2;            // reliable to all
57 float MSG_INIT                  = 3;            // write to the init string
58
59 /////////////////////////////
60 // mouse target constants
61
62 float MT_MENU = 1;
63 float MT_CLIENT = 2;
64
65 /////////////////////////
66 // client state constants
67
68 float CS_DEDICATED              = 0;
69 float CS_DISCONNECTED   = 1;
70 float CS_CONNECTED              = 2;
71
72 ///////////////////////////
73 // blend flags
74
75 float DRAWFLAG_NORMAL           = 0;
76 float DRAWFLAG_ADDITIVE         = 1;
77 float DRAWFLAG_MODULATE         = 2;
78 float DRAWFLAG_2XMODULATE   = 3;
79
80 ///////////////////////////
81 // null entity (actually it is the same like the world entity)
82
83 entity null_entity;
84
85 ///////////////////////////
86 // error constants
87
88 // file handling
89 float ERR_CANNOTOPEN                    = -1; // fopen
90 float ERR_NOTENOUGHFILEHANDLES  = -2; // fopen
91 float ERR_INVALIDMODE                   = -3; // fopen
92 float ERR_BADFILENAME                   = -4; // fopen
93
94 // drawing functions
95
96 float ERR_NULLSTRING                    = -1;
97 float ERR_BADDRAWFLAG                   = -2;
98 float ERR_BADSCALE                              = -3;
99 float ERR_BADSIZE                               = ERR_BADSCALE;
100 float ERR_NOTCACHED                             = -4;
101
102 // server list stuff
103 float SLIST_HOSTCACHEVIEWCOUNT  = 0;
104 float SLIST_HOSTCACHETOTALCOUNT = 1;
105 float SLIST_MASTERQUERYCOUNT    = 2;
106 float SLIST_MASTERREPLYCOUNT    = 3;
107 float SLIST_SERVERQUERYCOUNT    = 4;
108 float SLIST_SERVERREPLYCOUNT    = 5;
109 float SLIST_SORTFIELD           = 6;
110 float SLIST_SORTDESCENDING      = 7;
111 float SLIST_LEGACY_LINE1        = 1024;
112 float SLIST_LEGACY_LINE2        = 1025;
113 float SLIST_TEST_CONTAINS       = 0;
114 float SLIST_TEST_NOTCONTAIN     = 1;
115 float SLIST_TEST_LESSEQUAL      = 2;
116 float SLIST_TEST_LESS           = 3;
117 float SLIST_TEST_EQUAL          = 4;
118 float SLIST_TEST_GREATER        = 5;
119 float SLIST_TEST_GREATEREQUAL   = 6;
120 float SLIST_TEST_NOTEQUAL       = 7;
121 float SLIST_TEST_STARTSWITH     = 8;
122 float SLIST_TEST_NOTSTARTSWITH  = 9;
123 float SLIST_MASK_AND = 0;
124 float SLIST_MASK_OR  = 512;
125
126 // font stuff
127 float FONT_DEFAULT     = 0;
128 float FONT_CONSOLE     = 1;
129 float FONT_SBAR        = 2;
130 float FONT_NOTIFY      = 3;
131 float FONT_CHAT        = 4;
132 float FONT_CENTERPRINT = 5;
133 float FONT_INFOBAR     = 6;
134 float FONT_MENU        = 7;
135 float FONT_USER        = 8; // add to this the index, like FONT_USER+3 = user3. At least 8 of them are supported.
136 float drawfont;
137
138 /* not supported at the moment
139 ///////////////////////////
140 // os constants
141
142 float OS_WINDOWS        = 0;
143 float OS_LINUX          = 1;
144 float OS_MAC            = 2;
145 */
146
147
148
149
150
151
152
153
154
155
156 //////////////////////////////////////////////////
157 // common cmd
158 //////////////////////////////////////////////////
159 // AK FIXME: Create perhaps a special builtin file for the common cmds
160
161 void    checkextension(string ext)      = #1;
162
163 // error cmds
164 void    error(string err,...)           = #2;
165 void    objerror(string err,...)        = #3;
166
167 // print
168
169 void    print(string text,...)                   = #4;
170 void    bprint(string text,...)                  = #5;
171 void    sprint(float clientnum, string text,...) = #6;
172 void    centerprint(string text,...)             = #7;
173
174 // vector stuff
175
176 vector  normalize(vector v)             = #8;
177 float   vlen(vector v)                  = #9;
178 float   vectoyaw(vector v)              = #10;
179 vector  vectoangles(vector v)           = #11;
180
181 float   random(void)  = #12;
182
183 void    cmd(string command, ...) = #13;
184
185 // cvar cmds
186
187 float   cvar(string name)                       = #14;
188 const string str_cvar(string name)              = #71;
189 void    cvar_set(string name, string value)     = #15;
190
191 void    dprint(string text,...) = #16;
192
193 // conversion functions
194
195 string  ftos(float f)   = #17;
196 float   fabs(float f)   = #18;
197 string  vtos(vector v)  = #19;
198 string  etos(entity e)  = #20;
199
200 float   stof(string val,...)  = #21;
201
202 entity  spawn(void)             = #22;
203 void    remove(entity e)        = #23;
204
205 entity  findstring(entity start, .string field, string match)   = #24;
206 entity  findfloat(entity start, .float field, float match)      = #25;
207 entity  findentity(entity start, .entity field, entity match)   = #25;
208
209 entity  findchainstring(.string field, string match)    = #26;
210 entity  findchainfloat(.float field, float match)       = #27;
211 entity  findchainentity(.entity field, entity match)    = #27;
212
213 string  precache_file(string file)      = #28;
214 string  precache_sound(string sample)   = #29;
215
216 void    crash(void)     = #72;
217 void    coredump(void)  = #30;
218 void    stackdump(void) = #73;
219 void    traceon(void)   = #31;
220 void    traceoff(void)  = #32;
221
222 void    eprint(entity e)        = #33;
223 float   rint(float f)           = #34;
224 float   floor(float f)          = #35;
225 float   ceil(float f)           = #36;
226 entity  nextent(entity e)       = #37;
227 float   sin(float f)            = #38;
228 float   cos(float f)            = #39;
229 float   sqrt(float f)           = #40;
230 vector  randomvec(void)         = #41;
231
232 float   registercvar(string name, string value, float flags)  = #42; // returns 1 if success
233
234 float   min(float f,...)  = #43;
235 float   max(float f,...)  = #44;
236
237 float   bound(float min,float value, float max)  = #45;
238 float   pow(float a, float b)  = #46;
239
240 void    copyentity(entity src, entity dst)  = #47;
241
242 float   fopen(string filename, float mode)  = #48;
243 void    fclose(float fhandle)  = #49;
244 string  fgets(float fhandle)  = #50;
245 void    fputs(float fhandle, string s)  = #51;
246
247 float   strlen(string s)  = #52;
248 string  strcat(string s1,string s2,...)  = #53;
249 string  substring(string s, float start, float length)  = #54;
250
251 vector  stov(string s)  = #55;
252
253 string  strzone(string s)  = #56;
254 void    strunzone(string s) = #57;
255
256 float   tokenize(string s)  = #58
257 string  argv(float n)  = #59;
258
259 float   isserver(void)  = #60;
260 float   clientcount(void)  = #61;
261 float   clientstate(void)  = #62;
262 void    clientcommand(float client, string s)  = #63;
263 void    changelevel(string map)  = #64;
264 void    localsound(string sample)  = #65;
265 vector  getmousepos(void)       = #66;
266 float   gettime(void)           = #67;
267 void    loadfromdata(string data) = #68;
268 void    loadfromfile(string file) = #69;
269
270 float   mod(float val, float m) = #70;
271
272 float   search_begin(string pattern, float caseinsensitive, float quiet) = #74;
273 void    search_end(float handle) = #75;
274 float   search_getsize(float handle) = #76;
275 string  search_getfilename(float handle, float num) = #77;
276
277 string  chr(float ascii) = #78;
278
279 /////////////////////////////////////////////////
280 // Write* Functions
281 /////////////////////////////////////////////////
282 void    WriteByte(float data, float dest, float desto)  = #401;
283 void    WriteChar(float data, float dest, float desto)  = #402;
284 void    WriteShort(float data, float dest, float desto) = #403;
285 void    WriteLong(float data, float dest, float desto)  = #404;
286 void    WriteAngle(float data, float dest, float desto) = #405;
287 void    WriteCoord(float data, float dest, float desto) = #406;
288 void    WriteString(string data, float dest, float desto)= #407;
289 void    WriteEntity(entity data, float dest, float desto) = #408;
290
291 //////////////////////////////////////////////////
292 // Draw funtions
293 //////////////////////////////////////////////////
294
295 float   iscachedpic(string name)        = #451;
296 string  precache_pic(string name)       = #452;
297 void    freepic(string name)            = #453;
298
299 float   drawcharacter(vector position, float character, vector scale, vector rgb, float alpha, float flag) = #454;
300
301 float   drawstring(vector position, string text, vector scale, vector rgb, float alpha, float flag) = #455;
302
303 float   drawcolorcodedstring(vector position, string text, vector scale, float alpha, float flag) = #467;
304
305 vector  drawcolorcodedstring2(vector position, string text, vector scale, vector rgb, float alpha, float flag) = #467;
306  
307 float   drawpic(vector position, string pic, vector size, vector rgb, float alpha, float flag) = #456;
308
309 float   drawfill(vector position, vector size, vector rgb, float alpha, float flag) = #457;
310
311 void    drawsetcliparea(float x, float y, float width, float height) = #458;
312
313 void    drawresetcliparea(void) = #459;
314
315 vector  drawgetimagesize(string pic) = #460;
316
317 ////////////////////////////////////////////////
318 // Menu functions
319 ////////////////////////////////////////////////
320
321 void    setkeydest(float dest)  = #601;
322 float   getkeydest(void)        = #602;
323
324 void    setmousetarget(float trg) = #603;
325 float   getmousetarget(void)      = #604;
326
327 float   isfunction(string function_name) = #607;
328 void    callfunction(...) = #605;
329 void    writetofile(float fhandle, entity ent) = #606;
330 vector  getresolution(float number) = #608;
331 string  keynumtostring(float keynum) = #609;
332
333 float   gethostcachevalue(float type) = #611;
334 string  gethostcachestring(float type, float hostnr) = #612;
335
336 //DP_CSQC_BINDMAPS
337 //idea: daemon, motorsep
338 //darkplaces implementation: divVerent
339 //builtin definitions:
340 string(float key, float bindmap) getkeybind_bindmap = #342;
341 float(float key, string bind, float bindmap) setkeybind_bindmap = #630;
342 vector(void) getbindmaps = #631;
343 float(vector bm) setbindmaps = #632;
344 string(string command, float bindmap) findkeysforcommand = #610;
345 float(string key) stringtokeynum = #341;
346 //<also allowed builtin number to match EXT_CSQC> string(float keynum) keynumtostring = #340;
347 //description: key bind setting/getting including support for switchable
348 //bindmaps.
349
350 //DP_CRYPTO
351 //idea: divVerent
352 //darkplaces implementation: divVerent
353 //field definitions: (MENUQC)
354 string(string serveraddress) crypto_getkeyfp = #633; // retrieves the cached host key's CA fingerprint of a server given by IP address
355 string(string serveraddress) crypto_getidfp = #634; // retrieves the cached host key fingerprint of a server given by IP address
356 string(string serveraddress) crypto_getencryptlevel = #635; // 0 if never encrypting, 1 supported, 2 requested, 3 required, appended by list of allowed methods in order of preference ("AES128"), preceded by a space each
357 string(float i) crypto_getmykeyfp = #636; // retrieves the CA key fingerprint of a given CA slot, or "" if slot is unused but more to come, or string_null if end of list
358 string(float i) crypto_getmyidfp = #637; // retrieves the ID fingerprint of a given CA slot, or "" if slot is unused but more to come, or string_null if end of list
359 float(string url, float id, string content_type, string delim, float buf, float keyid) crypto_uri_postbuf = #513;
360 //description:
361 //use -1 as buffer handle to justs end delim as postdata
362
363 //DP_GECKO_SUPPORT
364 //idea: Res2k, BlackHC
365 //darkplaces implementation: Res2k, BlackHC
366 //constant definitions:
367 float GECKO_BUTTON_DOWN         = 0;
368 float GECKO_BUTTON_UP           = 1;
369 // either use down and up or just press but not all of them!
370 float GECKO_BUTTON_PRESS        = 2;
371 // use this for mouse events if needed?
372 float GECKO_BUTTON_DOUBLECLICK  = 3;
373 //builtin definitions:
374 float gecko_create( string name ) = #487;
375 void gecko_destroy( string name ) = #488;
376 void gecko_navigate( string name, string URI ) = #489;
377 float gecko_keyevent( string name, float key, float eventtype ) = #490;
378 void gecko_mousemove( string name, float x, float y ) = #491;
379 void gecko_resize( string name, float w, float h ) = #492;
380 vector gecko_get_texture_extent( string name ) = #493;
381 //engine-called QC prototypes:
382 //string(string name, string query) Qecko_Query;
383 //description:
384 //provides an interface to the offscreengecko library and allows for internet browsing in games
385
386 //FTE_STRINGS
387 //idea: many
388 //darkplaces implementation: KrimZon
389 //description:
390 //various string manipulation functions
391 float(string str, string sub, float startpos) strstrofs = #221;
392 float(string str, float ofs) str2chr = #222;
393 string(float c, ...) chr2str = #223;
394 string(float ccase, float calpha, float cnum, string s, ...) strconv = #224;
395 string(float chars, string s, ...) strpad = #225;
396 string(string info, string key, string value, ...) infoadd = #226;
397 string(string info, string key) infoget = #227;
398 float(string s1, string s2, float len) strncmp = #228;
399 float(string s1, string s2) strcasecmp = #229;
400 float(string s1, string s2, float len) strncasecmp = #230;
401
402 //DP_QC_CRC16
403 //idea: div0
404 //darkplaces implementation: div0
405 //Some hash function to build hash tables with. This has to be be the CRC-16-CCITT that is also required for the QuakeWorld download protocol.
406 //When caseinsensitive is set, the CRC is calculated of the lower cased string.
407 float(float caseinsensitive, string s, ...) crc16 = #494;
408
409 //DP_QC_CVAR_TYPE
410 float(string name) cvar_type = #495;
411 float CVAR_TYPEFLAG_EXISTS = 1;
412 float CVAR_TYPEFLAG_SAVED = 2;
413 float CVAR_TYPEFLAG_PRIVATE = 4;
414 float CVAR_TYPEFLAG_ENGINE = 8;
415 float CVAR_TYPEFLAG_HASDESCRIPTION = 16;
416 float CVAR_TYPEFLAG_READONLY = 32;
417
418 //DP_QC_STRINGBUFFERS
419 //idea: ??
420 //darkplaces implementation: LordHavoc
421 //functions to manage string buffer objects - that is, arbitrary length string arrays that are handled by the engine
422 float() buf_create = #440;
423 void(float bufhandle) buf_del = #441;
424 float(float bufhandle) buf_getsize = #442;
425 void(float bufhandle_from, float bufhandle_to) buf_copy = #443;
426 void(float bufhandle, float sortpower, float backward) buf_sort = #444;
427 string(float bufhandle, string glue) buf_implode = #445;
428 string(float bufhandle, float string_index) bufstr_get = #446;
429 void(float bufhandle, float string_index, string str) bufstr_set = #447;
430 float(float bufhandle, string str, float order) bufstr_add = #448;
431 void(float bufhandle, float string_index) bufstr_free = #449;
432 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
433
434 //DP_QC_CVAR_DESCRIPTION
435 //idea: divVerent
436 //DarkPlaces implementation: divVerent
437 //builtin definitions:
438 string(string name) cvar_description = #518;
439 //description:
440 //returns the description of a cvar
441
442 //DP_QC_DIGEST
443 //idea: motorsep, Spike
444 //DarkPlaces implementation: divVerent
445 //builtin definitions:
446 string(string digest, string data, ...) digest_hex = #639;
447 //description:
448 //returns a given hex digest of given data
449 //the returned digest is always encoded in hexadecimal
450 //only the "MD4" digest is always supported!
451 //if the given digest is not supported, string_null is returned
452 //the digest string is matched case sensitively, use "MD4", not "md4"!
453
454 //DP_QC_URI_ESCAPE
455 //idea: div0
456 //darkplaces implementation: div0
457 //URI::Escape's functionality
458 string(string in) uri_escape = #510;
459 string(string in) uri_unescape = #511;
460
461 //DP_QC_URI_GET
462 //idea: divVerent
463 //darkplaces implementation: divVerent
464 //loads text from an URL into a string
465 //returns 1 on success of initiation, 0 if there are too many concurrent
466 //connections already or if the URL is invalid
467 //the following callback will receive the data and MUST exist!
468 //  void(float id, float status, string data) URI_Get_Callback;
469 //status is either
470 //  negative for an internal error,
471 //  0 for success, or
472 //  the HTTP response code on server error (e.g. 404)
473 //if 1 is returned by uri_get, the callback will be called in the future
474 float(string url, float id) uri_get = #513;
475 //DP_QC_URI_POST
476 //idea: divVerent
477 //darkplaces implementation: divVerent
478 //loads text from an URL into a string after POSTing via HTTP
479 //works like uri_get, but uri_post sends data with Content-Type: content_type to the server
480 //and uri_post sends the string buffer buf, joined using the delimiter delim
481 float(string url, float id, string content_type, string data) uri_post = #513;
482 float(string url, float id, string content_type, string delim, float buf) uri_postbuf = #513;
483
484 // assorted undocumented extensions
485 string(string, float) netaddress_resolve = #625;
486 string(string search, string replace, string subject) strreplace = #484;
487 string(float uselocaltime, string format, ...) strftime = #478;
488 float(string s) tokenize_console = #514;
489 float(float i) argv_start_index = #515;
490 float(float i) argv_end_index = #516;
491 string(float, float) getgamedirinfo = #626;
492 #define GETGAMEDIRINFO_NAME 0
493 #define GETGAMEDIRINFO_DESCRIPTION 1
494 float log(float f) = #532;
495 string(string format, ...) sprintf = #627;
496 string(string s) strdecolorize = #477;
497 entity  findflags(entity start, .float field, float match) = #87;
498 entity  findchainflags(.float field, float match) = #88;
499 float(string s, string separator1, ...) tokenizebyseparator = #479;
500 float   etof(entity ent) = #79;
501 entity  ftoe(float num)  = #80;
502 float   validstring(string str) = #81;
503 float   altstr_count(string str) = #82;
504 string  altstr_prepare(string str) = #83;
505 string  altstr_get(string str, float num) = #84;
506 string  altstr_set(string str, float num, string set) = #85;
507 string  altstr_ins(string str, float num, string set) = #86;
508 float   isdemo() = #349;
509 float   drawsubpic(vector position, vector size, string pic, vector srcPosition, vector srcSize, vector rgb, float alpha, float flag) = #469;
510 //vector        getresolution(float number, ...) = #608; // optional argument "isfullscreen"
511 void    parseentitydata(entity ent, string data) = #613;
512 void    resethostcachemasks(void) = #615;
513 void    sethostcachemaskstring(float mask, float fld, string str, float op) = #616;
514 void    sethostcachemasknumber(float mask, float fld, float num, float op) = #617;
515 void    resorthostcache(void) = #618;
516 void    sethostcachesort(float fld, float descending) = #619;
517 void    refreshhostcache(void) = #620;
518 float   gethostcachenumber(float fld, float hostnr) = #621;
519 float   gethostcacheindexforkey(string key) = #622;
520 void    addwantedhostcachekey(string key) = #623;
521 string  getextresponse(void) = #624;
522 const string cvar_string(string name) = #71;
523 const string cvar_defstring(string name) = #89;
524 float   stringwidth(string text, float handleColors, vector size) = #468;