]> icculus.org git repositories - divverent/nexuiz.git/blob - data/qcsrc/client/Main.qc
make CSQC scores safer against packet loss/rearrangements
[divverent/nexuiz.git] / data / qcsrc / client / Main.qc
1 // --------------------------------------------------------------------------\r
2 // BEGIN REQUIRED CSQC FUNCTIONS\r
3 //include "main.qh"\r
4 \r
5 void() menu_show_error =\r
6 {\r
7         drawstring('0 200 0', "ERROR - MENU IS VISIBLE BUT NO MENU WAS DEFINED!", '8 8 0', '1 0 0', 1, 0);\r
8 };\r
9 \r
10 // CSQC_Init : Called every time the CSQC code is initialized (essentially at map load)\r
11 // Useful for precaching things\r
12 \r
13 void() menu_sub_null =\r
14 {\r
15 };\r
16 \r
17 // let's make this a general data buffer...\r
18 float using_gps;\r
19 \r
20 #ifdef USE_FTE\r
21 float __engine_check;\r
22 #endif\r
23 \r
24 string config_get(string key, string defaultvalue)\r
25 {\r
26         string s;\r
27         s = db_get(configdb, strcat("/s/", key));\r
28         if(s == "")\r
29                 return defaultvalue;\r
30         else\r
31                 return db_get(configdb, strcat("/v/", key));\r
32 }\r
33 \r
34 void CSQC_Init(void)\r
35 {\r
36 #ifdef USE_FTE\r
37 #pragma target ID\r
38         __engine_check = checkextension("DP_SV_WRITEPICTURE");\r
39         if(!__engine_check)\r
40         {\r
41                 print("^3Your engine build is outdated\n^3This Server uses a newer QC VM. Please update!\n");\r
42                 localcmd("\ndisconnect\n");\r
43                 return;\r
44         }\r
45 #pragma target FTE\r
46 #endif\r
47         \r
48         float i;\r
49         CSQC_CheckEngine();\r
50 \r
51         configdb = db_create();\r
52 \r
53         drawfont = 0;\r
54         menu_visible = FALSE;\r
55         menu_show = menu_show_error;\r
56         menu_action = menu_sub_null;\r
57         using_gps = false;\r
58         //ctf_temp_1 = "";\r
59         // localcmd("alias order \"cmd order $*\""); enable if ctf-command thingy is used\r
60         //registercmd("ctf_menu");\r
61         registercmd("ons_map");\r
62         //registercmd("menu_action");\r
63         registercmd("sbar_columns_set");\r
64         registercmd("sbar_columns_help");\r
65 \r
66         registercvar("sbar_usecsqc", "1");\r
67         registercvar("sbar_columns", "default", CVAR_SAVE);\r
68 \r
69         gametype = 0;\r
70 \r
71         gps_start = world;\r
72 \r
73         // sbar_fields uses strunzone on the titles!\r
74         for(i = 0; i < MAX_SBAR_FIELDS; ++i)\r
75                 sbar_title[i] = strzone("(null)");\r
76 \r
77         postinit = false;\r
78 \r
79         teams = Sort_Spawn();\r
80         players = Sort_Spawn();\r
81         \r
82         GetTeam(COLOR_SPECTATOR, true); // add specs first\r
83 }\r
84 \r
85 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)\r
86 void CSQC_Shutdown(void)\r
87 {\r
88 #ifdef USE_FTE\r
89 #pragma TARGET id\r
90         if(!__engine_check)\r
91                 return 0;\r
92 #pragma TARGET fte\r
93 #endif\r
94 \r
95         remove(teams);\r
96         remove(players);\r
97         db_close(configdb);\r
98         buf_del(databuf);\r
99 }\r
100 \r
101 .float has_team;\r
102 float SetTeam(entity o, float Team)\r
103 {\r
104         entity tm;\r
105         if(Team == -1) // leave\r
106         {\r
107                 if(o.has_team)\r
108                 {\r
109                         //print("(DISCONNECT) leave team ", ftos(o.team), "\n");\r
110                         tm = GetTeam(o.team, false);\r
111                         tm.team_size -= 1;\r
112                         o.has_team = 0;\r
113                         return TRUE;\r
114                 }\r
115         }\r
116         else\r
117         {\r
118                 if not(o.has_team)\r
119                 {\r
120                         //print("(CONNECT) enter team ", ftos(o.team), "\n");\r
121                         o.team = Team;\r
122                         tm = GetTeam(Team, true);\r
123                         tm.team_size += 1;\r
124                         o.has_team = 1;\r
125                         return TRUE;\r
126                 }\r
127                 else if(Team != o.team)\r
128                 {\r
129                         //print("(CHANGE) leave team ", ftos(o.team), "\n");\r
130                         tm = GetTeam(o.team, false);\r
131                         tm.team_size -= 1;\r
132                         o.team = Team;\r
133                         //print("(CHANGE) enter team ", ftos(o.team), "\n");\r
134                         tm = GetTeam(Team, true);\r
135                         tm.team_size += 1;\r
136                         return TRUE;\r
137                 }\r
138         }\r
139         return FALSE;\r
140 }\r
141 \r
142 void Playerchecker_Think()\r
143 {\r
144         entity pl;\r
145         float i;\r
146         for(i = 0; i < maxclients; ++i)\r
147         {\r
148                 if(getplayerkey(i, "name") == "")\r
149                 {\r
150                         if(playerslots[i].sort_prev)\r
151                         {\r
152                                 //print("playerchecker: KILL KILL KILL\n");\r
153                                 // player disconnected\r
154                                 SetTeam(playerslots[i], -1);\r
155                                 RemovePlayer(playerslots[i]);\r
156                                 playerslots[i].sort_prev = world;\r
157                                 playerslots[i].gotscores = 0;\r
158                         }\r
159                 }\r
160                 else\r
161                 {\r
162                         if not(playerslots[i].sort_prev)\r
163                         {\r
164                                 //print("playerchecker: SPAWN SPAWN SPAWN\n");\r
165                                 // player connected\r
166                                 if not(playerslots[i])\r
167                                         playerslots[i] = spawn();\r
168                                 playerslots[i].sv_entnum = i;\r
169                                 playerslots[i].gotscores = 0;\r
170                                 SetTeam(playerslots[i], COLOR_SPECTATOR);\r
171                                 RegisterPlayer(playerslots[i]);\r
172                         }\r
173                 }\r
174         }\r
175         self.nextthink = time + 0.2;\r
176 }\r
177 \r
178 void PostInit(void)\r
179 {\r
180         float i;\r
181 \r
182         print(strcat("PostInit\n    maxclients = ", ftos(maxclients), "\n"));\r
183         databuf = buf_create();\r
184         for(i = 0; i < maxclients; ++i)\r
185         {\r
186                 bufstr_set(databuf, DATABUF_PING + i, "N/A");\r
187         }\r
188         \r
189         localcmd(strcat("\nsbar_columns_set ", cvar_string("sbar_columns"), ";\n"));\r
190 \r
191         entity playerchecker;\r
192         playerchecker = spawn();\r
193         playerchecker.think = Playerchecker_Think;\r
194         playerchecker.nextthink = time + 0.2;\r
195 \r
196         postinit = true;\r
197 }\r
198 \r
199 // CSQC_ConsoleCommand : Used to parse commands in the console that have been registered with the "registercmd" function\r
200 // Return value should be 1 if CSQC handled the command, otherwise return 0 to have the engine handle it.\r
201 void Cmd_Sbar_SetFields(float);\r
202 void Cmd_Sbar_Help(float);\r
203 float CSQC_ConsoleCommand(string strMessage)\r
204 {\r
205         float argc;\r
206         // Tokenize String\r
207         //argc = tokenize(strMessage);\r
208         argc = tokenizebyseparator(strMessage, " ");\r
209         \r
210         // Acquire Command\r
211         local string strCmd;\r
212         strCmd = argv(0);\r
213 \r
214         /*if(strCmd == "ctf_menu") {\r
215                 ctf_menu_show();\r
216                 nReturn = true;\r
217                 } else*/\r
218         if(strCmd == "ons_map") {\r
219                 Cmd_ons_map();\r
220                 return true;\r
221         } else if(strCmd == "sbar_columns_set") {\r
222                 Cmd_Sbar_SetFields(argc);\r
223                 return true;\r
224         } else if(strCmd == "sbar_columns_help") {\r
225                 Cmd_Sbar_Help(argc);\r
226                 return true;\r
227         } else if(strCmd == "+showscores") {\r
228                 sb_showscores = true;\r
229                 return true;\r
230         } else if(strCmd == "-showscores") {\r
231                 sb_showscores = false;\r
232                 return true;\r
233         }\r
234         \r
235         return false;\r
236 }\r
237 \r
238 float GameCommand(string msg)\r
239 {\r
240         float argc;\r
241         argc = tokenize(msg);\r
242         string cmd;\r
243         cmd = argv(0);\r
244         if(cmd == "mv_download") {\r
245                 Cmd_MapVote_MapDownload(argc);\r
246                 return true;\r
247         }\r
248         \r
249         return false;\r
250 }\r
251 \r
252 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.\r
253 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.\r
254 // All keys are in ascii.\r
255 // bInputType = 0 is key pressed, 1 is key released, 2 is mouse input.\r
256 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.\r
257 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.\r
258 float CSQC_InputEvent(float bInputType, float nPrimary, float nSecondary)\r
259 {\r
260         local float bSkipKey;\r
261         bSkipKey = false;\r
262         \r
263         if(menu_visible)\r
264                 if(menu_action(bInputType, nPrimary, nSecondary))\r
265                         return TRUE;\r
266         return bSkipKey;\r
267 }\r
268 \r
269 // END REQUIRED CSQC FUNCTIONS\r
270 // --------------------------------------------------------------------------\r
271 \r
272 // --------------------------------------------------------------------------\r
273 // BEGIN OPTIONAL CSQC FUNCTIONS\r
274 void Ent_ReadONS()\r
275 {\r
276         entity gps;\r
277         using_gps = true;\r
278 \r
279         self.origin_x = ReadCoord();\r
280         self.origin_y = ReadCoord();\r
281         self.angles_y = ReadCoord();\r
282         self.origin_z = self.angles_x = self.angles_z = 0;\r
283 \r
284         for(gps = gps_start; gps; gps = gps.chain)\r
285         {\r
286                 if(gps == self)\r
287                         break;\r
288         }\r
289         if(!gps)\r
290         {\r
291                 self.chain = gps_start;\r
292                 gps_start = self;\r
293         }\r
294 }\r
295 \r
296 void Ent_RemoveONS()\r
297 {\r
298         if(gps_start == self)\r
299                 gps_start = self.chain;\r
300         else\r
301         {\r
302                 local entity ent;\r
303                 ent = gps_start;\r
304                         \r
305                 while(ent.chain != self && ent.chain != world)\r
306                         ent = ent.chain;\r
307                 if(ent.chain == self)\r
308                         ent.chain = self.chain;\r
309         }\r
310 }\r
311 \r
312 void Ent_ReadPlayerScore(float isNew)\r
313 {\r
314         float i, Team;\r
315         entity tm, o;\r
316 \r
317         // damnit -.- don't want to go change every single .sv_entnum in sbar.qc AGAIN\r
318         // (no I've never heard of M-x replace-string, sed, or anything like that)\r
319         isNew = !self.owner; // workaround for DP bug\r
320         self.sv_entnum = ReadByte()-1;\r
321         Team = GetPlayerColor(self.sv_entnum);\r
322 \r
323         if not(playerslots[self.sv_entnum])\r
324                 playerslots[self.sv_entnum] = spawn();\r
325         o = self.owner = playerslots[self.sv_entnum];\r
326         o.sv_entnum = self.sv_entnum;\r
327         o.gotscores = 1;\r
328         if not(o.sort_prev)\r
329                 RegisterPlayer(o);\r
330 \r
331         SetTeam(o, Team);\r
332 \r
333         for(i = 0; i < MAX_SCORE; ++i)\r
334                 o.(scores[i]) = ReadShort();\r
335 \r
336         Sbar_UpdatePlayerPos(o);\r
337 }\r
338 \r
339 void Ent_ReadTeamScore(float isNew)\r
340 {\r
341         float i;\r
342         entity o;\r
343         \r
344         self.team = ReadByte();\r
345         o = self.owner = GetTeam(self.team, true);\r
346 \r
347         for(i = 0; i < MAX_TEAMSCORE; ++i)\r
348                 o.(teamscores[i]) = ReadShort();\r
349 \r
350         Sbar_UpdateTeamPos(o);\r
351 }\r
352 \r
353 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.\r
354 // The only parameter reflects if the entity is "new" to the client, meaning it just came into the client's PVS.\r
355 void(float bIsNewEntity) CSQC_Ent_Update =\r
356 {\r
357         float msg;\r
358         self.enttype = ReadByte();\r
359         if(self.enttype == ENT_CLIENT_ENTCS)\r
360         {\r
361                 self.sv_entnum = ReadByte()-1;\r
362 \r
363                 for(msg = ReadByte(); msg != ENTCS_MSG_END; msg = ReadByte())\r
364                 {\r
365                         switch(msg)\r
366                         {\r
367                         case ENTCS_MSG_ONS_GPS: Ent_ReadONS(); break;\r
368                         case ENTCS_MSG_ONS_REMOVE: Ent_RemoveONS(); break;\r
369                         default:\r
370                                 error("unknown ENTCS_MSG type\n");\r
371                         }\r
372                 }\r
373         }\r
374         else if(self.enttype == ENT_CLIENT_SCORES)\r
375                 Ent_ReadPlayerScore(bIsNewEntity);\r
376         else if(self.enttype == ENT_CLIENT_TEAMSCORES)\r
377                 Ent_ReadTeamScore(bIsNewEntity);\r
378         else\r
379                 error("unknown entity type in CSQC_Ent_Update\n");\r
380         \r
381 };\r
382 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed.  Essentially call remove(self) as well.\r
383 void CSQC_Ent_Remove()\r
384 {\r
385         if(self.enttype == ENT_CLIENT_ENTCS)\r
386         {\r
387                 if(using_gps) //gametype == GAME_ONSLAUGHT)\r
388                 {\r
389                         if(gps_start == self)\r
390                                 gps_start = self.chain;\r
391                         else\r
392                         {\r
393                                 local entity ent;\r
394                                 ent = gps_start;\r
395                         \r
396                                 while(ent.chain != self && ent.chain != world)\r
397                                         ent = ent.chain;\r
398                                 if(ent.chain == self)\r
399                                         ent.chain = self.chain;\r
400                         }\r
401                 }\r
402         } else if(self.enttype == ENT_CLIENT_SCORES)\r
403         {\r
404                 entity tm;\r
405                 if(self.owner)\r
406                 {\r
407                         SetTeam(self.owner, -1);\r
408                         RemovePlayer(self.owner);\r
409                         self.owner.sort_prev = NULL;\r
410                 }\r
411         } else if(self.enttype == ENT_CLIENT_TEAMSCORES)\r
412         {\r
413                 /*\r
414                 if(self.owner)\r
415                         RemoveTeam(self.owner);\r
416                 */\r
417                 // we don't NEED to remove them... they won't display anyway\r
418                 // plus, svqc never does this anyway\r
419         }\r
420         remove(self);\r
421 }\r
422 \r
423 void Gamemode_Init()\r
424 {\r
425         local string mapinfo, infoline;\r
426         local float len;\r
427         local float file;\r
428         local vector mi_min, mi_max;\r
429 \r
430         if(!strcasecmp(substring(mapname, 0, 5), "maps/"))\r
431                 shortmapname = substring(mapname, 5, 999);\r
432         else\r
433                 shortmapname = mapname;\r
434         len = strlen(shortmapname);\r
435         if(!strcasecmp(substring(shortmapname, len-4, 4), ".bsp"))\r
436                 shortmapname = substring(shortmapname, 0, len-4);\r
437         shortmapname = strzone(shortmapname);\r
438 \r
439         if(gametype == GAME_ONSLAUGHT) {\r
440                 mapinfo = strcat("maps/", minimapname, ".info");\r
441                 minimapname = strzone(strcat("gfx/", shortmapname, "_mini.tga"));\r
442 \r
443                 mi_min = world.mins;\r
444                 mi_max = world.maxs;\r
445                 \r
446                 file = fopen(mapinfo, FILE_READ);\r
447                 if(file >= 0) {\r
448                         while((infoline = fgets(file))) {\r
449                                 if(!strncasecmp(infoline, "mins", 4)) {\r
450                                         mi_min = stov(substring(infoline, 5, 999));\r
451                                 } else if(!strncasecmp(infoline, "maxs", 4)) {\r
452                                         mi_max = stov(substring(infoline, 5, 999));\r
453                                 } else if(strncasecmp(infoline, "//", 2)) { // don't print comment-style lines\r
454                                         print(strcat("mapinfo: ", infoline, "\n"));\r
455                                 }\r
456                         }\r
457                 } else {\r
458                         print(strcat("Map has no .info file (", mapinfo, ").\n"));\r
459                 }\r
460                 fclose(file);\r
461 \r
462                 print(strcat("Mins: ", vtos(mi_min), "    Maxs: ", vtos(mi_max), "\n"));\r
463                 \r
464                 mi_center = (mi_min + mi_max) * 0.5;\r
465                 mi_scale = mi_max - mi_min;\r
466                 \r
467                 \r
468                 print(strcat("Using ", minimapname, " as minimap.\n"));\r
469                 precache_pic(minimapname);\r
470                 precache_pic("gfx/ons-cp-neutral.tga");\r
471                 precache_pic("gfx/ons-cp-red.tga");\r
472                 precache_pic("gfx/ons-cp-blue.tga");\r
473                 precache_pic("gfx/ons-frame.tga");\r
474                 precache_pic("gfx/ons-frame-team.tga");\r
475         } else if(gametype == GAME_KEYHUNT) {\r
476                 precache_pic("gfx/sb_key_carrying");\r
477                 precache_pic("gfx/sb_key_carrying_outline");\r
478         }\r
479 }\r
480 // CSQC_Parse_StuffCmd : Provides the stuffcmd string in the first parameter that the server provided.  To execute standard behavior, simply execute localcmd with the string.\r
481 void CSQC_Parse_StuffCmd(string strMessage)\r
482 {\r
483         localcmd(strMessage);\r
484 }\r
485 // CSQC_Parse_Print : Provides the print string in the first parameter that the server provided.  To execute standard behavior, simply execute print with the string.\r
486 void CSQC_Parse_Print(string strMessage)\r
487 {\r
488         print(strMessage);\r
489 }\r
490 // CSQC_Parse_CenterPrint : Provides the centerprint string in the first parameter that the server provided.  To execute standard behavior, simply execute cprint with the string.\r
491 void CSQC_Parse_CenterPrint(string strMessage)\r
492 {\r
493         cprint(strMessage);\r
494 }\r
495 \r
496 void CSQC_CheckRevision();\r
497 \r
498 void Gamemode_Init();\r
499 void Net_ReadScoresInfo()\r
500 {\r
501         float i;\r
502         gametype = ReadByte();\r
503         for(i = 0; i < MAX_SCORE; ++i)\r
504         {\r
505                 scores_label[i] = strzone(ReadString());\r
506                 scores_flags[i] = ReadByte();\r
507         }\r
508         for(i = 0; i < MAX_TEAMSCORE; ++i)\r
509         {\r
510                 teamscores_label[i] = strzone(ReadString());\r
511                 teamscores_flags[i] = ReadByte();\r
512         }\r
513         Sbar_InitScores();\r
514         Gamemode_Init();\r
515 }\r
516 \r
517 void Net_ReadInit()\r
518 {\r
519         csqc_revision = ReadShort();\r
520         maxclients = ReadByte();\r
521 \r
522         CSQC_CheckRevision();\r
523 }\r
524 \r
525 void Net_ReadPings()\r
526 {\r
527         float plnum, ping;\r
528         for(plnum = ReadByte(); plnum != 0; plnum = ReadByte())\r
529         {\r
530                 ping = ReadShort();\r
531                 bufstr_set(databuf, DATABUF_PING + plnum-1, ftos(ping));\r
532         }\r
533 }\r
534 \r
535 string Net_ReadPicture()\r
536 {\r
537         string img;\r
538         if(csqc_flags & CSQC_FLAG_READPICTURE)\r
539         {\r
540                 img = ReadPicture();\r
541                 print(strcat("Got Picture: ", img, "\n"));\r
542         } else {\r
543                 img = ReadString();\r
544                 print(strcat("^3Warning: ^7Couldn't download ", img, ". This is probably because your engine build is outdated.\n"));\r
545                 float psize, i;\r
546                 psize = ReadShort();\r
547                 // Can I be sure that ReadShort is 2 bytes and ReadLong is 4 bytes?\r
548                 // Because then this could be optimized to first get all 4-byte-groups,\r
549                 // then the remaining 2, then the remaining 1\r
550                 for(i = 0; i < psize; ++i)\r
551                         ReadByte();\r
552         }\r
553         return img;\r
554 }\r
555 \r
556 void Net_Config()\r
557 {\r
558         string key, value;\r
559         key = ReadString();\r
560         value = ReadString();\r
561         db_put(configdb, strcat("/v/", key), value);\r
562         db_put(configdb, strcat("/s/", key), "1");\r
563 }\r
564 \r
565 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.\r
566 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.\r
567 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.\r
568 float CSQC_Parse_TempEntity()\r
569 {\r
570         local float bHandled;\r
571                 bHandled  = true;\r
572         // Acquire TE ID\r
573         local float nTEID;\r
574                 nTEID = ReadByte();\r
575 \r
576                 // NOTE: Could just do return instead of break...\r
577         switch(nTEID)\r
578         {\r
579                 case TE_CSQC_INIT:\r
580                         Net_ReadInit();\r
581                         bHandled = true;\r
582                         break;\r
583                 case TE_CSQC_PING:\r
584                         Net_ReadPings();\r
585                         bHandled = true;\r
586                         break;\r
587                 case TE_CSQC_MAPVOTE:\r
588                         Net_Mapvote();\r
589                         bHandled = true;\r
590                         break;\r
591                 case TE_CSQC_CONFIG:\r
592                         Net_Config();\r
593                         bHandled = true;\r
594                         break;\r
595                 case TE_CSQC_SCORESINFO:\r
596                         Net_ReadScoresInfo();\r
597                         bHandled = true;\r
598                         break;\r
599                 default:\r
600                         // No special logic for this temporary entity; return 0 so the engine can handle it\r
601                         bHandled = false;\r
602                         break;\r
603         }\r
604         \r
605         if(!postinit)\r
606                 PostInit();\r
607                 \r
608         return bHandled;\r
609 }\r
610 \r
611 // COMMIT-TODO: Update if necessare, before committing\r
612 float csqc_svn_map[CSQC_REVISION] =\r
613 {\r
614         3812, // 3795,\r
615         3820 // mapvote protocol changed from there\r
616 };\r
617 \r
618 // COMMIT-TODO: Update if necessare, before committing\r
619 void CSQC_CheckRevision()\r
620 {\r
621         if(csqc_revision == CSQC_REVISION)\r
622         {\r
623                 print("^2SVQC and CSQC revisions are compatible.\n");\r
624         } else if(csqc_revision < CSQC_REVISION) {\r
625                 print("^1Your csprogs.dat (CSQC) version is newer than the one on the server.\n");\r
626                 print("^1The last known svn revision for the server's CSQC is: ^7");\r
627                 print(ftos(csqc_svn_map[csqc_revision])); // don't use strcat, fteqcc loves screwing up arrays...\r
628                 print("\n");\r
629         } else if(csqc_revision > CSQC_REVISION) {\r
630                 print("^1Your csprogs.dat (CSQC) is too old for this server.\n");\r
631                 print("^1Please update to a newer version.\n");\r
632         }\r
633 }\r