3 #include "clprogdefs.h"
6 //============================================================================
7 // Client prog handling
8 //[515]: omg !!! optimize it ! a lot of hacks here and there also :P
10 #define CSQC_RETURNVAL prog->globals.generic[OFS_RETURN]
11 #define CSQC_BEGIN csqc_tmpprog=prog;prog=0;PRVM_SetProg(PRVM_CLIENTPROG);
12 #define CSQC_END prog=csqc_tmpprog;
13 static prvm_prog_t *csqc_tmpprog;
15 //[515]: these are required funcs
16 #define CL_F_INIT "CSQC_Init"
17 #define CL_F_INPUTEVENT "CSQC_InputEvent"
18 #define CL_F_UPDATEVIEW "CSQC_UpdateView"
19 #define CL_F_CONSOLECOMMAND "CSQC_ConsoleCommand"
20 #define CL_F_SHUTDOWN "CSQC_Shutdown"
22 //[515]: these are optional
23 #define CL_F_PARSE_TEMPENTITY "CSQC_Parse_TempEntity" //[515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
24 #define CL_F_PARSE_STUFFCMD "CSQC_Parse_StuffCmd"
25 #define CL_F_PARSE_PRINT "CSQC_Parse_Print"
26 #define CL_F_PARSE_CENTERPRINT "CSQC_Parse_CenterPrint"
27 #define CL_F_ENT_UPDATE "CSQC_Ent_Update"
28 #define CL_F_ENT_REMOVE "CSQC_Ent_Remove"
29 #define CL_F_EVENT "CSQC_Event" //[515]: engine call this for its own needs
30 //so csqc can do some things according to what engine it's running on
31 //example: to say about edicts increase, whatever...
33 #define CSQC_PRINTBUFFERLEN 8192 //[515]: enough ?
35 static char *cl_required_func[] =
44 static int cl_numrequiredfunc = sizeof(cl_required_func) / sizeof(char*);
46 static char *csqc_printtextbuf = NULL;
47 static unsigned short *csqc_sv2csqcents; //[515]: server entities numbers on client side. FIXME : make pointers instead of numbers ?
49 static mfunction_t *CSQC_Parse_TempEntity;
50 static mfunction_t *CSQC_Parse_StuffCmd;
51 static mfunction_t *CSQC_Parse_Print;
52 static mfunction_t *CSQC_Parse_CenterPrint;
53 static mfunction_t *CSQC_Ent_Update;
54 static mfunction_t *CSQC_Ent_Remove;
55 static mfunction_t *CSQC_Event;
57 static int csqc_fieldoff_alpha;
58 static int csqc_fieldoff_colormod;
59 static int csqc_fieldoff_effects;
60 int csqc_fieldoff_scale;
61 int csqc_fieldoff_renderflags;
62 int csqc_fieldoff_tag_entity;
63 int csqc_fieldoff_tag_index;
64 int csqc_fieldoff_dphitcontentsmask;
66 qboolean csqc_loaded = false;
68 vec3_t csqc_origin, csqc_angles;
69 static double csqc_frametime = 0;
71 static mempool_t *csqc_mempool;
73 static void CL_VM_FindEdictFieldOffsets (void)
75 csqc_fieldoff_alpha = PRVM_ED_FindFieldOffset("alpha");
76 csqc_fieldoff_scale = PRVM_ED_FindFieldOffset("scale");
77 csqc_fieldoff_colormod = PRVM_ED_FindFieldOffset("colormod");
78 csqc_fieldoff_renderflags = PRVM_ED_FindFieldOffset("renderflags");
79 csqc_fieldoff_effects = PRVM_ED_FindFieldOffset("effects");
80 csqc_fieldoff_tag_entity = PRVM_ED_FindFieldOffset("tag_entity");
81 csqc_fieldoff_tag_index = PRVM_ED_FindFieldOffset("tag_index");
83 CSQC_Parse_TempEntity = PRVM_ED_FindFunction (CL_F_PARSE_TEMPENTITY);
84 CSQC_Parse_StuffCmd = PRVM_ED_FindFunction (CL_F_PARSE_STUFFCMD);
85 CSQC_Parse_Print = PRVM_ED_FindFunction (CL_F_PARSE_PRINT);
86 CSQC_Parse_CenterPrint = PRVM_ED_FindFunction (CL_F_PARSE_CENTERPRINT);
87 CSQC_Ent_Update = PRVM_ED_FindFunction (CL_F_ENT_UPDATE);
88 CSQC_Ent_Remove = PRVM_ED_FindFunction (CL_F_ENT_REMOVE);
89 CSQC_Event = PRVM_ED_FindFunction (CL_F_EVENT);
93 csqc_printtextbuf = (char *)Mem_Alloc(csqc_mempool, CSQC_PRINTBUFFERLEN);
94 csqc_printtextbuf[0] = 0;
98 void CL_VM_Error (const char *format, ...) DP_FUNC_PRINTF(1);
99 void CL_VM_Error (const char *format, ...) //[515]: hope it will be never executed =)
101 char errorstring[4096];
104 va_start (argptr, format);
105 dpvsnprintf (errorstring, sizeof(errorstring), format, argptr);
107 // Con_Printf( "CL_VM_Error: %s\n", errorstring );
111 Mem_FreePool(&csqc_mempool);
113 Cvar_SetValueQuick(&csqc_progcrc, -1);
114 Cvar_SetValueQuick(&csqc_progsize, -1);
116 // Host_AbortCurrentFrame(); //[515]: hmmm... if server says it needs csqc then client MUST disconnect
117 Host_Error(va("CL_VM_Error: %s", errorstring));
120 model_t *CSQC_GetModelByIndex(int modelindex)
126 modelindex = -(modelindex+1);
127 if (modelindex < MAX_MODELS)
128 return cl.csqc_model_precache[modelindex];
132 if(modelindex < MAX_MODELS)
133 return cl.model_precache[modelindex];
138 model_t *CSQC_GetModelFromEntity(prvm_edict_t *ed)
140 if (!ed || ed->priv.server->free)
142 return CSQC_GetModelByIndex((int)ed->fields.client->modelindex);
145 //[515]: set globals before calling R_UpdateView, WEIRD CRAP
146 static void CSQC_SetGlobals (void)
148 //extern cvar_t sv_accelerate, sv_friction, sv_gravity, sv_stopspeed, sv_maxspeed;
151 *prog->time = cl.time;
152 prog->globals.client->frametime = cl.time - csqc_frametime;
153 csqc_frametime = cl.time;
154 prog->globals.client->servercommandframe = cl.servermovesequence;
155 prog->globals.client->clientcommandframe = cl.movesequence;
156 VectorCopy(cl.viewangles, prog->globals.client->input_angles);
157 VectorCopy(cl.viewangles, csqc_angles);
158 prog->globals.client->input_buttons = cl.cmd.buttons;
159 VectorSet(prog->globals.client->input_movevalues, cl.cmd.forwardmove, cl.cmd.sidemove, cl.cmd.upmove);
160 //VectorCopy(cl.movement_origin, csqc_origin);
161 Matrix4x4_OriginFromMatrix(&cl.entities[cl.viewentity].render.matrix, csqc_origin);
162 VectorCopy(csqc_origin, prog->globals.client->pmove_org);
163 prog->globals.client->maxclients = cl.maxclients;
164 //VectorCopy(cl.movement_velocity, prog->globals.client->pmove_vel);
165 VectorCopy(cl.velocity, prog->globals.client->pmove_vel);
169 void CSQC_Predraw (prvm_edict_t *ed)
172 if(!ed->fields.client->predraw)
174 b = prog->globals.client->self;
175 prog->globals.client->self = PRVM_EDICT_TO_PROG(ed);
176 PRVM_ExecuteProgram(ed->fields.client->predraw, "CSQC_Predraw: NULL function\n");
177 prog->globals.client->self = b;
180 void CSQC_Think (prvm_edict_t *ed)
183 if(ed->fields.client->think)
184 if(ed->fields.client->nextthink && ed->fields.client->nextthink <= *prog->time)
186 ed->fields.client->nextthink = 0;
187 b = prog->globals.client->self;
188 prog->globals.client->self = PRVM_EDICT_TO_PROG(ed);
189 PRVM_ExecuteProgram(ed->fields.client->think, "CSQC_Think: NULL function\n");
190 prog->globals.client->self = b;
194 extern cvar_t cl_noplayershadow;
195 qboolean CSQC_AddRenderEdict(prvm_edict_t *ed)
202 matrix4x4_t tagmatrix, matrix2;
204 model = CSQC_GetModelFromEntity(ed);
208 e = CL_NewTempEntity();
212 e->render.model = model;
213 e->render.colormap = (int)ed->fields.client->colormap;
214 e->render.frame = (int)ed->fields.client->frame;
215 e->render.skinnum = (int)ed->fields.client->skin;
216 e->render.effects |= e->render.model->flags2 & (EF_FULLBRIGHT | EF_ADDITIVE);
218 // FIXME: renderflags should be in the cl_entvars_t
221 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_renderflags)) && val->_float) renderflags = (int)val->_float;
223 renderflags = (int)ed->fields.client->renderflags;
226 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_alpha)) && val->_float) e->render.alpha = val->_float;
227 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_scale)) && val->_float) e->render.scale = scale = val->_float;
228 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_colormod)) && VectorLength2(val->vector)) VectorCopy(val->vector, e->render.colormod);
229 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_effects)) && val->_float) e->render.effects = (int)val->_float;
230 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_tag_entity)) && val->edict)
234 tagentity = val->edict;
235 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_tag_index)) && val->_float)
236 tagindex = (int)val->_float;
237 // FIXME: calculate tag matrix
238 Matrix4x4_CreateIdentity(&tagmatrix);
241 Matrix4x4_CreateIdentity(&tagmatrix);
243 if (renderflags & RF_USEAXIS)
246 VectorNegate(prog->globals.client->v_right, left);
247 Matrix4x4_FromVectors(&matrix2, prog->globals.client->v_forward, left, prog->globals.client->v_up, ed->fields.client->origin);
252 VectorCopy(ed->fields.client->angles, angles);
253 // if model is alias, reverse pitch direction
254 if (e->render.model->type == mod_alias)
255 angles[0] = -angles[0];
257 // set up the render matrix
258 Matrix4x4_CreateFromQuakeEntity(&matrix2, ed->fields.client->origin[0], ed->fields.client->origin[1], ed->fields.client->origin[2], angles[0], angles[1], angles[2], scale);
261 // FIXME: csqc has frame1/frame2/frame1time/frame2time/lerpfrac but this implementation's cl_entvars_t lacks those fields
262 e->render.frame1 = e->render.frame = ed->fields.client->frame;
263 e->render.frame1time = e->render.frame2time = 0;
264 e->render.framelerp = 0;
266 // concat the matrices to make the entity relative to its tag
267 Matrix4x4_Concat(&e->render.matrix, &tagmatrix, &matrix2);
268 // make the other useful stuff
269 CL_UpdateRenderEntity(&e->render);
272 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_renderflags)) && val->_float)
274 i = (int)val->_float;
275 if(i & RF_VIEWMODEL) e->render.flags |= RENDER_VIEWMODEL;
276 if(i & RF_EXTERNALMODEL)e->render.flags |= RENDER_EXTERIORMODEL;
277 if(i & RF_DEPTHHACK) e->render.effects |= EF_NODEPTHTEST;
278 if(i & RF_ADDITIVE) e->render.effects |= EF_ADDITIVE;
281 // transparent stuff can't be lit during the opaque stage
282 if (e->render.effects & (EF_ADDITIVE | EF_NODEPTHTEST) || e->render.alpha < 1)
283 e->render.flags |= RENDER_TRANSPARENT;
284 // double sided rendering mode causes backfaces to be visible
285 // (mostly useful on transparent stuff)
286 if (e->render.effects & EF_DOUBLESIDED)
287 e->render.flags |= RENDER_NOCULLFACE;
288 // either fullbright or lit
289 if (!(e->render.effects & EF_FULLBRIGHT) && !r_fullbright.integer)
290 e->render.flags |= RENDER_LIGHT;
291 // hide player shadow during intermission or nehahra movie
292 if (!(e->render.effects & EF_NOSHADOW)
293 && !(e->render.flags & (RENDER_VIEWMODEL | RENDER_TRANSPARENT))
294 && (!(e->render.flags & RENDER_EXTERIORMODEL) || (!cl.intermission && cls.protocol != PROTOCOL_NEHAHRAMOVIE && !cl_noplayershadow.integer)))
295 e->render.flags |= RENDER_SHADOW;
300 qboolean CL_VM_InputEvent (qboolean pressed, int key)
306 *prog->time = cl.time;
307 PRVM_G_FLOAT(OFS_PARM0) = pressed;
308 PRVM_G_FLOAT(OFS_PARM1) = key;
309 PRVM_ExecuteProgram (prog->globals.client->CSQC_InputEvent, CL_F_INPUTEVENT);
315 qboolean CL_VM_UpdateView (void)
321 //VectorCopy(cl.viewangles, oldangles);
322 *prog->time = cl.time;
324 // clear renderable entity and light lists to prevent crashes if the
325 // CSQC_UpdateView function does not call R_ClearScene as it should
326 r_refdef.numentities = 0;
327 r_refdef.numlights = 0;
328 PRVM_ExecuteProgram (prog->globals.client->CSQC_UpdateView, CL_F_UPDATEVIEW);
329 //VectorCopy(oldangles, cl.viewangles);
334 extern sizebuf_t vm_tempstringsbuf;
335 qboolean CL_VM_ConsoleCommand (const char *cmd)
337 int restorevm_tempstringsbuf_cursize;
342 *prog->time = cl.time;
343 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
344 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(cmd);
345 PRVM_ExecuteProgram (prog->globals.client->CSQC_ConsoleCommand, CL_F_CONSOLECOMMAND);
346 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
352 qboolean CL_VM_Parse_TempEntity (void)
356 if(!csqc_loaded || !CSQC_Parse_TempEntity)
360 *prog->time = cl.time;
361 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_TempEntity - prog->functions), CL_F_PARSE_TEMPENTITY);
372 void CL_VM_Parse_StuffCmd (const char *msg)
374 int restorevm_tempstringsbuf_cursize;
380 // if this is setting a csqc variable, deprotect csqc_progcrc
381 // temporarily so that it can be set by the cvar command,
382 // and then reprotect it afterwards
383 int crcflags = csqc_progcrc.flags;
384 int sizeflags = csqc_progcrc.flags;
385 csqc_progcrc.flags &= ~CVAR_READONLY;
386 csqc_progsize.flags &= ~CVAR_READONLY;
387 Cmd_ExecuteString (msg, src_command);
388 csqc_progcrc.flags = crcflags;
389 csqc_progsize.flags = sizeflags;
392 if(!csqc_loaded || !CSQC_Parse_StuffCmd)
398 *prog->time = cl.time;
399 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
400 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(msg);
401 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_StuffCmd - prog->functions), CL_F_PARSE_STUFFCMD);
402 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
406 static void CL_VM_Parse_Print (const char *msg)
408 int restorevm_tempstringsbuf_cursize;
410 *prog->time = cl.time;
411 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
412 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(msg);
413 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_Print - prog->functions), CL_F_PARSE_PRINT);
414 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
418 void CSQC_AddPrintText (const char *msg)
421 if(!csqc_loaded || !CSQC_Parse_Print)
426 // FIXME: is this bugged?
428 if(msg[i] != '\n' && msg[i] != '\r')
430 if(strlen(csqc_printtextbuf)+i >= CSQC_PRINTBUFFERLEN)
432 CL_VM_Parse_Print(csqc_printtextbuf);
433 csqc_printtextbuf[0] = 0;
436 strlcat(csqc_printtextbuf, msg, CSQC_PRINTBUFFERLEN);
439 strlcat(csqc_printtextbuf, msg, CSQC_PRINTBUFFERLEN);
440 CL_VM_Parse_Print(csqc_printtextbuf);
441 csqc_printtextbuf[0] = 0;
444 void CL_VM_Parse_CenterPrint (const char *msg)
446 int restorevm_tempstringsbuf_cursize;
447 if(!csqc_loaded || !CSQC_Parse_CenterPrint)
449 SCR_CenterPrint((char*)msg);
453 *prog->time = cl.time;
454 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
455 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(msg);
456 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_CenterPrint - prog->functions), CL_F_PARSE_CENTERPRINT);
457 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
461 float CL_VM_Event (float event) //[515]: needed ? I'd say "YES", but don't know for what :D
464 if(!csqc_loaded || !CSQC_Event)
467 *prog->time = cl.time;
468 PRVM_G_FLOAT(OFS_PARM0) = event;
469 PRVM_ExecuteProgram ((func_t)(CSQC_Event - prog->functions), CL_F_EVENT);
475 void CSQC_ReadEntities (void)
477 unsigned short entnum, oldself, realentnum;
479 *prog->time = cl.time;
480 oldself = prog->globals.client->self;
483 entnum = MSG_ReadShort();
486 realentnum = entnum & 0x7FFF;
487 prog->globals.client->self = csqc_sv2csqcents[realentnum];
490 if(prog->globals.client->self)
492 PRVM_ExecuteProgram((func_t)(CSQC_Ent_Remove - prog->functions), CL_F_ENT_REMOVE);
493 csqc_sv2csqcents[realentnum] = 0;
496 Con_Printf("Smth bad happens in csqc...\n"); //[515]: never happens ?
500 if(!prog->globals.client->self)
503 ed = PRVM_ED_Alloc();
504 ed->fields.client->entnum = realentnum;
505 prog->globals.client->self = csqc_sv2csqcents[realentnum] = PRVM_EDICT_TO_PROG(ed);
506 PRVM_G_FLOAT(OFS_PARM0) = 1;
509 PRVM_G_FLOAT(OFS_PARM0) = 0;
510 PRVM_ExecuteProgram((func_t)(CSQC_Ent_Update - prog->functions), CL_F_ENT_UPDATE);
513 prog->globals.client->self = oldself;
517 void Cmd_ClearCsqcFuncs (void);
519 void CL_VM_Init (void)
521 unsigned char *csprogsdata;
522 fs_offset_t csprogsdatasize;
523 int csprogsdatacrc, requiredcrc;
526 // reset csqc_progcrc after reading it, so that changing servers doesn't
527 // expect csqc on the next server
528 requiredcrc = csqc_progcrc.integer;
529 requiredsize = csqc_progsize.integer;
530 Cvar_SetValueQuick(&csqc_progcrc, -1);
531 Cvar_SetValueQuick(&csqc_progsize, -1);
534 memset(cl.csqc_model_precache, 0, sizeof(cl.csqc_model_precache));
535 memset(&cl.csqc_vidvars, true, sizeof(csqc_vidvars_t));
537 // if the server is not requesting a csprogs, then we're done here
541 // see if the requested csprogs.dat file matches the requested crc
543 csprogsdata = FS_LoadFile(va("dlcache/%s.%i.%i", csqc_progname.string, requiredsize, requiredcrc), tempmempool, true, &csprogsdatasize);
545 csprogsdata = FS_LoadFile(csqc_progname.string, tempmempool, true, &csprogsdatasize);
548 csprogsdatacrc = CRC_Block(csprogsdata, csprogsdatasize);
549 Mem_Free(csprogsdata);
550 if (csprogsdatacrc != requiredcrc || csprogsdatasize != requiredsize)
552 if (cls.demoplayback)
554 Con_Printf("^1Warning: Your %s is not the same version as the demo was recorded with (CRC/size are %i/%i but should be %i/%i)\n", csqc_progname.string, csprogsdatacrc, (int)csprogsdatasize, requiredcrc, requiredsize);
559 Con_Printf("^1Your %s is not the same version as the server (CRC is %i/%i but should be %i/%i)\n", csqc_progname.string, csprogsdatacrc, (int)csprogsdatasize, requiredcrc, requiredsize);
567 if (requiredcrc >= 0)
569 if (cls.demoplayback)
570 Con_Printf("CL_VM_Init: demo requires CSQC, but \"%s\" wasn't found\n", csqc_progname.string);
572 Con_Printf("CL_VM_Init: server requires CSQC, but \"%s\" wasn't found\n", csqc_progname.string);
579 PRVM_InitProg(PRVM_CLIENTPROG);
581 csqc_mempool = Mem_AllocPool("CSQC", 0, NULL);
583 // allocate the mempools
584 prog->progs_mempool = Mem_AllocPool(csqc_progname.string, 0, NULL);
585 prog->headercrc = CL_PROGHEADER_CRC;
586 prog->edictprivate_size = 0; // no private struct used
587 prog->name = CL_NAME;
588 prog->num_edicts = 1;
589 prog->limit_edicts = CL_MAX_EDICTS;
590 prog->extensionstring = vm_cl_extensions;
591 prog->builtins = vm_cl_builtins;
592 prog->numbuiltins = vm_cl_numbuiltins;
593 prog->init_cmd = VM_CL_Cmd_Init;
594 prog->reset_cmd = VM_CL_Cmd_Reset;
595 prog->error_cmd = CL_VM_Error;
597 PRVM_LoadProgs(csqc_progname.string, cl_numrequiredfunc, cl_required_func, 0, NULL);
600 Con_Printf("CSQC ^5loaded (crc=%i, size=%i)\n", csprogsdatacrc, (int)csprogsdatasize);
603 CL_VM_Error("CSQC ^2failed to load\n");
609 //[515]: optional fields & funcs
610 CL_VM_FindEdictFieldOffsets();
613 *prog->time = cl.time;
616 prog->globals.client->mapname = PRVM_SetEngineString(cl.worldmodel->name);
617 prog->globals.client->player_localentnum = cl.playerentity;
619 // call the prog init
620 PRVM_ExecuteProgram((func_t) (PRVM_ED_FindFunction(CL_F_INIT) - prog->functions), CL_F_INIT);
625 csqc_sv2csqcents = (unsigned short *)Mem_Alloc(csqc_mempool, MAX_EDICTS*sizeof(unsigned short));
626 memset(csqc_sv2csqcents, 0, MAX_EDICTS*sizeof(unsigned short));
628 cl.csqc_vidvars.drawcrosshair = false;
629 cl.csqc_vidvars.drawenginesbar = false;
632 void CL_VM_ShutDown (void)
634 Cmd_ClearCsqcFuncs();
635 Cvar_SetValueQuick(&csqc_progcrc, -1);
636 Cvar_SetValueQuick(&csqc_progsize, -1);
640 *prog->time = cl.time;
641 PRVM_ExecuteProgram((func_t) (PRVM_ED_FindFunction(CL_F_SHUTDOWN) - prog->functions), CL_F_SHUTDOWN);
644 Con_Print("CSQC ^1unloaded\n");
646 Mem_FreePool(&csqc_mempool);