]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/dpdefs/csprogsdefs.qc
Merge branch 'master' into terencehill/vehicles_fixes
[xonotic/xonotic-data.pk3dir.git] / qcsrc / dpdefs / csprogsdefs.qc
1 /*
2 ==============================================================================
3
4                         SOURCE FOR GLOBALVARS_T C STRUCTURE
5                         MUST NOT BE MODIFIED, OR CRC ERRORS WILL APPEAR
6
7 ==============================================================================
8 */
9
10 //
11 // system globals
12 //
13 entity          self;
14 entity          other;
15 entity          world;
16 float           time;
17 float           frametime;
18
19 float           player_localentnum;     //the entnum
20 float           player_localnum;        //the playernum
21 float           maxclients;     //a constant filled in by the engine. gah, portability eh?
22
23 float           clientcommandframe;     //player movement
24 float           servercommandframe;     //clientframe echoed off the server
25
26 string          mapname;
27
28 //
29 // global variables set by built in functions
30 //
31 vector          v_forward, v_up, v_right;       // set by makevectors()
32
33 // set by traceline / tracebox
34 float           trace_allsolid;
35 float           trace_startsolid;
36 float           trace_fraction;
37 vector          trace_endpos;
38 vector          trace_plane_normal;
39 float           trace_plane_dist;
40 entity          trace_ent;
41 float           trace_inopen;
42 float           trace_inwater;
43
44 //
45 // required prog functions
46 //
47 void()          CSQC_Init;
48 void()          CSQC_Shutdown;
49 float(float f, float t, float n)        CSQC_InputEvent;
50 void(float w, float h)          CSQC_UpdateView;
51 float(string s) CSQC_ConsoleCommand;
52
53 //these fields are read and set by the default player physics
54 vector          pmove_org;
55 vector          pmove_vel;
56 vector          pmove_mins;
57 vector          pmove_maxs;
58 //retrieved from the current movement commands (read by player physics)
59 float           input_timelength;
60 vector          input_angles;
61 vector          input_movevalues;       //forwards, right, up.
62 float           input_buttons;          //attack, use, jump (default physics only uses jump)
63
64 float           movevar_gravity;
65 float           movevar_stopspeed;
66 float           movevar_maxspeed;
67 float           movevar_spectatormaxspeed;      //used by NOCLIP movetypes.
68 float           movevar_accelerate;
69 float           movevar_airaccelerate;
70 float           movevar_wateraccelerate;
71 float           movevar_friction;
72 float           movevar_waterfriction;
73 float           movevar_entgravity;     //the local player's gravity field. Is a multiple (1 is the normal value)
74
75 //================================================
76 void            end_sys_globals;                // flag for structure dumping
77 //================================================
78
79 /*
80 ==============================================================================
81
82                         SOURCE FOR ENTVARS_T C STRUCTURE
83                         MUST NOT BE MODIFIED, OR CRC ERRORS WILL APPEAR
84
85 ==============================================================================
86 */
87
88 //
89 // system fields (*** = do not set in prog code, maintained by C code)
90 //
91 .float          modelindex;             // *** model index in the precached list
92 .vector         absmin, absmax; // *** origin + mins / maxs
93
94 .float          entnum; // *** the ent number as on the server
95 .float          drawmask;
96 .void()         predraw;
97
98 .float          movetype;
99 .float          solid;
100
101 .vector         origin;                 // ***
102 .vector         oldorigin;              // ***
103 .vector         velocity;
104 .vector         angles;
105 .vector         avelocity;
106
107 .string         classname;              // spawn function
108 .string         model;
109 .float          frame;
110 .float          skin;
111 .float          effects;
112
113 .vector         mins, maxs;             // bounding box extents reletive to origin
114 .vector         size;                   // maxs - mins
115
116 .void()         touch;
117 .void()         use;
118 .void()         think;
119 .void()         blocked;                // for doors or plats, called when can't push other
120
121 .float          nextthink;
122
123 .entity         chain;
124
125 .string         netname;
126
127 .entity         enemy;
128
129 .float          flags;
130
131 .float          colormap;
132
133 .entity         owner;          // who launched a missile
134
135 //================================================
136 void            end_sys_fields;                 // flag for structure dumping
137 //================================================
138
139 /*
140 ==============================================================================
141
142                         OPTIONAL FIELDS AND GLOBALS
143
144 ==============================================================================
145 */
146
147 // Additional OPTIONAL Fields and Globals
148 float           intermission; // indicates intermission state (0 = normal, 1 = scores, 2 = finale text)
149
150 vector          view_angles; // same as input_angles
151 vector          view_punchangle; // from server
152 vector          view_punchvector; // from server
153
154 /*
155 ==============================================================================
156
157                         CONSTANT DEFINITIONS
158
159 ==============================================================================
160 */
161
162 const float MASK_ENGINE                 = 1;
163 const float MASK_ENGINEVIEWMODELS       = 2;
164 const float MASK_NORMAL                 = 4;
165
166 const float RF_VIEWMODEL        = 1;
167 const float RF_EXTERNALMODEL    = 2;
168 const float RF_DEPTHHACK        = 4;
169 const float RF_ADDITIVE         = 8;
170 const float RF_USEAXIS          = 16;
171
172 const float VF_MIN              = 1;    //(vector)
173 const float VF_MIN_X            = 2;    //(float)
174 const float VF_MIN_Y            = 3;    //(float)
175 const float VF_SIZE             = 4;    //(vector) (viewport size)
176 const float VF_SIZE_Y           = 5;    //(float)
177 const float VF_SIZE_X           = 6;    //(float)
178 const float VF_VIEWPORT         = 7;    //(vector, vector)
179 const float VF_FOV              = 8;    //(vector)
180 const float VF_FOVX             = 9;    //(float)
181 const float VF_FOVY             = 10;   //(float)
182 const float VF_ORIGIN           = 11;   //(vector)
183 const float VF_ORIGIN_X         = 12;   //(float)
184 const float VF_ORIGIN_Y         = 13;   //(float)
185 const float VF_ORIGIN_Z         = 14;   //(float)
186 const float VF_ANGLES           = 15;   //(vector)
187 const float VF_ANGLES_X         = 16;   //(float)
188 const float VF_ANGLES_Y         = 17;   //(float)
189 const float VF_ANGLES_Z         = 18;   //(float)
190 const float VF_DRAWWORLD        = 19;   //(float)
191 const float VF_DRAWENGINESBAR   = 20;   //(float)
192 const float VF_DRAWCROSSHAIR    = 21;   //(float)
193
194 const float VF_CL_VIEWANGLES    = 33;   //(vector)
195 const float VF_CL_VIEWANGLES_X  = 34;   //(float)
196 const float VF_CL_VIEWANGLES_Y  = 35;   //(float)
197 const float VF_CL_VIEWANGLES_Z  = 36;   //(float)
198
199 const float VF_PERSPECTIVE      = 200;
200
201 const float STAT_HEALTH         = 0;
202 const float STAT_WEAPONMODEL    = 2;
203 const float STAT_AMMO           = 3;
204 const float STAT_ARMOR          = 4;
205 const float STAT_WEAPONFRAME    = 5;
206 const float STAT_SHELLS         = 6;
207 const float STAT_NAILS          = 7;
208 const float STAT_ROCKETS        = 8;
209 const float STAT_CELLS          = 9;
210 const float STAT_ACTIVEWEAPON   = 10;
211 const float STAT_TOTALSECRETS   = 11;
212 const float STAT_TOTALMONSTERS  = 12;
213 const float STAT_SECRETS                = 13;
214 const float STAT_MONSTERS               = 14;
215 const float STAT_ITEMS          = 15;
216 const float STAT_VIEWHEIGHT     = 16;
217
218 // Quake Sound Constants
219 const float CHAN_AUTO                   = 0;
220 const float CHAN_WEAPON                 = 1;
221 const float CHAN_VOICE                  = 2;
222 const float CHAN_ITEM                   = 3;
223 const float CHAN_BODY                   = 4;
224
225 const float ATTN_NONE                   = 0;
226 const float ATTN_NORM                   = 1;
227 const float ATTN_IDLE                   = 2;
228 const float ATTN_STATIC                 = 3;
229
230 // Frik File Constants
231 const float FILE_READ                   = 0;
232 const float FILE_APPEND                 = 1;
233 const float FILE_WRITE                  = 2;
234
235 // Quake Point Contents
236 const float CONTENT_EMPTY                                       = -1;
237 const float CONTENT_SOLID                                       = -2;
238 const float CONTENT_WATER                                       = -3;
239 const float CONTENT_SLIME                                       = -4;
240 const float CONTENT_LAVA                                        = -5;
241 const float CONTENT_SKY                                         = -6;
242
243 // Quake Solid Constants
244 const float SOLID_NOT                                           = 0;
245 const float SOLID_TRIGGER                                       = 1;
246 const float SOLID_BBOX                                          = 2;
247 const float SOLID_SLIDEBOX                                      = 3;
248 const float SOLID_BSP                                           = 4;
249 const float SOLID_CORPSE                                        = 5;
250
251 // Quake Move Constants
252 const float MOVE_NORMAL                                         = 0;
253 const float MOVE_NOMONSTERS                                     = 1;
254 const float MOVE_MISSILE                                        = 2;
255
256 // Boolean Constants
257 const float true        = 1;
258 const float false       = 0;
259 const float TRUE        = 1;
260 const float FALSE       = 0;
261
262 const float EXTRA_LOW = -99999999;
263 const float EXTRA_HIGH = 99999999;
264
265 const vector VEC_1      = '1 1 1';
266 const vector VEC_0      = '0 0 0';
267 const vector VEC_M1     = '-1 -1 -1';
268
269 const float M_PI = 3.14159265358979323846;
270
271 vector  VEC_HULL_MIN = '-16 -16 -24';
272 vector  VEC_HULL_MAX = '16 16 32';
273
274 // Quake Temporary Entity Constants
275 const float TE_SPIKE                                            = 0;
276 const float TE_SUPERSPIKE                                       = 1;
277 const float TE_GUNSHOT                                          = 2;
278 const float TE_EXPLOSION                                        = 3;
279 const float TE_TAREXPLOSION                                     = 4;
280 const float TE_LIGHTNING1                                       = 5;
281 const float TE_LIGHTNING2                                       = 6;
282 const float TE_WIZSPIKE                                         = 7;
283 const float TE_KNIGHTSPIKE                                      = 8;
284 const float TE_LIGHTNING3                                       = 9;
285 const float TE_LAVASPLASH                                       = 10;
286 const float TE_TELEPORT                                         = 11;
287 const float TE_EXPLOSION2                                       = 12;
288         // Darkplaces Additions
289         const float TE_EXPLOSIONRGB                                     = 53;
290         const float TE_GUNSHOTQUAD                                      = 57;
291         const float TE_EXPLOSIONQUAD                            = 70;
292         const float TE_SPIKEQUAD                                        = 58;
293         const float TE_SUPERSPIKEQUAD                           = 59;
294
295 // PFlags for Dynamic Lights
296 const float PFLAGS_NOSHADOW                                     = 1;
297 const float PFLAGS_CORONA                                       = 2;
298 const float PFLAGS_FULLDYNAMIC                          = 128;
299
300 const float EF_ADDITIVE         = 32;
301 const float EF_BLUE             = 64;
302 const float EF_FLAME            = 1024;
303 const float EF_FULLBRIGHT       = 512;
304 const float EF_NODEPTHTEST      = 8192;
305 const float EF_NODRAW           = 16;
306 const float EF_NOSHADOW         = 4096;
307 const float EF_RED              = 128;
308 const float EF_STARDUST         = 2048;
309 const float EF_SELECTABLE       = 16384;
310
311 const float PFL_ONGROUND        = 1;
312 const float PFL_CROUCH          = 2;
313 const float PFL_DEAD            = 4;
314 const float PFL_GIBBED          = 8;
315
316 // draw flags
317 const float DRAWFLAG_NORMAL = 0;
318 const float DRAWFLAG_ADDITIVE = 1;
319 const float DRAWFLAG_MODULATE = 2;
320 const float DRAWFLAG_2XMODULATE = 3;
321 const float DRAWFLAG_SCREEN = 4;
322 const float DRAWFLAG_MIPMAP = 0x100; // only for R_BeginPolygon
323
324 /*
325 ==============================================================================
326
327                         BUILTIN DEFINITIONS
328                         EXTENSIONS ARE NOT ADDED HERE, BUT BELOW!
329
330 ==============================================================================
331 */
332
333 void(vector ang) makevectors = #1;
334 void(entity e, vector o) setorigin = #2;
335 void(entity e, string m) setmodel = #3;
336 void(entity e, vector min, vector max) setsize = #4;
337
338 void() break_to_debugger = #6;
339 float() random = #7;
340 void(entity e, float chan, string samp) sound = #8;
341 vector(vector v) normalize = #9;
342 void(string e) error = #10;
343 void(string e) objerror = #11;
344 float(vector v) vlen = #12;
345 float(vector v) vectoyaw = #13;
346 entity() spawn = #14;
347 void(entity e) remove = #15;
348 float(vector v1, vector v2, float tryents, entity ignoreentity) traceline = #16;
349
350 entity(entity start, .string fld, string match) find = #18;
351 void(string s) precache_sound = #19;
352 void(string s) precache_model = #20;
353
354 entity(vector org, float rad) findradius = #22;
355
356 void(string s, ...) dprint = #25;
357 string(float f) ftos = #26;
358 string(vector v) vtos = #27;
359 void() coredump = #28;
360 void() traceon = #29;
361 void() traceoff = #30;
362 void(entity e) eprint = #31;
363 // settrace optional
364 float(float yaw, float dist, float settrace) walkmove = #32;
365
366 float() droptofloor = #34;
367 void(float style, string value) lightstyle = #35;
368 float(float v) rint = #36;
369 float(float v) floor = #37;
370 float(float v) ceil = #38;
371
372 float(entity e) checkbottom = #40;
373 float(vector v) pointcontents = #41;
374
375 float(float f) fabs = #43;
376
377 float(string s) cvar = #45;
378 void(string s, ...) localcmd = #46;
379 entity(entity e) nextent = #47;
380 void(vector o, vector d, float color, float count) particle = #48;
381 void() ChangeYaw = #49;
382
383 vector(vector v) vectoangles = #51;
384 vector(vector v, vector w) vectoangles2 = #51;
385
386 float(float f) sin = #60;
387 float(float f) cos = #61;
388 float(float f) sqrt = #62;
389 void(entity ent) changepitch = #63;
390 void(entity e, entity ignore) tracetoss = #64;
391 string(entity ent) etos = #65;
392
393 string(string s) precache_file = #68;
394 void(entity e) makestatic = #69;
395
396 void(string var, string val) cvar_set = #72;
397
398 void(vector pos, string samp, float vol, float atten) ambientsound = #74;
399 string(string s) precache_model2 = #75;
400 string(string s) precache_sound2 = #76;
401 string(string s) precache_file2 = #77;
402
403 float(string s) stof = #81;
404
405
406 void(vector v1, vector min, vector max, vector v2, float nomonsters, entity forent) tracebox = #90;
407 vector() randomvec = #91;
408 vector(vector org) getlight = #92;
409 vector(vector org, float lpflags) getlight2 = #92;
410 vector getlight_dir;
411 vector getlight_ambient;
412 vector getlight_diffuse;
413 const float LP_LIGHTMAP = 1;
414 const float LP_RTWORLD = 2;
415 const float LP_DYNLIGHT = 4;
416 const float LP_COMPLETE = 7;
417
418 float(string name, string value) registercvar = #93;
419 float( float a, ... ) min = #94;
420 float( float b, ... ) max = #95;
421 float(float minimum, float val, float maximum) bound = #96;
422 float(float f, float f) pow = #97;
423 entity(entity start, .float fld, float match) findfloat = #98;
424 float(string s) checkextension = #99;
425 // FrikaC and Telejano range #100-#199
426
427 float(string filename, float mode) fopen = #110;
428 void(float fhandle) fclose = #111;
429 string(float fhandle) fgets = #112;
430 void(float fhandle, string s) fputs = #113;
431 float(string s) strlen = #114;
432 string(...) strcat = #115;
433 string(string s, float start, float length) substring = #116;
434 vector(string) stov = #117;
435 string(string s) strzone = #118;
436 void(string s) strunzone = #119;
437
438 // FTEQW range #200-#299
439
440 float(float number, float quantity) bitshift = #218;
441
442 //float(string str, string sub[, float startpos]) strstrofs = #221;
443 float(string str, string sub, float startpos) strstrofs = #221;
444 float(string str, float ofs) str2chr = #222;
445 string(float c, ...) chr2str = #223;
446 string(float ccase, float calpha, float cnum, string s, ...) strconv = #224;
447 string(float chars, string s, ...) strpad = #225;
448 string(string info, string key, string value, ...) infoadd = #226;
449 string(string info, string key) infoget = #227;
450 float(string s1, string s2) strcmp = #228;
451 float(string s1, string s2, float len) strncmp = #228;
452 float(string s1, string s2) strcasecmp = #229;
453 float(string s1, string s2, float len) strncasecmp = #230;
454
455 // CSQC range #300-#399
456 void() clearscene = #300;
457 void(float mask) addentities = #301;
458 void(entity ent) addentity = #302;
459 float(float property, ...) setproperty = #303;
460 float(float property) getproperty = #309;
461 vector(float property) getpropertyvec = #309;
462 void() renderscene = #304;
463 void(vector org, float radius, vector lightcolours) adddynamiclight = #305;
464 void(vector org, float radius, vector lightcolours, float style, string cubemapname, float pflags) adddynamiclight2 = #305;
465 //void(string texturename, float flag[, float is2d, float lines]) R_BeginPolygon = #306;
466 void(string texturename, float flag, ...) R_BeginPolygon = #306;
467 void(vector org, vector texcoords, vector rgb, float alpha) R_PolygonVertex = #307;
468 void() R_EndPolygon = #308;
469 vector (vector v) cs_unproject = #310;
470 vector (vector v) cs_project = #311;
471
472 void(float width, vector pos1, vector pos2, float flag) drawline = #315;
473 float(string name) iscachedpic = #316;
474 string(string name, ...) precache_pic = #317;
475 string(string name) precache_cubemap = #317;
476 vector(string picname) draw_getimagesize = #318;
477 void(string name) freepic = #319;
478 float(vector position, float character, vector scale, vector rgb, float alpha, float flag) drawcharacter = #320;
479 float(vector position, string text, vector scale, vector rgb, float alpha, float flag) drawstring = #321;
480 float(vector position, string pic, vector size, vector rgb, float alpha, float flag) drawpic = #322;
481 float(vector position, vector size, vector rgb, float alpha, float flag) drawfill = #323;
482 void(float x, float y, float width, float height) drawsetcliparea = #324;
483 void(void) drawresetcliparea = #325;
484 float(vector position, string text, vector scale, float alpha, float flag) drawcolorcodedstring = #326;
485 vector(vector position, string text, vector scale, vector rgb, float alpha, float flag) drawcolorcodedstring2 = #326;
486
487 float(float stnum) getstatf = #330;
488 float(float stnum, ...) getstati = #331; // can optionally take first bit and count
489 string(float firststnum) getstats = #332;
490 void(entity e, float mdlindex) setmodelindex = #333;
491 string(float mdlindex) modelnameforindex = #334;
492 float(string effectname) particleeffectnum = #335;
493 void(entity ent, float effectnum, vector start, vector end) trailparticles = #336;
494 //void(float effectnum, vector origin [, vector dir, float count]) pointparticles = #337;
495 void(float effectnum, vector origin , vector dir, float count) pointparticles = #337;
496 void(string s, ...) centerprint = #338;
497 void(string s, ...) print = #339;
498 string(float keynum) keynumtostring = #340;
499 float(string keyname) stringtokeynum = #341;
500 string(float keynum) getkeybind = #342;
501 void(float usecursor) setcursormode = #343;
502 vector() getmousepos = #344;
503 float(float framenum) getinputstate = #345;
504 void(float sens) setsensitivityscale = #346;
505 void(...) runstandardplayerphysics = #347; // this may or may not take a player ent
506 string(float playernum, string keyname) getplayerkeyvalue = #348;
507 float() isdemo = #349;
508 float() isserver = #350;
509 void(vector origin, vector forward, vector right, vector up) SetListener = #351;
510 void(string cmdname) registercommand = #352;
511 float(entity ent) wasfreed = #353;
512 string(string key) serverkey = #354;
513
514 // Use proper case; refer to the id1 Write* functions!
515 float() ReadByte = #360;
516 float() ReadChar = #361;
517 float() ReadShort = #362;
518 float() ReadLong = #363;
519 float() ReadCoord = #364;
520 float() ReadAngle = #365;
521 string() ReadString = #366;
522 float() ReadFloat = #367;
523
524 // LordHavoc's range #400-#499
525 void(entity from, entity to) copyentity = #400;
526
527 entity(.string fld, string match) findchain = #402;
528 entity(.float fld, float match) findchainfloat = #403;
529 void(vector org, string modelname, float startframe, float endframe, float framerate) effect = #404;
530 void(vector org, vector velocity, float howmany) te_blood = #405;
531 void(vector mincorner, vector maxcorner, float explosionspeed, float howmany) te_bloodshower = #406;
532 void(vector org, vector color) te_explosionrgb = #407;
533 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color, float gravityflag, float randomveljitter) te_particlecube = #408;
534 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlerain = #409;
535 void(vector mincorner, vector maxcorner, vector vel, float howmany, float color) te_particlesnow = #410;
536 void(vector org, vector vel, float howmany) te_spark = #411;
537 void(vector org) te_gunshotquad = #412;
538 void(vector org) te_spikequad = #413;
539 void(vector org) te_superspikequad = #414;
540 void(vector org) te_explosionquad = #415;
541 void(vector org) te_smallflash = #416;
542 void(vector org, float radius, float lifetime, vector color) te_customflash = #417;
543 void(vector org) te_gunshot = #418;
544 void(vector org) te_spike = #419;
545 void(vector org) te_superspike = #420;
546 void(vector org) te_explosion = #421;
547 void(vector org) te_tarexplosion = #422;
548 void(vector org) te_wizspike = #423;
549 void(vector org) te_knightspike = #424;
550 void(vector org) te_lavasplash = #425;
551 void(vector org) te_teleport = #426;
552 void(vector org, float colorstart, float colorlength) te_explosion2 = #427;
553 void(entity own, vector start, vector end) te_lightning1 = #428;
554 void(entity own, vector start, vector end) te_lightning2 = #429;
555 void(entity own, vector start, vector end) te_lightning3 = #430;
556 void(entity own, vector start, vector end) te_beam = #431;
557 void(vector dir) vectorvectors = #432;
558 void(vector org) te_plasmaburn = #433;
559 float(entity e, float s) getsurfacenumpoints = #434;
560 vector(entity e, float s, float n) getsurfacepoint = #435;
561 vector(entity e, float s) getsurfacenormal = #436;
562 string(entity e, float s) getsurfacetexture = #437;
563 float(entity e, vector p) getsurfacenearpoint = #438;
564 vector(entity e, float s, vector p) getsurfaceclippedpoint = #439;
565
566 float(string s) tokenize = #441;
567 string(float n) argv = #442;
568 void(entity e, entity tagentity, string tagname) setattachment = #443;
569 float(string pattern, float caseinsensitive, float quiet) search_begin = #444;
570 void(float handle) search_end = #445;
571 float(float handle) search_getsize = #446;
572 string(float handle, float num) search_getfilename = #447;
573 string(string s) cvar_string = #448;
574 entity(entity start, .float fld, float match) findflags = #449;
575 entity(.float fld, float match) findchainflags = #450;
576 float(entity ent, string tagname) gettagindex = #451;
577 vector(entity ent, float tagindex) gettaginfo = #452;
578
579 void(vector org, vector vel, float howmany) te_flamejet = #457;
580
581 entity(float num) entitybyindex = #459;
582 float() buf_create = #460;
583 void(float bufhandle) buf_del = #461;
584 float(float bufhandle) buf_getsize = #462;
585 void(float bufhandle_from, float bufhandle_to) buf_copy = #463;
586 void(float bufhandle, float sortpower, float backward) buf_sort = #464;
587 string(float bufhandle, string glue) buf_implode = #465;
588 string(float bufhandle, float string_index) bufstr_get = #466;
589 void(float bufhandle, float string_index, string str) bufstr_set = #467;
590 float(float bufhandle, string str, float order) bufstr_add = #468;
591 void(float bufhandle, float string_index) bufstr_free = #469;
592
593 float(float s) asin = #471;
594 float(float c) acos = #472;
595 float(float t) atan = #473;
596 float(float c, float s) atan2 = #474;
597 float(float a) tan = #475;
598 float(string s) strippedstringlen = #476;
599 float(string s) strlennocol = #476; // This is the correct name for the function, but not removing the decolorizedstring mapping.
600 string(string s) decolorizedstring = #477;
601 string(string s) strdecolorize = #477; // This is the correct name for the function, but not removing the decolorizedstring mapping.
602 string(float uselocaltime, string format, ...) strftime = #478;
603 string(string s) strtolower = #480;
604 string(string s) strtoupper = #481;
605 string(string s) cvar_defstring = #482;
606 void(vector origin, string sample, float volume, float attenuation) pointsound = #483;
607 string(string search, string replace, string subject) strreplace = #484;
608 string(string search, string replace, string subject) strireplace = #485;
609 vector(entity e, float s, float n, float a) getsurfacepointattribute = #486;
610 #ifdef SUPPORT_GECKO
611 float gecko_create( string name ) = #487;
612 void gecko_destroy( string name ) = #488;
613 void gecko_navigate( string name, string URI ) = #489;
614 float gecko_keyevent( string name, float key, float eventtype ) = #490;
615 void gecko_mousemove( string name, float x, float y ) = #491;
616 void gecko_resize( string name, float w, float h ) = #492;
617 vector gecko_get_texture_extent( string name ) = #493;
618 #else
619
620 #endif
621
622 /*
623 ==============================================================================
624
625                         EXTENSION DEFINITIONS
626
627 ==============================================================================
628 */
629
630 // DP_CSQC_SPAWNPARTICLE
631 // idea: VorteX
632 // darkplaces implementation: VorteX
633 // constant definitions:
634 // particle base behavior:
635 float PT_ALPHASTATIC = 1;
636 float PT_STATIC = 2;
637 float PT_SPARK = 3;
638 float PT_BEAM = 4;
639 float PT_RAIN = 5;
640 float PT_RAINDECAL = 6;
641 float PT_SNOW = 7;
642 float PT_BUBBLE = 8;
643 float PT_BLOOD = 9;
644 float PT_SMOKE = 10;
645 float PT_DECAL = 11;
646 float PT_ENTITYPARTICLE = 12;
647 // particle blendtypes:
648 float PBLEND_ALPHA = 0;
649 float PBLEND_ADD = 1;
650 float PBLEND_INVMOD = 2;
651 // particle orientation:
652 float PARTICLE_BILLBOARD = 0;
653 float PARTICLE_SPARK = 1;
654 float PARTICLE_ORIENTED_DOUBLESIDED = 2;
655 float PARTICLE_BEAM = 3;
656 // global definitions:
657 float particle_type; // one of PT_
658 float particle_blendmode; // one of PBLEND_ values
659 float particle_orientation; // one of PARTICLE_ values
660 vector particle_color1;
661 vector particle_color2;
662 float particle_tex; // number of chunk in particlefont
663 float particle_size;
664 float particle_sizeincrease;
665 float particle_alpha;
666 float particle_alphafade;
667 float particle_time;
668 float particle_gravity;
669 float particle_bounce;
670 float particle_airfriction;
671 float particle_liquidfriction;
672 float particle_originjitter;
673 float particle_velocityjitter;
674 float particle_qualityreduction; // enable culling of this particle when FPS is low
675 float particle_stretch;
676 vector particle_staincolor1;
677 vector particle_staincolor2;
678 float particle_staintex;
679 float particle_stainalpha;
680 float particle_stainsize;
681 float particle_delayspawn;
682 float particle_delaycollision;
683 float particle_angle;
684 float particle_spin;
685 // builtin definitions:
686 float(float max_themes) initparticlespawner = #522; // check fields/globals for integration and enable particle spawner, return 1 is succeded, otherwise returns 0
687 void() resetparticle = #523; // reset p_ globals to default theme #0
688 void(float theme) particletheme = #524; // restore p_ globals from saved theme
689 float() particlethemesave = #525; // save p_ globals to new particletheme and return it's index
690 void(float theme) particlethemeupdate = #525; // save p_ globals to new particletheme and return it's index
691 void(float theme) particlethemefree = #526; // delete a particle theme
692 float(vector org, vector vel) spawnparticle = #527; // returns 0 when failed, 1 when spawned
693 float(vector org, vector vel, float theme) quickparticle = #527; // not reading globals, just theme, returns 0 when failed, 1 when spawned
694 float(vector org, vector vel, float delay, float collisiondelay) delayedparticle = #528;
695 float(vector org, vector vel, float delay, float collisiondelay, float theme) quickdelayedparticle = #528;
696 // description: this builtin provides an easy and flexible way to spawn particles,
697 // it is not created as replace for DP_SV_POINTPARTICLES but as an addition to it.
698 // With this extension you can create a specific particles like rain particles, or entity particles
699 // notes:
700 // 1) 0 is default particle template, it could be changed
701 // 2) color vectors could have value 0-255 of each component
702 // restrictions: max themes could be between 4 and 2048
703 // warning: you should call initparticlespawner() at very beginning BEFORE all other particle spawner functions
704 // function to query particle info
705 // don't remove this function as it protects all particle_ globals from FTEQCC/FRIKQCC non-referenced removal optimisation
706 void() printparticle =
707 {
708         // vortex: this also protects from 'non-referenced' optimisation on some compilers
709         print("PARTICLE:\n");
710         print(strcat("  type: ", ftos(particle_type), "\n"));
711         print(strcat("  blendmode: ", ftos(particle_blendmode), "\n"));
712         print(strcat("  orientation: ", ftos(particle_orientation), "\n"));
713         print(strcat("  color1: ", vtos(particle_color1), "\n"));
714         print(strcat("  color2: ", vtos(particle_color2), "\n"));
715         print(strcat("  tex: ", ftos(particle_tex), "\n"));
716         print(strcat("  size: ", ftos(particle_size), "\n"));
717         print(strcat("  sizeincrease: ", ftos(particle_sizeincrease), "\n"));
718         print(strcat("  alpha: ", ftos(particle_alpha), "\n"));
719         print(strcat("  alphafade: ", ftos(particle_alphafade), "\n"));
720         print(strcat("  time: ", ftos(particle_time), "\n"));
721         print(strcat("  gravity: ", ftos(particle_gravity), "\n"));
722         print(strcat("  bounce: ", ftos(particle_bounce), "\n"));
723         print(strcat("  airfriction: ", ftos(particle_airfriction), "\n"));
724         print(strcat("  liquidfriction: ", ftos(particle_liquidfriction), "\n"));
725         print(strcat("  originjitter: ", ftos(particle_originjitter), "\n"));
726         print(strcat("  velocityjitter: ", ftos(particle_velocityjitter), "\n"));
727         print(strcat("  qualityreduction: ", ftos(particle_qualityreduction), "\n"));
728         print(strcat("  stretch: ", ftos(particle_stretch), "\n"));
729         print(strcat("  staincolor1: ", vtos(particle_staincolor1), "\n"));
730         print(strcat("  staincolor2: ", vtos(particle_staincolor2), "\n"));
731         print(strcat("  staintex: ", ftos(particle_staintex), "\n"));
732         print(strcat("  stainalpha: ", ftos(particle_stainalpha), "\n"));
733         print(strcat("  stainsize: ", ftos(particle_stainsize), "\n"));
734         print(strcat("  delayspawn: ", ftos(particle_delayspawn), "\n"));
735         print(strcat("  delaycollision: ", ftos(particle_delaycollision), "\n"));
736         print(strcat("  angle: ", ftos(particle_angle), "\n"));
737         print(strcat("  spin: ", ftos(particle_spin), "\n"));
738 }
739
740 // DP_CSQC_ENTITYTRANSPARENTSORTING_OFFSET
741 // idea: VorteX
742 // darkplaces implementation: VorteX
743 float RF_USETRANSPARENTOFFSET = 64; // enables transparent origin offsetting
744 // global definitions
745 float transparent_offset; // should be set before entity is added
746 // description: offset a model's meshes origin used for transparent sorting. Could be used to tweak sorting bugs on very large transparent entities or hacking transparent sorting order for certain objects
747 // example: transparent_offset = 1000000; // entity always appear on background of other transparents
748 // note: offset is done in view forward axis
749
750 // DP_CSQC_ENTITYWORLDOBJECT
751 // idea: VorteX
752 // darkplaces implementation: VorteX
753 const float RF_WORLDOBJECT = 128;
754 // description: when renderflag is set, engine will not use culling methods for this entity, e.g. it will always be drawn
755 // useful for large outdoor objects (like asteroids on sky horizon or sky models)
756
757 // DP_CSQC_ENTITYMODELLIGHT
758 // idea: VorteX
759 // darkplaces implementation: VorteX
760 const float RF_MODELLIGHT = 4096;
761 .vector modellight_ambient;
762 .vector modellight_diffuse;
763 .vector modellight_dir;
764 // description: allows CSQC to override directional model lightning on entity
765
766 // DP_CSQC_SETPAUSE
767 // idea: VorteX
768 // darkplaces implementation: VorteX
769 // builtin definitions:
770 void(float ispaused) setpause = #531;
771 // description: provides ability to set pause in local games (similar to one set once console is activated)
772 // not stopping sound/cd track, useful for inventory screens, ingame menus with input etc.
773
774 // DP_CSQC_QUERYRENDERENTITY
775 // idea: VorteX
776 // darkplaces implementation: VorteX
777 // constant definitions:
778 // render entity fields:
779 float E_ACTIVE      = 0; // float 0/1
780 float E_ORIGIN      = 1; // vector
781 float E_FORWARD     = 2; // vector
782 float E_RIGHT       = 3; // vector
783 float E_UP          = 4; // vector
784 float E_SCALE       = 5; // float
785 float E_ORIGINANDVECTORS = 6; // returns origin, + sets v_* vectors to orientation
786 float E_ALPHA       = 7; // float
787 float E_COLORMOD    = 8; // vector
788 float E_PANTSCOLOR  = 9; // vector
789 float E_SHIRTCOLOR  = 10; // vector
790 float E_SKIN        = 11; // float
791 float E_MINS        = 12; // vector
792 float E_MAXS        = 13; // vector
793 float E_ABSMIN      = 14; // vector
794 float E_ABSMAX      = 15; // vector
795 float E_LIGHT       = 16; // vector - modellight
796 // builtin definitions:
797 float(float entitynum, float fldnum) getentity = #504;
798 vector(float entitynum, float fldnum) getentityvec = #504;
799 // description: allows to query parms from render entities, especially useful with attaching CSQC ents to
800 // server entities networked and interpolated by engine (monsters, players), number of entity is it's SVQC number
801 // you can send it via tempentity/CSQC entity message. Note that this builtin doesnt know about entity removing/reallocating
802 // so it's meaning to work for short period of time, dont use it on missiles/grenades whatever will be removed next five seconds
803
804 //DP_GFX_FONTS
805 //idea: Blub\0, divVerent
806 //darkplaces implementation: Blub\0
807 //console commands:
808 //  loadfont fontname fontmaps size1 size2 ...
809 //   A font can simply be gfx/tgafile (freetype fonts doent need extension),
810 //   or alternatively you can specify multiple fonts and faces
811 //   Like this: gfx/vera-sans:2,gfx/fallback:1
812 //   to load face 2 of the font gfx/vera-sans and use face 1
813 //   of gfx/fallback as fallback font
814 //   You can also specify a list of font sizes to load, like this:
815 //   loadfont console gfx/conchars,gfx/fallback 8 12 16 24 32
816 //   In many cases, 8 12 16 24 32 should be a good choice.
817 //   for slots see:
818 //constant definitions:
819 float drawfont;            // set it before drawstring()/drawchar() calls
820 float FONT_DEFAULT = 0;    // 'default'
821 float FONT_CONSOLE = 1;    // 'console', REALLY should be fixed width (ls!)
822 float FONT_SBAR = 2;       // 'sbar', used on hud, must be fixed width
823 float FONT_NOTIFY = 3;     // 'notify', used on sprint/bprint
824 float FONT_CHAT = 4;       // 'chat'
825 float FONT_CENTERPRINT = 5;// 'centerprint'
826 float FONT_INFOBAR = 6;    // 'infobar'
827 float FONT_MENU = 7;       // 'menu', should be fixed width
828 float FONT_USER0 = 8;      // 'user0', userdefined fonts
829 float FONT_USER1 = 9;      // 'user1', userdefined fonts
830 float FONT_USER2 = 10;     // 'user2', userdefined fonts
831 float FONT_USER3 = 11;     // 'user3', userdefined fonts
832 float FONT_USER4 = 12;     // 'user4', userdefined fonts
833 float FONT_USER5 = 13;     // 'user5', userdefined fonts
834 float FONT_USER6 = 14;     // 'user6', userdefined fonts
835 float FONT_USER7 = 15;     // 'user7' slot, userdefined fonts
836 //builtin definitions:
837 float findfont(string s) = #356; // find font by fontname and return it's index
838 float loadfont(string fontname, string fontmaps, string sizes, float slot, float fix_scale, float fix_voffset) = #357;
839 // loads font immediately so stringwidth() function can be used just after builtin call
840 // returns a font slotnum (which is used to set drawfont to)
841 // first 3 parms are identical to "loadfont" console command ones
842 // slot could be one of FONT_ constants or result of findfont() or -1 to not use it
843 // if slot is given, font will be loaded to this slotnum and fontname become new title for it
844 // this way you can rename user* fonts to something more usable
845 // fix_* parms let you fix badly made fonts by applying some transformations to them
846 // fix_scale : per-character center-oriented scale (doesn't change line height at all)
847 // fix_voffset : vertical offset for each character, it's a multiplier to character height
848 float stringwidth(string text, float allowColorCodes, vector size) = #327; // get a width of string with given font and char size
849 float stringwidth_menu(string text, float allowColorCodes, vector size) = #468; // in menu.dat it has different builtin #
850 //description: engine support for custom fonts in console, hud, qc etc.
851 // limits:
852 //  max 128 chars for font name
853 //  max 3 font fallbacks
854 //  max 8 sizes per font
855
856 //DP_GFX_FONTS_FREETYPE
857 //idea: Blub\0, divVerent
858 //darkplaces implementation: Blub\0
859 //cvar definitions:
860 //   r_font_disable_freetype 0/1 : disable freetype fonts loading (uttetly disables freetype library initialization)
861 //   r_font_antialias 0/1 : antialiasing when loading font
862 //   r_font_hint 0/1/2/3  : hinting when loading font, 0 is no hinting, 1 light autohinting , 2 full autohinting, 3 full hinting
863 //   r_font_postprocess_blur X      : font outline blur amount
864 //   r_font_postprocess_outline X   : font outline width
865 //   r_font_postprocess_shadow_x X  : font outline shadow x shift amount, applied during outlining
866 //   r_font_postprocess_shadow_y X  : font outline shadow y shift amount, applied during outlining
867 //   r_font_postprocess_shadow_z X  : font outline shadow z shift amount, applied during blurring
868 //description: engine support for truetype/freetype fonts
869 //so .AFM+.PFB/.OTF/.TTF files could be stuffed as fontmaps in loadfont()
870 //(console command version will support them as well)
871
872 //DP_CSQC_BINDMAPS
873 //idea: daemon, motorsep
874 //darkplaces implementation: divVerent
875 //builtin definitions:
876 string(float key, float bindmap) getkeybind_bindmap = #342;
877 float(float key, string bind, float bindmap) setkeybind_bindmap = #630;
878 vector(void) getbindmaps = #631;
879 float(vector bm) setbindmaps = #632;
880 string(string command, float bindmap) findkeysforcommand = #610;
881 //<already in EXT_CSQC> float(string key) stringtokeynum = #341;
882 //<already in EXT_CSQC> string(float keynum) keynumtostring = #340;
883 //description: key bind setting/getting including support for switchable
884 //bindmaps.
885
886 //DP_CRYPTO
887 //idea: divVerent
888 //darkplaces implementation: divVerent
889 //builtin definitions: (CSQC)
890 float(string url, float id, string content_type, string delim, float buf, float keyid) crypto_uri_postbuf = #513;
891 //description:
892 //use -1 as buffer handle to justs end delim as postdata
893
894 //DP_CSQC_MAINVIEW
895 //idea: divVerent
896 //darkplaces implementation: divVerent
897 //constant definitions:
898 const float VF_MAINVIEW         = 400;
899 //use setproperty(VF_MAINVIEW, 1); before calling R_RenderView for the render
900 //that shall become the "main" view, which is e.g. used by PRYDON_CLIENTCURSOR
901 //this flag is set for the first scene, and not cleared by R_ClearScene
902 //this flag is automatically cleared by R_RenderView
903 //so when not using this extension, the first view rendered is the main view
904
905 //DP_CSQC_MINFPS_QUALITY
906 //idea: divVerent
907 //darkplaces implementation: divVerent
908 //constant definitions:
909 const float VF_MINFPS_QUALITY   = 401;
910 //use getproperty(VF_MINFPS_QUALITY); to do CSQC based LOD based on cl_minfps
911 //1 should lead to an unmodified view
912
913 //DP_CSQC_V_CALCREFDEF_WIP1
914 //DP_CSQC_V_CALCREFDEF_WIP2
915 //idea: divVerent
916 //darkplaces implementation: divVerent
917 //builtin definitions:
918 void(entity e, float refdefflags) V_CalcRefdef = #640;
919 //constant definitions:
920 float PMF_DUCKED = 4;
921 float PMF_ONGROUND = 8;
922 float REFDEFFLAG_TELEPORTED = 1;
923 float REFDEFFLAG_JUMPING = 2;
924 float REFDEFFLAG_DEAD = 4;
925 float REFDEFFLAG_INTERMISSION = 8;
926 //- use this on the player entity after performing prediction
927 //- pass REFDEFFLAG_TELEPORTED if the player teleported since last frame
928 //- pass REFDEFFLAG_JUMPING if jump button is pressed
929 //- pass REFDEFFLAG_DEAD if dead (DP_CSQC_V_CALCREFDEF_WIP2)
930 //- pass REFDEFFLAG_INTERMISSION if in intermission (DP_CSQC_V_CALCREFDEF_WIP2)
931 //- the player entity needs to have origin, velocity, pmove_flags set according
932 //  to prediction (the above two PMF_ flags are used in the player's pmove_flags)
933 //- NOTE: to check for this, ALSO OR a check with DP_CSQC_V_CALCREFDEF to also support
934 //  the finished extension once done
935
936 // assorted builtins
937 float   drawsubpic(vector position, vector size, string pic, vector srcPosition, vector srcSize, vector rgb, float alpha, float flag) = #328;
938 vector  drawgetimagesize(string pic) = #318;
939 #define SPA_POSITION 0
940 #define SPA_S_AXIS 1
941 #define SPA_T_AXIS 2
942 #define SPA_R_AXIS 3
943 #define SPA_TEXCOORDS0 4
944 #define SPA_LIGHTMAP0_TEXCOORDS 5
945 #define SPA_LIGHTMAP_COLOR 6
946 float (entity e, float s)                                               getsurfacenumpoints = #434;
947 vector (entity e, float s, float n)                                     getsurfacepoint = #435;
948 vector (entity e, float s)                                              getsurfacenormal = #436;
949 string (entity e, float s)                                              getsurfacetexture = #437;
950 float (entity e, vector p)                                              getsurfacenearpoint = #438;
951 vector (entity e, float s, vector p)                                    getsurfaceclippedpoint = #439;
952 vector(entity e, float s, float n, float a) getsurfacepointattribute = #486;
953 float(entity e, float s) getsurfacenumtriangles = #628;
954 vector(entity e, float s, float n) getsurfacetriangle = #629;
955
956 //DP_QC_ASINACOSATANATAN2TAN
957 //idea: Urre
958 //darkplaces implementation: LordHavoc
959 //constant definitions:
960 float DEG2RAD = 0.0174532925199432957692369076848861271344287188854172545609719144;
961 float RAD2DEG = 57.2957795130823208767981548141051703324054724665643215491602438612;
962 float PI      = 3.1415926535897932384626433832795028841971693993751058209749445923;
963 //builtin definitions:
964 float(float s) asin = #471; // returns angle in radians for a given sin() value, the result is in the range -PI*0.5 to PI*0.5
965 float(float c) acos = #472; // returns angle in radians for a given cos() value, the result is in the range 0 to PI
966 float(float t) atan = #473; // returns angle in radians for a given tan() value, the result is in the range -PI*0.5 to PI*0.5
967 float(float c, float s) atan2 = #474; // returns angle in radians for a given cos() and sin() value pair, the result is in the range -PI to PI (this is identical to vectoyaw except it returns radians rather than degrees)
968 float(float a) tan = #475; // returns tangent value (which is simply sin(a)/cos(a)) for the given angle in radians, the result is in the range -infinity to +infinity
969 //description:
970 //useful math functions for analyzing vectors, note that these all use angles in radians (just like the cos/sin functions) not degrees unlike makevectors/vectoyaw/vectoangles, so be sure to do the appropriate conversions (multiply by DEG2RAD or RAD2DEG as needed).
971 //note: atan2 can take unnormalized vectors (just like vectoyaw), and the function was included only for completeness (more often you want vectoyaw or vectoangles), atan2(v_x,v_y) * RAD2DEG gives the same result as vectoyaw(v)
972
973 //DP_QC_SPRINTF
974 //idea: divVerent
975 //darkplaces implementation: divVerent
976 //builtin definitions:
977 string(string format, ...) sprintf = #627;
978 //description:
979 //you know sprintf :P
980 //supported stuff:
981 //  %
982 //  optional: <argpos>$ for the argument to format
983 //  flags: #0- +
984 //  optional: <width>, *, or *<argpos>$ for the field width
985 //  optional: .<precision>, .*, or .*<argpos>$ for the precision
986 //  length modifiers: h for forcing a float, l for forcing an int/entity (by default, %d etc. cast a float to int)
987 //  conversions:
988 //    d takes a float if no length is specified or h is, and an int/entity if l is specified as length, and cast it to an int
989 //    i takes an int/entity if no length is specified or i is, and a float if h is specified as length, and cast it to an int
990 //    ouxXc take a float if no length is specified or h is, and an int/entity if l is specified as length, and cast it to an unsigned int
991 //    eEfFgG take a float if no length is specified or h is, and an int/entity if l is specified as length, and cast it to a double
992 //    s takes a string
993 //    vV takes a vector, and processes the three components as if it were a gG for all three components, separated by space
994 //    For conversions s and c, the flag # makes precision and width interpreted
995 //      as byte count, by default it is interpreted as character count in UTF-8
996 //      enabled engines. No other conversions can create wide characters, and #
997 //      has another meaning in these.
998
999 //DP_QC_GETTIME
1000 //idea: tZork
1001 //darkplaces implementation: tZork, divVerent
1002 //constant definitions:
1003 float GETTIME_FRAMESTART = 0; // time of start of frame
1004 float GETTIME_REALTIME = 1; // current time (may be OS specific)
1005 float GETTIME_HIRES = 2; // like REALTIME, but may reset between QC invocations and thus can be higher precision
1006 float GETTIME_UPTIME = 3; // time since start of the engine
1007 //builtin definitions:
1008 float(float tmr) gettime = #519;
1009 //description:
1010 //some timers to query...
1011
1012 //DP_QC_GETTIME_CDTRACK
1013 //idea: divVerent
1014 //darkplaces implementation: divVerent
1015 //constant definitions:
1016 float GETTIME_CDTRACK = 4;
1017 //description:
1018 //returns the playing time of the current cdtrack when passed to gettime()
1019 //see DP_END_GETSOUNDTIME for similar functionality but for entity sound channels
1020
1021 //DP_QC_TOKENIZEBYSEPARATOR
1022 //idea: Electro, SavageX, LordHavoc
1023 //darkplaces implementation: LordHavoc
1024 //builtin definitions:
1025 float(string s, string separator1, ...) tokenizebyseparator = #479;
1026 //description:
1027 //this function returns tokens separated by any of the supplied separator strings, example:
1028 //numnumbers = tokenizebyseparator("10.2.3.4", ".");
1029 //returns 4 and the tokens are "10" "2" "3" "4"
1030 //possibly useful for parsing IPv4 addresses (such as "1.2.3.4") and IPv6 addresses (such as "[1234:5678:9abc:def0:1234:5678:9abc:def0]:26000")
1031
1032 //DP_QC_TOKENIZE_CONSOLE
1033 //idea: divVerent
1034 //darkplaces implementation: divVerent
1035 //builtin definitions:
1036 float(string s) tokenize_console = #514;
1037 float(float i) argv_start_index = #515;
1038 float(float i) argv_end_index = #516;
1039 //description:
1040 //this function returns tokens separated just like the console does
1041 //also, functions are provided to get the index of the first and last character of each token in the original string
1042 //Passing negative values to them, or to argv, will be treated as indexes from the LAST token (like lists work in Perl). So argv(-1) will return the LAST token.
1043
1044 //DP_SND_SOUND7_WIP1
1045 //DP_SND_SOUND7_WIP2
1046 //idea: divVerent
1047 //darkplaces implementation: divVerent
1048 //builtin definitions:
1049 void(entity e, float chan, string samp, float vol, float atten, float speed, float flags) sound7 = #8;
1050 float SOUNDFLAG_RELIABLE = 1;
1051 //description:
1052 //plays a sound, with some more flags
1053 //extensions to sound():
1054 //- channel may be in the range from -128 to 127; channels -128 to 0 are "auto",
1055 //  i.e. support multiple sounds at once, but cannot be stopped/restarted
1056 //- a value 0 in the speed parameter means no change; otherwise, it is a
1057 //  percentage of playback speed ("pitch shifting"). 100 is normal pitch, 50 is
1058 //  half speed, 200 is double speed, etc. (DP_SND_SOUND7_WIP2)
1059 //- the flag SOUNDFLAG_RELIABLE can be specified, which makes the sound send
1060 //  to MSG_ALL (reliable) instead of MSG_BROADCAST (unreliable, default);
1061 //  similarily, SOUNDFLAG_RELIABLE_TO_ONE sends to MSG_ONE
1062 //- channel 0 is controlled by snd_channel0volume; channel 1 and -1 by
1063 //  snd_channel1volume, etc. (so, a channel shares the cvar with its respective
1064 //  auto-channel); however, the mod MUST define snd_channel8volume and upwards
1065 //  in default.cfg if they are to be used, as the engine does not create them
1066 //  to not litter the cvar list
1067 //- this extension applies to CSQC as well; CSQC_Event_Sound will get speed and
1068 //  flags as extra 7th and 8th argument
1069 //- WIP2 ideas: SOUNDFLAG_RELIABLE_TO_ONE, SOUNDFLAG_NOPHS, SOUNDFLAG_FORCELOOP
1070 //- NOTE: to check for this, ALSO OR a check with DP_SND_SOUND7 to also support
1071 //  the finished extension once done
1072
1073 //DP_PRECACHE_PIC_FLAGS
1074 //idea: divVerent
1075 //darkplaces implementation: divVerent
1076 //constant definitions:
1077 float PRECACHE_PIC_FROMWAD = 1; // this one actually is part of EXT_CSQC
1078 float PRECACHE_PIC_NOTPERSISTENT = 2; // picture may get deallocated when unused
1079 float PRECACHE_PIC_MIPMAP = 8; // mipmap the texture for possibly better downscaling at memory expense
1080 //notes: these constants are given as optional second argument to precache_pic()
1081
1082 //DP_QC_TRACE_MOVETYPE_WORLDONLY
1083 //idea: LordHavoc
1084 //darkplaces implementation: LordHavoc
1085 //constant definitions:
1086 float MOVE_WORLDONLY = 3;
1087 //description:
1088 //allows traces to hit only world (ignoring all entities, unlike MOVE_NOMONSTERS which hits all bmodels), use as the nomonsters parameter to trace functions
1089
1090 //DP_SND_GETSOUNDTIME
1091 //idea: VorteX
1092 //darkplaces implementation: VorteX
1093 //constant definitions:
1094 float(entity e, float channel) getsoundtime = #533; // get currently sound playing position on entity channel, -1 if not playing or error
1095 float(string sample) soundlength = #534; // returns length of sound sample in seconds, -1 on error (sound not precached, sound system not initialized etc.)
1096 //description: provides opportunity to query length of sound samples and realtime tracking of sound playing on entities (similar to DP_GETTIME_CDTRACK)
1097 //note: beware dedicated server not running sound engine at all, so in dedicated mode this builtins will not work in server progs
1098 //note also: menu progs not supporting getsoundtime() (will give a warning) since it has no sound playing on entities
1099 //examples of use:
1100 //  - QC-driven looped sounds
1101 //  - QC events when sound playing is finished
1102 //  - toggleable ambientsounds
1103 //  - subtitles
1104
1105 //DP_QC_NUM_FOR_EDICT
1106 //idea: Blub\0
1107 //darkplaces implementation: Blub\0
1108 //Function to get the number of an entity - a clean way.
1109 float(entity num) num_for_edict = #512;
1110
1111 //DP_TRACE_HITCONTENTSMASK_SURFACEINFO
1112 //idea: LordHavoc
1113 //darkplaces implementation: LordHavoc
1114 //globals:
1115 .float dphitcontentsmask; // if non-zero on the entity passed to traceline/tracebox/tracetoss this will override the normal collidable contents rules and instead hit these contents values (for example AI can use tracelines that hit DONOTENTER if it wants to, by simply changing this field on the entity passed to traceline), this affects normal movement as well as trace calls
1116 float trace_dpstartcontents; // DPCONTENTS_ value at start position of trace
1117 float trace_dphitcontents; // DPCONTENTS_ value of impacted surface (not contents at impact point, just contents of the surface that was hit)
1118 float trace_dphitq3surfaceflags; // Q3SURFACEFLAG_ value of impacted surface
1119 string trace_dphittexturename; // texture name of impacted surface
1120 //constants:
1121 float DPCONTENTS_SOLID = 1; // hit a bmodel, not a bounding box
1122 float DPCONTENTS_WATER = 2;
1123 float DPCONTENTS_SLIME = 4;
1124 float DPCONTENTS_LAVA = 8;
1125 float DPCONTENTS_SKY = 16;
1126 float DPCONTENTS_BODY = 32; // hit a bounding box, not a bmodel
1127 float DPCONTENTS_CORPSE = 64; // hit a SOLID_CORPSE entity
1128 float DPCONTENTS_NODROP = 128; // an area where backpacks should not spawn
1129 float DPCONTENTS_PLAYERCLIP = 256; // blocks player movement
1130 float DPCONTENTS_MONSTERCLIP = 512; // blocks monster movement
1131 float DPCONTENTS_DONOTENTER = 1024; // AI hint brush
1132 float DPCONTENTS_LIQUIDSMASK = 14; // WATER | SLIME | LAVA
1133 float DPCONTENTS_BOTCLIP = 2048; // AI hint brush
1134 float DPCONTENTS_OPAQUE = 4096; // only fully opaque brushes get this (may be useful for line of sight checks)
1135 float Q3SURFACEFLAG_NODAMAGE = 1;
1136 float Q3SURFACEFLAG_SLICK = 2; // low friction surface
1137 float Q3SURFACEFLAG_SKY = 4; // sky surface (also has NOIMPACT and NOMARKS set)
1138 float Q3SURFACEFLAG_LADDER = 8; // climbable surface
1139 float Q3SURFACEFLAG_NOIMPACT = 16; // projectiles should remove themselves on impact (this is set on sky)
1140 float Q3SURFACEFLAG_NOMARKS = 32; // projectiles should not leave marks, such as decals (this is set on sky)
1141 float Q3SURFACEFLAG_FLESH = 64; // projectiles should do a fleshy effect (blood?) on impact
1142 float Q3SURFACEFLAG_NODRAW = 128; // compiler hint (not important to qc)
1143 //float Q3SURFACEFLAG_HINT = 256; // compiler hint (not important to qc)
1144 //float Q3SURFACEFLAG_SKIP = 512; // compiler hint (not important to qc)
1145 //float Q3SURFACEFLAG_NOLIGHTMAP = 1024; // compiler hint (not important to qc)
1146 //float Q3SURFACEFLAG_POINTLIGHT = 2048; // compiler hint (not important to qc)
1147 float Q3SURFACEFLAG_METALSTEPS = 4096; // walking on this surface should make metal step sounds
1148 float Q3SURFACEFLAG_NOSTEPS = 8192; // walking on this surface should not make footstep sounds
1149 float Q3SURFACEFLAG_NONSOLID = 16384; // compiler hint (not important to qc)
1150 //float Q3SURFACEFLAG_LIGHTFILTER = 32768; // compiler hint (not important to qc)
1151 //float Q3SURFACEFLAG_ALPHASHADOW = 65536; // compiler hint (not important to qc)
1152 //float Q3SURFACEFLAG_NODLIGHT = 131072; // compiler hint (not important to qc)
1153 //float Q3SURFACEFLAG_DUST = 262144; // translucent 'light beam' effect (not important to qc)
1154 //description:
1155 //adds additional information after a traceline/tracebox/tracetoss call.
1156 //also (very important) sets trace_* globals before calling .touch functions,
1157 //this allows them to inspect the nature of the collision (for example
1158 //determining if a projectile hit sky), clears trace_* variables for the other
1159 //object in a touch event (that is to say, a projectile moving will see the
1160 //trace results in its .touch function, but the player it hit will see very
1161 //little information in the trace_ variables as it was not moving at the time)
1162
1163 //DP_QC_CVAR_TYPE
1164 //idea: divVerent
1165 //DarkPlaces implementation: divVerent
1166 //builtin definitions:
1167 float(string name) cvar_type = #495;
1168 float CVAR_TYPEFLAG_EXISTS = 1;
1169 float CVAR_TYPEFLAG_SAVED = 2;
1170 float CVAR_TYPEFLAG_PRIVATE = 4;
1171 float CVAR_TYPEFLAG_ENGINE = 8;
1172 float CVAR_TYPEFLAG_HASDESCRIPTION = 16;
1173 float CVAR_TYPEFLAG_READONLY = 32;
1174
1175 //DP_QC_CRC16
1176 //idea: divVerent
1177 //darkplaces implementation: divVerent
1178 //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.
1179 //When caseinsensitive is set, the CRC is calculated of the lower cased string.
1180 float(float caseinsensitive, string s, ...) crc16 = #494;
1181
1182 //DP_QC_URI_ESCAPE
1183 //idea: divVerent
1184 //darkplaces implementation: divVerent
1185 //URI::Escape's functionality
1186 string(string in) uri_escape = #510;
1187 string(string in) uri_unescape = #511;
1188
1189 //DP_QC_DIGEST
1190 //idea: motorsep, Spike
1191 //DarkPlaces implementation: divVerent
1192 //builtin definitions:
1193 string(string digest, string data, ...) digest_hex = #639;
1194 //description:
1195 //returns a given hex digest of given data
1196 //the returned digest is always encoded in hexadecimal
1197 //only the "MD4" digest is always supported!
1198 //if the given digest is not supported, string_null is returned
1199 //the digest string is matched case sensitively, use "MD4", not "md4"!
1200
1201 //DP_QC_DIGEST_SHA256
1202 //idea: motorsep, Spike
1203 //DarkPlaces implementation: divVerent
1204 //description:
1205 //"SHA256" is also an allowed digest type
1206
1207 //DP_QC_LOG
1208 //darkplaces implementation: divVerent
1209 //builtin definitions:
1210 float log(float f) = #532;
1211 //description:
1212 //logarithm
1213
1214 //FTE_CSQC_SKELETONOBJECTS
1215 //idea: Spike, LordHavoc
1216 //darkplaces implementation: LordHavoc
1217 //builtin definitions:
1218 // all skeleton numbers are 1-based (0 being no skeleton)
1219 // all bone numbers are 1-based (0 being invalid)
1220 float(float modlindex) skel_create = #263; // create a skeleton (be sure to assign this value into .skeletonindex for use), returns skeleton index (1 or higher) on success, returns 0 on failure (for example if the modelindex is not skeletal), it is recommended that you create a new skeleton if you change modelindex, as the skeleton uses the hierarchy from the model.
1221 float(float skel, entity ent, float modlindex, float retainfrac, float firstbone, float lastbone) skel_build = #264; // blend in a percentage of standard animation, 0 replaces entirely, 1 does nothing, 0.5 blends half, etc, and this only alters the bones in the specified range for which out of bounds values like 0,100000 are safe (uses .frame, .frame2, .frame3, .frame4, .lerpfrac, .lerpfrac3, .lerpfrac4, .frame1time, .frame2time, .frame3time, .frame4time), returns skel on success, 0 on failure
1222 float(float skel) skel_get_numbones = #265; // returns how many bones exist in the created skeleton, 0 if skeleton does not exist
1223 string(float skel, float bonenum) skel_get_bonename = #266; // returns name of bone (as a tempstring), "" if invalid bonenum (< 1 for example) or skeleton does not exist
1224 float(float skel, float bonenum) skel_get_boneparent = #267; // returns parent num for supplied bonenum, 0 if bonenum has no parent or bone does not exist (returned value is always less than bonenum, you can loop on this)
1225 float(float skel, string tagname) skel_find_bone = #268; // get number of bone with specified name, 0 on failure, bonenum (1-based) on success, same as using gettagindex but takes modelindex instead of entity
1226 vector(float skel, float bonenum) skel_get_bonerel = #269; // get matrix of bone in skeleton relative to its parent - sets v_forward, v_right, v_up, returns origin (relative to parent bone)
1227 vector(float skel, float bonenum) skel_get_boneabs = #270; // get matrix of bone in skeleton in model space - sets v_forward, v_right, v_up, returns origin (relative to entity)
1228 void(float skel, float bonenum, vector org) skel_set_bone = #271; // set matrix of bone relative to its parent, reads v_forward, v_right, v_up, takes origin as parameter (relative to parent bone)
1229 void(float skel, float bonenum, vector org) skel_mul_bone = #272; // transform bone matrix (relative to its parent) by the supplied matrix in v_forward, v_right, v_up, takes origin as parameter (relative to parent bone)
1230 void(float skel, float startbone, float endbone, vector org) skel_mul_bones = #273; // transform bone matrices (relative to their parents) by the supplied matrix in v_forward, v_right, v_up, takes origin as parameter (relative to parent bones)
1231 void(float skeldst, float skelsrc, float startbone, float endbone) skel_copybones = #274; // copy bone matrices (relative to their parents) from one skeleton to another, useful for copying a skeleton to a corpse
1232 void(float skel) skel_delete = #275; // deletes skeleton at the beginning of the next frame (you can add the entity, delete the skeleton, renderscene, and it will still work)
1233 float(float modlindex, string framename) frameforname = #276; // finds number of a specified frame in the animation, returns -1 if no match found
1234 float(float modlindex, float framenum) frameduration = #277; // returns the intended play time (in seconds) of the specified framegroup, if it does not exist the result is 0, if it is a single frame it may be a small value around 0.1 or 0.
1235 //fields:
1236 .float skeletonindex; // active skeleton overriding standard animation on model
1237 .float frame; // primary framegroup animation (strength = 1 - lerpfrac - lerpfrac3 - lerpfrac4)
1238 .float frame2; // secondary framegroup animation (strength = lerpfrac)
1239 .float frame3; // tertiary framegroup animation (strength = lerpfrac3)
1240 .float frame4; // quaternary framegroup animation (strength = lerpfrac4)
1241 .float lerpfrac; // strength of framegroup blend
1242 .float lerpfrac3; // strength of framegroup blend
1243 .float lerpfrac4; // strength of framegroup blend
1244 .float frame1time; // start time of framegroup animation
1245 .float frame2time; // start time of framegroup animation
1246 .float frame3time; // start time of framegroup animation
1247 .float frame4time; // start time of framegroup animation
1248 //description:
1249 //this extension provides a way to do complex skeletal animation on an entity.
1250 //
1251 //see also DP_SKELETONOBJECTS (this extension implemented on server as well as client)
1252 //
1253 //notes:
1254 //each model contains its own skeleton, reusing a skeleton with incompatible models will yield garbage (or not render).
1255 //each model contains its own animation data, you can use animations from other model files (for example saving out all character animations as separate model files).
1256 //if an engine supports loading an animation-only file format such as .md5anim in FTEQW, it can be used to animate any model with a compatible skeleton.
1257 //proper use of this extension may require understanding matrix transforms (v_forward, v_right, v_up, origin), and you must keep in mind that v_right is negative for this purpose.
1258 //
1259 //features include:
1260 //multiple animations blended together.
1261 //animating a model with animations from another model with a compatible skeleton.
1262 //restricting animation blends to certain bones of a model - for example independent animation of legs, torso, head.
1263 //custom bone controllers - for example making eyes track a target location.
1264 //
1265 //
1266 //
1267 //example code follows...
1268 //
1269 //this helper function lets you identify (by parentage) what group a bone
1270 //belongs to - for example "torso", "leftarm", would return 1 ("torso") for
1271 //all children of the bone named "torso", unless they are children of
1272 //"leftarm" (which is a child of "torso") which would return 2 instead...
1273 float(float skel, float bonenum, string g1, string g2, string g3, string g4, string g5, string g6) example_skel_findbonegroup =
1274 {
1275         local string bonename;
1276         while (bonenum >= 0)
1277         {
1278                 bonename = skel_get_bonename(skel, bonenum);
1279                 if (bonename == g1) return 1;
1280                 if (bonename == g2) return 2;
1281                 if (bonename == g3) return 3;
1282                 if (bonename == g4) return 4;
1283                 if (bonename == g5) return 5;
1284                 if (bonename == g6) return 6;
1285                 bonenum = skel_get_boneparent(skel, bonenum);
1286         }
1287         return 0;
1288 };
1289 // create a skeletonindex for our player using current modelindex
1290 void() example_skel_player_setup =
1291 {
1292         self.skeletonindex = skel_create(self.modelindex);
1293 };
1294 // setup bones of skeleton based on an animation
1295 // note: animmodelindex can be a different model than self.modelindex
1296 void(float animmodelindex, float framegroup, float framegroupstarttime) example_skel_player_update_begin =
1297 {
1298         // start with our standard animation
1299         self.frame = framegroup;
1300         self.frame2 = 0;
1301         self.frame3 = 0;
1302         self.frame4 = 0;
1303         self.frame1time = framegroupstarttime;
1304         self.frame2time = 0;
1305         self.frame3time = 0;
1306         self.frame4time = 0;
1307         self.lerpfrac = 0;
1308         self.lerpfrac3 = 0;
1309         self.lerpfrac4 = 0;
1310         skel_build(self.skeletonindex, self, animmodelindex, 0, 0, 100000);
1311 };
1312 // apply a different framegroup animation to bones with a specified parent
1313 void(float animmodelindex, float framegroup, float framegroupstarttime, float blendalpha, string groupbonename, string excludegroupname1, string excludegroupname2) example_skel_player_update_applyoverride =
1314 {
1315         local float bonenum;
1316         local float numbones;
1317         self.frame = framegroup;
1318         self.frame2 = 0;
1319         self.frame3 = 0;
1320         self.frame4 = 0;
1321         self.frame1time = framegroupstarttime;
1322         self.frame2time = 0;
1323         self.frame3time = 0;
1324         self.frame4time = 0;
1325         self.lerpfrac = 0;
1326         self.lerpfrac3 = 0;
1327         self.lerpfrac4 = 0;
1328         bonenum = 0;
1329         numbones = skel_get_numbones(self.skeletonindex);
1330         while (bonenum < numbones)
1331         {
1332                 if (example_skel_findbonegroup(self.skeletonindex, bonenum, groupbonename, excludegroupname1, excludegroupname2, "", "", "") == 1)
1333                         skel_build(self.skeletonindex, self, animmodelindex, 1 - blendalpha, bonenum, bonenum + 1);
1334                 bonenum = bonenum + 1;
1335         }
1336 };
1337 // make eyes point at a target location, be sure v_forward, v_right, v_up are set correctly before calling
1338 void(vector eyetarget, string bonename) example_skel_player_update_eyetarget =
1339 {
1340         local float bonenum;
1341         local vector ang;
1342         local vector oldforward, oldright, oldup;
1343         local vector relforward, relright, relup, relorg;
1344         local vector boneforward, boneright, boneup, boneorg;
1345         local vector parentforward, parentright, parentup, parentorg;
1346         local vector u, v;
1347         local vector modeleyetarget;
1348         bonenum = skel_find_bone(self.skeletonindex, bonename) - 1;
1349         if (bonenum < 0)
1350                 return;
1351         oldforward = v_forward;
1352         oldright = v_right;
1353         oldup = v_up;
1354         v = eyetarget - self.origin;
1355         modeleyetarget_x =   v * v_forward;
1356         modeleyetarget_y = 0-v * v_right;
1357         modeleyetarget_z =   v * v_up;
1358         // this is an eyeball, make it point at the target location
1359         // first get all the data we can...
1360         relorg = skel_get_bonerel(self.skeletonindex, bonenum);
1361         relforward = v_forward;
1362         relright = v_right;
1363         relup = v_up;
1364         boneorg = skel_get_boneabs(self.skeletonindex, bonenum);
1365         boneforward = v_forward;
1366         boneright = v_right;
1367         boneup = v_up;
1368         parentorg = skel_get_boneabs(self.skeletonindex, skel_get_boneparent(self.skeletonindex, bonenum));
1369         parentforward = v_forward;
1370         parentright = v_right;
1371         parentup = v_up;
1372         // get the vector from the eyeball to the target
1373         u = modeleyetarget - boneorg;
1374         // now transform it inversely by the parent matrix to produce new rel vectors
1375         v_x = u * parentforward;
1376         v_y = u * parentright;
1377         v_z = u * parentup;
1378         ang = vectoangles2(v, relup);
1379         ang_x = 0 - ang_x;
1380         makevectors(ang);
1381         // set the relative bone matrix
1382         skel_set_bone(self.skeletonindex, bonenum, relorg);
1383         // restore caller's v_ vectors
1384         v_forward = oldforward;
1385         v_right = oldright;
1386         v_up = oldup;
1387 };
1388 // delete skeleton when we're done with it
1389 // note: skeleton remains valid until next frame when it is really deleted
1390 void() example_skel_player_delete =
1391 {
1392         skel_delete(self.skeletonindex);
1393         self.skeletonindex = 0;
1394 };
1395 //
1396 // END OF EXAMPLES FOR FTE_CSQC_SKELETONOBJECTS
1397 //
1398
1399 //DP_QC_ENTITYDATA
1400 //idea: KrimZon
1401 //darkplaces implementation: KrimZon
1402 //builtin definitions:
1403 float() numentityfields = #496;
1404 string(float fieldnum) entityfieldname = #497;
1405 float(float fieldnum) entityfieldtype = #498;
1406 string(float fieldnum, entity ent) getentityfieldstring = #499;
1407 float(float fieldnum, entity ent, string s) putentityfieldstring = #500;
1408 //constants:
1409 //Returned by entityfieldtype
1410 float FIELD_STRING   = 1;
1411 float FIELD_FLOAT    = 2;
1412 float FIELD_VECTOR   = 3;
1413 float FIELD_ENTITY   = 4;
1414 float FIELD_FUNCTION = 6;
1415 //description:
1416 //Versatile functions intended for storing data from specific entities between level changes, but can be customized for some kind of partial savegame.
1417 //WARNING: .entity fields cannot be saved and restored between map loads as they will leave dangling pointers.
1418 //numentityfields returns the number of entity fields. NOT offsets. Vectors comprise 4 fields: v, v_x, v_y and v_z.
1419 //entityfieldname returns the name as a string, eg. "origin" or "classname" or whatever.
1420 //entityfieldtype returns a value that the constants represent, but the field may be of another type in more exotic progs.dat formats or compilers.
1421 //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.
1422 //putentityfieldstring puts the data returned by getentityfieldstring back into the entity.
1423
1424 //DP_QC_ENTITYSTRING
1425 void(string s) loadfromdata = #529;
1426 void(string s) loadfromfile = #530;
1427 void(string s) callfunction = #605;
1428 void(float fh, entity e) writetofile = #606;
1429 float(string s) isfunction = #607;
1430 void(entity e, string s) parseentitydata = #608;
1431
1432 // assorted builtins
1433 const float             STAT_MOVEVARS_TICRATE           = 240;
1434 const float             STAT_MOVEVARS_TIMESCALE         = 241;
1435 const float             STAT_FRAGLIMIT                                  = 235;
1436 const float             STAT_TIMELIMIT                                  = 236;
1437 const float     STAT_MOVEVARS_GRAVITY           = 242;
1438 string(void)                                            ReadPicture = #501;
1439 float PARTICLES_USEALPHA = 1;
1440 float particles_alphamin, particles_alphamax;
1441 float PARTICLES_USECOLOR = 2;
1442 vector particles_colormin, particles_colormax;
1443 float PARTICLES_USEFADE = 4;  // fades the COUNT (fade alpha using alphamin/alphamax)
1444 float particles_fade;
1445 float PARTICLES_DRAWASTRAIL = 128;
1446 void(float effectindex, entity own, vector org_from, vector org_to, vector dir_from, vector dir_to, float countmultiplier, float flags) boxparticles = #502;
1447 float trace_networkentity;
1448 const float RF_FULLBRIGHT       = 256;
1449 const float RF_NOSHADOW = 512;
1450 float RF_DYNAMICMODELLIGHT = 8192;
1451
1452 float gettaginfo_parent;
1453 string gettaginfo_name;
1454 vector gettaginfo_offset;
1455 vector gettaginfo_forward;
1456 vector gettaginfo_right;
1457 vector gettaginfo_up;
1458 float checkpvs(vector viewpos, entity viewee) = #240;