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 allready 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;
72 static mempool_t *csqc_mempool;
74 static void CL_VM_FindEdictFieldOffsets (void)
76 csqc_fieldoff_alpha = PRVM_ED_FindFieldOffset("alpha");
77 csqc_fieldoff_scale = PRVM_ED_FindFieldOffset("scale");
78 csqc_fieldoff_colormod = PRVM_ED_FindFieldOffset("colormod");
79 csqc_fieldoff_renderflags = PRVM_ED_FindFieldOffset("renderflags");
80 csqc_fieldoff_effects = PRVM_ED_FindFieldOffset("effects");
81 csqc_fieldoff_tag_entity = PRVM_ED_FindFieldOffset("tag_entity");
82 csqc_fieldoff_tag_index = PRVM_ED_FindFieldOffset("tag_index");
84 CSQC_Parse_TempEntity = PRVM_ED_FindFunction (CL_F_PARSE_TEMPENTITY);
85 CSQC_Parse_StuffCmd = PRVM_ED_FindFunction (CL_F_PARSE_STUFFCMD);
86 CSQC_Parse_Print = PRVM_ED_FindFunction (CL_F_PARSE_PRINT);
87 CSQC_Parse_CenterPrint = PRVM_ED_FindFunction (CL_F_PARSE_CENTERPRINT);
88 CSQC_Ent_Update = PRVM_ED_FindFunction (CL_F_ENT_UPDATE);
89 CSQC_Ent_Remove = PRVM_ED_FindFunction (CL_F_ENT_REMOVE);
90 CSQC_Event = PRVM_ED_FindFunction (CL_F_EVENT);
94 csqc_printtextbuf = (char *)Mem_Alloc(csqc_mempool, CSQC_PRINTBUFFERLEN);
95 csqc_printtextbuf[0] = 0;
99 void CL_VM_Error (const char *format, ...) DP_FUNC_PRINTF(1);
100 void CL_VM_Error (const char *format, ...) //[515]: hope it will be never executed =)
102 char errorstring[4096];
105 va_start (argptr, format);
106 dpvsnprintf (errorstring, sizeof(errorstring), format, argptr);
108 // Con_Printf( "CL_VM_Error: %s\n", errorstring );
112 Mem_FreePool(&csqc_mempool);
114 Cvar_SetValueQuick(&csqc_progcrc, -1);
115 Cvar_SetValueQuick(&csqc_progsize, -1);
117 // Host_AbortCurrentFrame(); //[515]: hmmm... if server says it needs csqc then client MUST disconnect
118 Host_Error(va("CL_VM_Error: %s", errorstring));
121 model_t *CSQC_GetModelByIndex(int modelindex)
127 modelindex = -(modelindex+1);
128 if (modelindex < MAX_MODELS)
129 return cl.csqc_model_precache[modelindex];
133 if(modelindex < MAX_MODELS)
134 return cl.model_precache[modelindex];
139 model_t *CSQC_GetModelFromEntity(prvm_edict_t *ed)
141 if (!ed || ed->priv.server->free)
143 return CSQC_GetModelByIndex((int)ed->fields.client->modelindex);
146 //[515]: set globals before calling R_UpdateView, WEIRD CRAP
147 static void CSQC_SetGlobals (void)
149 //extern cvar_t sv_accelerate, sv_friction, sv_gravity, sv_stopspeed, sv_maxspeed;
152 *prog->time = cl.time;
153 prog->globals.client->frametime = cl.time - csqc_frametime;
154 csqc_frametime = cl.time;
155 prog->globals.client->servercommandframe = cl.servermovesequence;
156 prog->globals.client->clientcommandframe = cl.movemessages;
157 VectorCopy(cl.viewangles, prog->globals.client->input_angles);
158 VectorCopy(cl.viewangles, csqc_angles);
159 prog->globals.client->input_buttons = csqc_buttons;
160 VectorSet(prog->globals.client->input_movevalues, cl.cmd.forwardmove, cl.cmd.sidemove, cl.cmd.upmove);
161 //VectorCopy(cl.movement_origin, csqc_origin);
162 Matrix4x4_OriginFromMatrix(&cl.entities[cl.viewentity].render.matrix, csqc_origin);
163 VectorCopy(csqc_origin, prog->globals.client->pmove_org);
164 prog->globals.client->maxclients = cl.maxclients;
165 //VectorCopy(cl.movement_velocity, prog->globals.client->pmove_vel);
166 VectorCopy(cl.velocity, prog->globals.client->pmove_vel);
170 void CSQC_Predraw (prvm_edict_t *ed)
173 if(!ed->fields.client->predraw)
175 b = prog->globals.client->self;
176 prog->globals.client->self = PRVM_EDICT_TO_PROG(ed);
177 PRVM_ExecuteProgram(ed->fields.client->predraw, "CSQC_Predraw: NULL function\n");
178 prog->globals.client->self = b;
181 void CSQC_Think (prvm_edict_t *ed)
184 if(ed->fields.client->think)
185 if(ed->fields.client->nextthink && ed->fields.client->nextthink <= *prog->time)
187 ed->fields.client->nextthink = 0;
188 b = prog->globals.client->self;
189 prog->globals.client->self = PRVM_EDICT_TO_PROG(ed);
190 PRVM_ExecuteProgram(ed->fields.client->think, "CSQC_Think: NULL function\n");
191 prog->globals.client->self = b;
195 extern cvar_t cl_noplayershadow;
196 qboolean CSQC_AddRenderEdict(prvm_edict_t *ed)
203 matrix4x4_t tagmatrix, matrix2;
205 model = CSQC_GetModelFromEntity(ed);
209 e = CL_NewTempEntity();
213 e->render.model = model;
214 e->render.colormap = (int)ed->fields.client->colormap;
215 e->render.frame = (int)ed->fields.client->frame;
216 e->render.skinnum = (int)ed->fields.client->skin;
217 e->render.effects |= e->render.model->flags2 & (EF_FULLBRIGHT | EF_ADDITIVE);
220 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_alpha)) && val->_float) e->render.alpha = val->_float;
221 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_scale)) && val->_float) e->render.scale = scale = val->_float;
222 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_colormod)) && VectorLength2(val->vector)) VectorCopy(val->vector, e->render.colormod);
223 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_effects)) && val->_float) e->render.effects = (int)val->_float;
224 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_tag_entity)) && val->edict)
228 tagentity = val->edict;
229 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_tag_index)) && val->_float)
230 tagindex = (int)val->_float;
231 // FIXME: calculate tag matrix
232 Matrix4x4_CreateIdentity(&tagmatrix);
235 Matrix4x4_CreateIdentity(&tagmatrix);
237 if(i & RF_USEAXIS) //FIXME!!!
240 VectorNegate(prog->globals.client->v_right, left);
241 Matrix4x4_FromVectors(&matrix2, prog->globals.client->v_forward, left, prog->globals.client->v_up, ed->fields.client->origin);
246 VectorCopy(ed->fields.client->angles, angles);
247 // if model is alias, reverse pitch direction
248 if (e->render.model->type == mod_alias)
249 angles[0] = -angles[0];
251 // set up the render matrix
252 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);
255 // FIXME: csqc has frame1/frame2/frame1time/frame2time/lerpfrac but this implementation's cl_entvars_t lacks those fields
256 e->render.frame1 = e->render.frame = ed->fields.client->frame;
257 e->render.frame1time = e->render.frame2time = 0;
258 e->render.framelerp = 0;
260 // concat the matrices to make the entity relative to its tag
261 Matrix4x4_Concat(&e->render.matrix, &tagmatrix, &matrix2);
262 // make the other useful stuff
263 CL_UpdateRenderEntity(&e->render);
266 if((val = PRVM_GETEDICTFIELDVALUE(ed, csqc_fieldoff_renderflags)) && val->_float)
268 i = (int)val->_float;
269 if(i & RF_VIEWMODEL) e->render.flags |= RENDER_VIEWMODEL;
270 if(i & RF_EXTERNALMODEL)e->render.flags |= RENDER_EXTERIORMODEL;
271 if(i & RF_DEPTHHACK) e->render.effects |= EF_NODEPTHTEST;
272 if(i & RF_ADDITIVE) e->render.effects |= EF_ADDITIVE;
275 // transparent stuff can't be lit during the opaque stage
276 if (e->render.effects & (EF_ADDITIVE | EF_NODEPTHTEST) || e->render.alpha < 1)
277 e->render.flags |= RENDER_TRANSPARENT;
278 // double sided rendering mode causes backfaces to be visible
279 // (mostly useful on transparent stuff)
280 if (e->render.effects & EF_DOUBLESIDED)
281 e->render.flags |= RENDER_NOCULLFACE;
282 // either fullbright or lit
283 if (!(e->render.effects & EF_FULLBRIGHT) && !r_fullbright.integer)
284 e->render.flags |= RENDER_LIGHT;
285 // hide player shadow during intermission or nehahra movie
286 if (!(e->render.effects & EF_NOSHADOW)
287 && !(e->render.flags & (RENDER_VIEWMODEL | RENDER_TRANSPARENT))
288 && (!(e->render.flags & RENDER_EXTERIORMODEL) || (!cl.intermission && cls.protocol != PROTOCOL_NEHAHRAMOVIE && !cl_noplayershadow.integer)))
289 e->render.flags |= RENDER_SHADOW;
294 qboolean CL_VM_InputEvent (qboolean pressed, int key)
300 *prog->time = cl.time;
301 PRVM_G_FLOAT(OFS_PARM0) = pressed;
302 PRVM_G_FLOAT(OFS_PARM1) = key;
303 PRVM_ExecuteProgram (prog->globals.client->CSQC_InputEvent, CL_F_INPUTEVENT);
309 qboolean CL_VM_UpdateView (void)
315 //VectorCopy(cl.viewangles, oldangles);
316 *prog->time = cl.time;
318 r_refdef.numentities = 0;
319 PRVM_ExecuteProgram (prog->globals.client->CSQC_UpdateView, CL_F_UPDATEVIEW);
320 //VectorCopy(oldangles, cl.viewangles);
325 qboolean CL_VM_ConsoleCommand (const char *cmd)
331 *prog->time = cl.time;
332 PRVM_G_INT(OFS_PARM0) = PRVM_SetEngineString(cmd);
333 PRVM_ExecuteProgram (prog->globals.client->CSQC_ConsoleCommand, CL_F_CONSOLECOMMAND);
339 qboolean CL_VM_Parse_TempEntity (void)
343 if(!csqc_loaded || !CSQC_Parse_TempEntity)
347 *prog->time = cl.time;
348 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_TempEntity - prog->functions), CL_F_PARSE_TEMPENTITY);
359 void CL_VM_Parse_StuffCmd (const char *msg)
366 // if this is setting a csqc variable, deprotect csqc_progcrc
367 // temporarily so that it can be set by the cvar command,
368 // and then reprotect it afterwards
369 int crcflags = csqc_progcrc.flags;
370 int sizeflags = csqc_progcrc.flags;
371 csqc_progcrc.flags &= ~CVAR_READONLY;
372 csqc_progsize.flags &= ~CVAR_READONLY;
373 Cmd_ExecuteString (msg, src_command);
374 csqc_progcrc.flags = crcflags;
375 csqc_progsize.flags = sizeflags;
378 if(!csqc_loaded || !CSQC_Parse_StuffCmd)
384 *prog->time = cl.time;
385 PRVM_G_INT(OFS_PARM0) = PRVM_SetEngineString(msg);
386 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_StuffCmd - prog->functions), CL_F_PARSE_STUFFCMD);
390 static void CL_VM_Parse_Print (const char *msg)
393 *prog->time = cl.time;
394 PRVM_G_INT(OFS_PARM0) = PRVM_SetEngineString(msg);
395 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_Print - prog->functions), CL_F_PARSE_PRINT);
399 void CSQC_AddPrintText (const char *msg)
402 if(!csqc_loaded || !CSQC_Parse_Print)
407 // FIXME: is this bugged?
409 if(msg[i] != '\n' && msg[i] != '\r')
411 if(strlen(csqc_printtextbuf)+i >= CSQC_PRINTBUFFERLEN)
413 CL_VM_Parse_Print(csqc_printtextbuf);
414 csqc_printtextbuf[0] = 0;
417 strlcat(csqc_printtextbuf, msg, CSQC_PRINTBUFFERLEN);
420 strlcat(csqc_printtextbuf, msg, CSQC_PRINTBUFFERLEN);
421 CL_VM_Parse_Print(csqc_printtextbuf);
422 csqc_printtextbuf[0] = 0;
425 void CL_VM_Parse_CenterPrint (const char *msg)
427 if(!csqc_loaded || !CSQC_Parse_CenterPrint)
429 SCR_CenterPrint((char*)msg);
433 *prog->time = cl.time;
434 PRVM_G_INT(OFS_PARM0) = PRVM_SetEngineString(msg);
435 PRVM_ExecuteProgram ((func_t)(CSQC_Parse_CenterPrint - prog->functions), CL_F_PARSE_CENTERPRINT);
439 float CL_VM_Event (float event) //[515]: needed ? I'd say "YES", but don't know for what :D
442 if(!csqc_loaded || !CSQC_Event)
445 *prog->time = cl.time;
446 PRVM_G_FLOAT(OFS_PARM0) = event;
447 PRVM_ExecuteProgram ((func_t)(CSQC_Event - prog->functions), CL_F_EVENT);
453 void CSQC_ReadEntities (void)
455 unsigned short entnum, oldself, realentnum;
457 *prog->time = cl.time;
458 oldself = prog->globals.client->self;
461 entnum = MSG_ReadShort();
464 realentnum = entnum & 0x7FFF;
465 prog->globals.client->self = csqc_sv2csqcents[realentnum];
468 if(prog->globals.client->self)
470 PRVM_ExecuteProgram((func_t)(CSQC_Ent_Remove - prog->functions), CL_F_ENT_REMOVE);
471 csqc_sv2csqcents[realentnum] = 0;
474 Con_Printf("Smth bad happens in csqc...\n"); //[515]: never happens ?
478 if(!prog->globals.client->self)
481 ed = PRVM_ED_Alloc();
482 ed->fields.client->entnum = realentnum;
483 prog->globals.client->self = csqc_sv2csqcents[realentnum] = PRVM_EDICT_TO_PROG(ed);
484 PRVM_G_FLOAT(OFS_PARM0) = 1;
487 PRVM_G_FLOAT(OFS_PARM0) = 0;
488 PRVM_ExecuteProgram((func_t)(CSQC_Ent_Update - prog->functions), CL_F_ENT_UPDATE);
491 prog->globals.client->self = oldself;
495 void Cmd_ClearCsqcFuncs (void);
497 void CL_VM_Init (void)
499 unsigned char *csprogsdata;
500 fs_offset_t csprogsdatasize;
501 int csprogsdatacrc, requiredcrc;
504 // reset csqc_progcrc after reading it, so that changing servers doesn't
505 // expect csqc on the next server
506 requiredcrc = csqc_progcrc.integer;
507 requiredsize = csqc_progsize.integer;
508 Cvar_SetValueQuick(&csqc_progcrc, -1);
509 Cvar_SetValueQuick(&csqc_progsize, -1);
512 memset(cl.csqc_model_precache, 0, sizeof(cl.csqc_model_precache));
513 memset(&cl.csqc_vidvars, true, sizeof(csqc_vidvars_t));
515 // if the server is not requesting a csprogs, then we're done here
519 // see if the requested csprogs.dat file matches the requested crc
521 csprogsdata = FS_LoadFile(va("dlcache/%s.%i.%i", csqc_progname.string, requiredsize, requiredcrc), tempmempool, true, &csprogsdatasize);
523 csprogsdata = FS_LoadFile(csqc_progname.string, tempmempool, true, &csprogsdatasize);
526 csprogsdatacrc = CRC_Block(csprogsdata, csprogsdatasize);
527 Mem_Free(csprogsdata);
528 if (csprogsdatacrc != requiredcrc || csprogsdatasize != requiredsize)
530 if (cls.demoplayback)
532 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);
537 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);
545 if (requiredcrc >= 0)
547 if (cls.demoplayback)
548 Con_Printf("CL_VM_Init: demo requires CSQC, but \"%s\" wasn't found\n", csqc_progname.string);
550 Con_Printf("CL_VM_Init: server requires CSQC, but \"%s\" wasn't found\n", csqc_progname.string);
557 PRVM_InitProg(PRVM_CLIENTPROG);
559 csqc_mempool = Mem_AllocPool("CSQC", 0, NULL);
561 // allocate the mempools
562 prog->progs_mempool = Mem_AllocPool(csqc_progname.string, 0, NULL);
563 prog->headercrc = CL_PROGHEADER_CRC;
564 prog->edictprivate_size = 0; // no private struct used
565 prog->name = CL_NAME;
566 prog->num_edicts = 1;
567 prog->limit_edicts = CL_MAX_EDICTS;
568 prog->extensionstring = vm_cl_extensions;
569 prog->builtins = vm_cl_builtins;
570 prog->numbuiltins = vm_cl_numbuiltins;
571 prog->init_cmd = VM_CL_Cmd_Init;
572 prog->reset_cmd = VM_CL_Cmd_Reset;
573 prog->error_cmd = CL_VM_Error;
575 PRVM_LoadProgs(csqc_progname.string, cl_numrequiredfunc, cl_required_func, 0, NULL);
578 Con_Printf("CSQC ^5loaded (crc=%i, size=%i)\n", csprogsdatacrc, (int)csprogsdatasize);
581 CL_VM_Error("CSQC ^2failed to load\n");
587 //[515]: optional fields & funcs
588 CL_VM_FindEdictFieldOffsets();
591 *prog->time = cl.time;
594 prog->globals.client->mapname = PRVM_SetEngineString(cl.worldmodel->name);
595 prog->globals.client->player_localentnum = cl.playerentity;
597 // call the prog init
598 PRVM_ExecuteProgram((func_t) (PRVM_ED_FindFunction(CL_F_INIT) - prog->functions), CL_F_INIT);
603 csqc_sv2csqcents = (unsigned short *)Mem_Alloc(csqc_mempool, MAX_EDICTS*sizeof(unsigned short));
604 memset(csqc_sv2csqcents, 0, MAX_EDICTS*sizeof(unsigned short));
606 cl.csqc_vidvars.drawcrosshair = false;
607 cl.csqc_vidvars.drawenginesbar = false;
610 void CL_VM_ShutDown (void)
612 Cmd_ClearCsqcFuncs();
613 Cvar_SetValueQuick(&csqc_progcrc, -1);
614 Cvar_SetValueQuick(&csqc_progsize, -1);
618 *prog->time = cl.time;
619 PRVM_ExecuteProgram((func_t) (PRVM_ED_FindFunction(CL_F_SHUTDOWN) - prog->functions), CL_F_SHUTDOWN);
622 Con_Print("CSQC ^1unloaded\n");
624 Mem_FreePool(&csqc_mempool);