6 //////////////////////////////////////////////////////////
11 /////////////////////////////////////////////////////////
13 /////////////////////////////////////////////////////////
16 /////////////////////////////////////////////////////////
18 /////////////////////////////////////////////////////////
22 void(float keynr, float ascii) m_keydown;
23 void(float width, float height) m_draw;
24 void(float mode) m_toggle;
26 // optional: float(float) m_gethostcachecategory;
28 /////////////////////////////////////////////////////////
30 ///////////////////////////
33 float KEY_UNKNOWN = -1;
36 float KEY_MENU_GRABBED = 3;
38 ///////////////////////////
42 float FILE_APPEND = 1;
45 ///////////////////////////
48 float MSG_BROADCAST = 0; // unreliable to all
49 float MSG_ONE = 1; // reliable to one (msg_entity)
50 float MSG_ALL = 2; // reliable to all
51 float MSG_INIT = 3; // write to the init string
53 /////////////////////////////
54 // mouse target constants
59 /////////////////////////
60 // client state constants
62 float CS_DEDICATED = 0;
63 float CS_DISCONNECTED = 1;
64 float CS_CONNECTED = 2;
66 ///////////////////////////
69 float DRAWFLAG_NORMAL = 0;
70 float DRAWFLAG_ADDITIVE = 1;
71 float DRAWFLAG_MODULATE = 2;
72 float DRAWFLAG_2XMODULATE = 3;
74 ///////////////////////////
75 // null entity (actually it is the same like the world entity)
79 ///////////////////////////
83 float ERR_CANNOTOPEN = -1; // fopen
84 float ERR_NOTENOUGHFILEHANDLES = -2; // fopen
85 float ERR_INVALIDMODE = -3; // fopen
86 float ERR_BADFILENAME = -4; // fopen
90 float ERR_NULLSTRING = -1;
91 float ERR_BADDRAWFLAG = -2;
92 float ERR_BADSCALE = -3;
93 float ERR_BADSIZE = -3; // same as ERR_BADSCALE
94 float ERR_NOTCACHED = -4;
97 float SLIST_HOSTCACHEVIEWCOUNT = 0;
98 float SLIST_HOSTCACHETOTALCOUNT = 1;
99 float SLIST_MASTERQUERYCOUNT = 2;
100 float SLIST_MASTERREPLYCOUNT = 3;
101 float SLIST_SERVERQUERYCOUNT = 4;
102 float SLIST_SERVERREPLYCOUNT = 5;
103 float SLIST_SORTFIELD = 6;
104 float SLIST_SORTDESCENDING = 7;
105 float SLIST_LEGACY_LINE1 = 1024;
106 float SLIST_LEGACY_LINE2 = 1025;
107 float SLIST_TEST_CONTAINS = 0;
108 float SLIST_TEST_NOTCONTAIN = 1;
109 float SLIST_TEST_LESSEQUAL = 2;
110 float SLIST_TEST_LESS = 3;
111 float SLIST_TEST_EQUAL = 4;
112 float SLIST_TEST_GREATER = 5;
113 float SLIST_TEST_GREATEREQUAL = 6;
114 float SLIST_TEST_NOTEQUAL = 7;
115 float SLIST_TEST_STARTSWITH = 8;
116 float SLIST_TEST_NOTSTARTSWITH = 9;
117 float SLIST_MASK_AND = 0;
118 float SLIST_MASK_OR = 512;
121 float FONT_DEFAULT = 0;
122 float FONT_CONSOLE = 1;
124 float FONT_NOTIFY = 3;
126 float FONT_CENTERPRINT = 5;
127 float FONT_INFOBAR = 6;
129 float FONT_USER = 8; // add to this the index, like FONT_USER+3 = user3. At least 8 of them are supported.
132 /* not supported at the moment
133 ///////////////////////////
136 float OS_WINDOWS = 0;
150 //////////////////////////////////////////////////
152 //////////////////////////////////////////////////
153 // AK FIXME: Create perhaps a special builtin file for the common cmds
155 void checkextension(string ext) = #1;
158 void error(string err,...) = #2;
159 void objerror(string err,...) = #3;
163 void print(string text,...) = #4;
164 void bprint(string text,...) = #5;
165 void sprint(float clientnum, string text,...) = #6;
166 void centerprint(string text,...) = #7;
170 vector normalize(vector v) = #8;
171 float vlen(vector v) = #9;
172 float vectoyaw(vector v) = #10;
173 vector vectoangles(vector v) = #11;
175 float random(void) = #12;
177 void cmd(string command, ...) = #13;
181 float cvar(string name) = #14;
182 const string str_cvar(string name) = #71;
183 void cvar_set(string name, string value) = #15;
185 void dprint(string text,...) = #16;
187 // conversion functions
189 string ftos(float f) = #17;
190 float fabs(float f) = #18;
191 string vtos(vector v) = #19;
192 string etos(entity e) = #20;
194 float stof(string val,...) = #21;
196 entity spawn(void) = #22;
197 void remove(entity e) = #23;
199 entity find(entity start, .string field, string match) = #24;
200 entity findfloat(entity start, .float field, float match) = #25;
201 entity findentity(entity start, .entity field, entity match) = #25;
203 entity findchainstring(.string field, string match) = #26;
204 entity findchainfloat(.float field, float match) = #27;
205 entity findchainentity(.entity field, entity match) = #27;
207 string precache_file(string file) = #28;
208 string precache_sound(string sample) = #29;
210 void crash(void) = #72;
211 void coredump(void) = #30;
212 void stackdump(void) = #73;
213 void traceon(void) = #31;
214 void traceoff(void) = #32;
216 void eprint(entity e) = #33;
217 float rint(float f) = #34;
218 float floor(float f) = #35;
219 float ceil(float f) = #36;
220 entity nextent(entity e) = #37;
221 float sin(float f) = #38;
222 float cos(float f) = #39;
223 float sqrt(float f) = #40;
224 vector randomvec(void) = #41;
226 float registercvar(string name, string value, float flags) = #42; // returns 1 if success
228 float min(float f,...) = #43;
229 float max(float f,...) = #44;
231 float bound(float min,float value, float max) = #45;
232 float pow(float a, float b) = #46;
234 void copyentity(entity src, entity dst) = #47;
236 float fopen(string filename, float mode) = #48;
237 void fclose(float fhandle) = #49;
238 string fgets(float fhandle) = #50;
239 void fputs(float fhandle, string s) = #51;
241 float strlen(string s) = #52;
242 string strcat(string s1,string s2,...) = #53;
243 string substring(string s, float start, float length) = #54;
245 vector stov(string s) = #55;
247 string strzone(string s) = #56;
248 void strunzone(string s) = #57;
250 float tokenize(string s) = #58;
251 string argv(float n) = #59;
253 float isserver(void) = #60;
254 float clientcount(void) = #61;
255 float clientstate(void) = #62;
256 void clientcommand(float client, string s) = #63;
257 void changelevel(string map) = #64;
258 void localsound(string sample) = #65;
259 vector getmousepos(void) = #66;
260 float gettime(void) = #67;
261 void loadfromdata(string data) = #68;
262 void loadfromfile(string file) = #69;
264 float mod(float val, float m) = #70;
266 float search_begin(string pattern, float caseinsensitive, float quiet) = #74;
267 void search_end(float handle) = #75;
268 float search_getsize(float handle) = #76;
269 string search_getfilename(float handle, float num) = #77;
271 string chr(float ascii) = #78;
273 /////////////////////////////////////////////////
275 /////////////////////////////////////////////////
276 void WriteByte(float data, float dest, float desto) = #401;
277 void WriteChar(float data, float dest, float desto) = #402;
278 void WriteShort(float data, float dest, float desto) = #403;
279 void WriteLong(float data, float dest, float desto) = #404;
280 void WriteAngle(float data, float dest, float desto) = #405;
281 void WriteCoord(float data, float dest, float desto) = #406;
282 void WriteString(string data, float dest, float desto)= #407;
283 void WriteEntity(entity data, float dest, float desto) = #408;
285 //////////////////////////////////////////////////
287 //////////////////////////////////////////////////
289 float iscachedpic(string name) = #451;
290 string precache_pic(string name, ...) = #452;
291 void freepic(string name) = #453;
293 float drawcharacter(vector position, float character, vector scale, vector rgb, float alpha, float flag) = #454;
295 float drawstring(vector position, string text, vector scale, vector rgb, float alpha, float flag) = #455;
297 float drawcolorcodedstring(vector position, string text, vector scale, float alpha, float flag) = #467;
299 vector drawcolorcodedstring2(vector position, string text, vector scale, vector rgb, float alpha, float flag) = #467;
301 float drawpic(vector position, string pic, vector size, vector rgb, float alpha, float flag) = #456;
303 float drawfill(vector position, vector size, vector rgb, float alpha, float flag) = #457;
305 void drawsetcliparea(float x, float y, float width, float height) = #458;
307 void drawresetcliparea(void) = #459;
309 vector drawgetimagesize(string pic) = #460;
311 ////////////////////////////////////////////////
313 ////////////////////////////////////////////////
315 void setkeydest(float dest) = #601;
316 float getkeydest(void) = #602;
318 void setmousetarget(float trg) = #603;
319 float getmousetarget(void) = #604;
321 float isfunction(string function_name) = #607;
322 void callfunction(...) = #605;
323 void writetofile(float fhandle, entity ent) = #606;
324 vector getresolution(float number) = #608;
325 string keynumtostring(float keynum) = #609;
327 float gethostcachevalue(float type) = #611;
328 string gethostcachestring(float type, float hostnr) = #612;
331 //idea: daemon, motorsep
332 //darkplaces implementation: divVerent
333 //builtin definitions:
334 string(float key, float bindmap) getkeybind_bindmap = #342;
335 float(float key, string bind, float bindmap) setkeybind_bindmap = #630;
336 vector(void) getbindmaps = #631;
337 float(vector bm) setbindmaps = #632;
338 string(string command, float bindmap) findkeysforcommand = #610;
339 float(string key) stringtokeynum = #341;
340 //<also allowed builtin number to match EXT_CSQC> string(float keynum) keynumtostring = #340;
341 //description: key bind setting/getting including support for switchable
346 //darkplaces implementation: divVerent
347 //field definitions: (MENUQC)
348 string(string serveraddress) crypto_getkeyfp = #633; // retrieves the cached host key's CA fingerprint of a server given by IP address
349 string(string serveraddress) crypto_getidfp = #634; // retrieves the cached host key fingerprint of a server given by IP address
350 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
351 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
352 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
353 float CRYPTO_IDSTATUS_OUTOFRANGE = -1;
354 float CRYPTO_IDSTATUS_EMPTY = 0;
355 float CRYPTO_IDSTATUS_UNSIGNED = 1;
356 float CRYPTO_IDSTATUS_SIGNED = 2;
357 float(float i) crypto_getmyidstatus = #641; // retrieves the ID's status of a given CA slot, or 0 if slot is unused but more to come, or -1 if end of list
358 float(string url, float id, string content_type, string delim, float buf, float keyid) crypto_uri_postbuf = #513;
360 //use -1 as buffer handle to justs end delim as postdata
363 //idea: Res2k, BlackHC
364 //darkplaces implementation: Res2k, BlackHC
365 //constant definitions:
366 float GECKO_BUTTON_DOWN = 0;
367 float GECKO_BUTTON_UP = 1;
368 // either use down and up or just press but not all of them!
369 float GECKO_BUTTON_PRESS = 2;
370 // use this for mouse events if needed?
371 float GECKO_BUTTON_DOUBLECLICK = 3;
372 //builtin definitions:
373 float gecko_create( string name ) = #487;
374 void gecko_destroy( string name ) = #488;
375 void gecko_navigate( string name, string URI ) = #489;
376 float gecko_keyevent( string name, float key, float eventtype ) = #490;
377 void gecko_mousemove( string name, float x, float y ) = #491;
378 void gecko_resize( string name, float w, float h ) = #492;
379 vector gecko_get_texture_extent( string name ) = #493;
380 //engine-called QC prototypes:
381 //string(string name, string query) Qecko_Query;
383 //provides an interface to the offscreengecko library and allows for internet browsing in games
387 //darkplaces implementation: KrimZon
389 //various string manipulation functions
390 int(string str, string sub, float startpos) strstrofs = #221;
391 int(string str, float ofs) str2chr = #222;
392 string(int c, ...) chr2str = #223;
393 string(float ccase, float calpha, float cnum, string s, ...) strconv = #224;
394 string(float chars, string s, ...) strpad = #225;
395 string(string info, string key, string value, ...) infoadd = #226;
396 string(string info, string key) infoget = #227;
397 int(string s1, string s2) strcmp = #228;
398 int(string s1, string s2, float len) strncmp = #228;
399 int(string s1, string s2) strcasecmp = #229;
400 int(string s1, string s2, float len) strncasecmp = #230;
402 //DP_PRECACHE_PIC_FLAGS
404 //darkplaces implementation: divVerent
405 //constant definitions:
406 float PRECACHE_PIC_FROMWAD = 1; // this one actually is part of EXT_CSQC
407 float PRECACHE_PIC_NOTPERSISTENT = 2; // picture may get deallocated when unused
408 float PRECACHE_PIC_MIPMAP = 8; // mipmap the texture for possibly better downscaling at memory expense
409 //notes: these constants are given as optional second argument to precache_pic()
413 //darkplaces implementation: div0
414 //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.
415 //When caseinsensitive is set, the CRC is calculated of the lower cased string.
416 float(float caseinsensitive, string s, ...) crc16 = #494;
419 float(string name) cvar_type = #495;
420 float CVAR_TYPEFLAG_EXISTS = 1;
421 float CVAR_TYPEFLAG_SAVED = 2;
422 float CVAR_TYPEFLAG_PRIVATE = 4;
423 float CVAR_TYPEFLAG_ENGINE = 8;
424 float CVAR_TYPEFLAG_HASDESCRIPTION = 16;
425 float CVAR_TYPEFLAG_READONLY = 32;
427 //DP_QC_STRINGBUFFERS
429 //darkplaces implementation: LordHavoc
430 //functions to manage string buffer objects - that is, arbitrary length string arrays that are handled by the engine
431 int() buf_create = #440;
432 void(float bufhandle) buf_del = #441;
433 float(float bufhandle) buf_getsize = #442;
434 void(float bufhandle_from, float bufhandle_to) buf_copy = #443;
435 void(float bufhandle, float sortpower, float backward) buf_sort = #444;
436 string(float bufhandle, string glue) buf_implode = #445;
437 string(float bufhandle, float string_index) bufstr_get = #446;
438 void(float bufhandle, float string_index, string str) bufstr_set = #447;
439 float(float bufhandle, string str, float order) bufstr_add = #448;
440 void(float bufhandle, float string_index) bufstr_free = #449;
441 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
443 //DP_QC_STRING_CASE_FUNCTIONS
445 //darkplaces implementation: LordHavoc / Dresk
446 //builtin definitions:
447 string(string s) strtolower = #480; // returns the passed in string in pure lowercase form
448 string(string s) strtoupper = #481; // returns the passed in string in pure uppercase form
450 //provides simple string uppercase and lowercase functions
452 //DP_QC_CVAR_DESCRIPTION
454 //DarkPlaces implementation: divVerent
455 //builtin definitions:
456 string(string name) cvar_description = #518;
458 //returns the description of a cvar
461 //idea: motorsep, Spike
462 //DarkPlaces implementation: divVerent
463 //builtin definitions:
464 string(string digest, string data, ...) digest_hex = #639;
466 //returns a given hex digest of given data
467 //the returned digest is always encoded in hexadecimal
468 //only the "MD4" digest is always supported!
469 //if the given digest is not supported, string_null is returned
470 //the digest string is matched case sensitively, use "MD4", not "md4"!
474 //darkplaces implementation: div0
475 //URI::Escape's functionality
476 string(string in) uri_escape = #510;
477 string(string in) uri_unescape = #511;
481 //darkplaces implementation: divVerent
482 //loads text from an URL into a string
483 //returns 1 on success of initiation, 0 if there are too many concurrent
484 //connections already or if the URL is invalid
485 //the following callback will receive the data and MUST exist!
486 // void(float id, float status, string data) URI_Get_Callback;
488 // negative for an internal error,
490 // the HTTP response code on server error (e.g. 404)
491 //if 1 is returned by uri_get, the callback will be called in the future
492 float(string url, float id) uri_get = #513;
495 //darkplaces implementation: divVerent
496 //loads text from an URL into a string after POSTing via HTTP
497 //works like uri_get, but uri_post sends data with Content-Type: content_type to the server
498 //and uri_post sends the string buffer buf, joined using the delimiter delim
499 float(string url, float id, string content_type, string data) uri_post = #513;
500 float(string url, float id, string content_type, string delim, float buf) uri_postbuf = #513;
504 //darkplaces implementation: KrimZon
505 //builtin definitions:
506 float() numentityfields = #496;
507 string(float fieldnum) entityfieldname = #497;
508 float(float fieldnum) entityfieldtype = #498;
509 string(float fieldnum, entity ent) getentityfieldstring = #499;
510 float(float fieldnum, entity ent, string s) putentityfieldstring = #500;
512 //Returned by entityfieldtype
513 float FIELD_STRING = 1;
514 float FIELD_FLOAT = 2;
515 float FIELD_VECTOR = 3;
516 float FIELD_ENTITY = 4;
517 float FIELD_FUNCTION = 6;
519 //Versatile functions intended for storing data from specific entities between level changes, but can be customized for some kind of partial savegame.
520 //WARNING: .entity fields cannot be saved and restored between map loads as they will leave dangling pointers.
521 //numentityfields returns the number of entity fields. NOT offsets. Vectors comprise 4 fields: v, v_x, v_y and v_z.
522 //entityfieldname returns the name as a string, eg. "origin" or "classname" or whatever.
523 //entityfieldtype returns a value that the constants represent, but the field may be of another type in more exotic progs.dat formats or compilers.
524 //getentityfieldstring returns data as would be written to a savegame, eg... "0.05" (float), "0 0 1" (vector), or "Hello World!" (string). Function names can also be returned.
525 //putentityfieldstring puts the data returned by getentityfieldstring back into the entity.
527 // assorted undocumented extensions
528 string(string, float) netaddress_resolve = #625;
529 string(string search, string replace, string subject) strreplace = #484;
530 string(float uselocaltime, string format, ...) strftime = #478;
531 float(string s) tokenize_console = #514;
532 float(float i) argv_start_index = #515;
533 float(float i) argv_end_index = #516;
534 string(float, float) getgamedirinfo = #626;
535 const float GETGAMEDIRINFO_NAME = 0;
536 const float GETGAMEDIRINFO_DESCRIPTION = 1;
537 float log(float f) = #532;
538 string(string format, ...) sprintf = #627;
539 string(string s) strdecolorize = #477;
540 entity findflags(entity start, .float field, float match) = #87;
541 entity findchainflags(.float field, float match) = #88;
542 float(string s, string separator1, ...) tokenizebyseparator = #479;
543 float etof(entity ent) = #79;
544 entity ftoe(float num) = #80;
545 float validstring(string str) = #81;
546 float altstr_count(string str) = #82;
547 string altstr_prepare(string str) = #83;
548 string altstr_get(string str, float num) = #84;
549 string altstr_set(string str, float num, string set) = #85;
550 string altstr_ins(string str, float num, string set) = #86;
551 float isdemo() = #349;
552 float drawsubpic(vector position, vector size, string pic, vector srcPosition, vector srcSize, vector rgb, float alpha, float flag) = #469;
553 //vector getresolution(float number, ...) = #608; // optional argument "isfullscreen"
554 void parseentitydata(entity ent, string data) = #613;
555 void resethostcachemasks(void) = #615;
556 void sethostcachemaskstring(float mask, float fld, string str, float op) = #616;
557 void sethostcachemasknumber(float mask, float fld, float num, float op) = #617;
558 void resorthostcache(void) = #618;
559 float SLSF_DESCENDING = 1;
560 float SLSF_FAVORITES = 2;
561 float SLSF_CATEGORIES = 4;
562 void sethostcachesort(float fld, float slsf) = #619;
563 void refreshhostcache(...) = #620; // optional boolean argument "clear_list"
564 float gethostcachenumber(float fld, float hostnr) = #621;
565 float gethostcacheindexforkey(string key) = #622;
566 void addwantedhostcachekey(string key) = #623;
567 string getextresponse(void) = #624;
568 const string cvar_string(string name) = #71;
569 const string cvar_defstring(string name) = #89;
570 float stringwidth(string text, float handleColors, vector size) = #468;