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', "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 $*\"");\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", "ping name | caps returns frags deaths", 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         Sbar_Init();\r
  80 }\r
  81 \r
  82 // CSQC_Shutdown : Called every time the CSQC code is shutdown (changing maps, quitting, etc)\r
  83 void CSQC_Shutdown(void)\r
  84 {\r
  85 #ifdef USE_FTE\r
  86 #pragma TARGET id\r
  87         if(!__engine_check)\r
  88                 return 0;\r
  89 #pragma TARGET fte\r
  90 #endif\r
  91         db_close(configdb);\r
  92         buf_del(databuf);\r
  93 }\r
  94 \r
  95 void PostInit(void)\r
  96 {\r
  97         float i;\r
  98 \r
  99         print(strcat("PostInit\n    maxclients = ", ftos(maxclients), "\n"));\r
 100         databuf = buf_create();\r
 101         for(i = 0; i < maxclients; ++i)\r
 102         {\r
 103                 bufstr_set(databuf, DATABUF_PING + i, "N/A");\r
 104                 bufstr_set(databuf, DATABUF_DEATHS + i, "0");\r
 105                 bufstr_set(databuf, DATABUF_CAPTURES + i, "0");\r
 106                 bufstr_set(databuf, DATABUF_RETURNS + i, "0");\r
 107         }\r
 108         \r
 109         localcmd(strcat("\nsbar_columns_set ", cvar_string("sbar_columns"), ";\n"));\r
 110 \r
 111         postinit = true;\r
 112 }\r
 113 \r
 114 // CSQC_ConsoleCommand : Used to parse commands in the console that have been registered with the "registercmd" function\r
 115 // Return value should be 1 if CSQC handled the command, otherwise return 0 to have the engine handle it.\r
 116 void Cmd_Sbar_SetFields(float);\r
 117 void Cmd_Sbar_Help(float);\r
 118 float CSQC_ConsoleCommand(string strMessage)\r
 119 {\r
 120         float argc;\r
 121         // Tokenize String\r
 122         argc = tokenize(strMessage);\r
 123         \r
 124         // Acquire Command\r
 125         local string strCmd;\r
 126         strCmd = argv(0);\r
 127 \r
 128         /*if(strCmd == "ctf_menu") {\r
 129                 ctf_menu_show();\r
 130                 nReturn = true;\r
 131                 } else*/\r
 132         if(strCmd == "ons_map") {\r
 133                 Cmd_ons_map();\r
 134                 return true;\r
 135         } else if(strCmd == "sbar_columns_set") {\r
 136                 Cmd_Sbar_SetFields(argc);\r
 137                 return true;\r
 138         } else if(strCmd == "sbar_columns_help") {\r
 139                 Cmd_Sbar_Help(argc);\r
 140                 return true;\r
 141         } else if(strCmd == "+showscores") {\r
 142                 sb_showscores = true;\r
 143                 return true;\r
 144         } else if(strCmd == "-showscores") {\r
 145                 sb_showscores = false;\r
 146                 return true;\r
 147         }\r
 148         \r
 149         return false;\r
 150 }\r
 151 \r
 152 float GameCommand(string msg)\r
 153 {\r
 154         float argc;\r
 155         argc = tokenize(msg);\r
 156         string cmd;\r
 157         cmd = argv(0);\r
 158         if(cmd == "mv_download") {\r
 159                 Cmd_MapVote_MapDownload(argc);\r
 160                 return true;\r
 161         }\r
 162         \r
 163         return false;\r
 164 }\r
 165 \r
 166 // CSQC_InputEvent : Used to perform actions based on any key pressed, key released and mouse on the client.\r
 167 // Return value should be 1 if CSQC handled the input, otherwise return 0 to have the input passed to the engine.\r
 168 // All keys are in ascii.\r
 169 // bInputType = 0 is key pressed, 1 is key released, 2 is mouse input.\r
 170 // In the case of keyboard input, nPrimary is the ascii code, and nSecondary is 0.\r
 171 // In the case of mouse input, nPrimary is xdelta, nSecondary is ydelta.\r
 172 float CSQC_InputEvent(float bInputType, float nPrimary, float nSecondary)\r
 173 {\r
 174         local float bSkipKey;\r
 175         bSkipKey = false;\r
 176         \r
 177         if(menu_visible)\r
 178                 if(menu_action(bInputType, nPrimary, nSecondary))\r
 179                         return TRUE;\r
 180         return bSkipKey;\r
 181 }\r
 182 \r
 183 // END REQUIRED CSQC FUNCTIONS\r
 184 // --------------------------------------------------------------------------\r
 185 \r
 186 // --------------------------------------------------------------------------\r
 187 // BEGIN OPTIONAL CSQC FUNCTIONS\r
 188 void ReadONS()\r
 189 {\r
 190         entity gps;\r
 191         using_gps = true;\r
 192 \r
 193         self.origin_x = ReadCoord();\r
 194         self.origin_y = ReadCoord();\r
 195         self.angles_y = ReadCoord();\r
 196         self.origin_z = self.angles_x = self.angles_z = 0;\r
 197 \r
 198         for(gps = gps_start; gps; gps = gps.chain)\r
 199         {\r
 200                 if(gps == self)\r
 201                         break;\r
 202         }\r
 203         if(!gps)\r
 204         {\r
 205                 self.chain = gps_start;\r
 206                 gps_start = self;\r
 207         }\r
 208 }\r
 209 \r
 210 void RemoveONS()\r
 211 {\r
 212         if(gps_start == self)\r
 213                 gps_start = self.chain;\r
 214         else\r
 215         {\r
 216                 local entity ent;\r
 217                 ent = gps_start;\r
 218                         \r
 219                 while(ent.chain != self && ent.chain != world)\r
 220                         ent = ent.chain;\r
 221                 if(ent.chain == self)\r
 222                         ent.chain = self.chain;\r
 223         }\r
 224 }\r
 225 \r
 226 // CSQC_Ent_Update : Called every frame that the server has indicated an update to the SSQC / CSQC entity has occured.\r
 227 // The only parameter reflects if the entity is "new" to the client, meaning it just came into the client's PVS.\r
 228 void(float bIsNewEntity) CSQC_Ent_Update =\r
 229 {\r
 230         float msg;\r
 231         self.enttype = ReadByte();\r
 232         if(self.enttype == ENT_CLIENT_ENTCS)\r
 233         {\r
 234                 self.sv_entnum = ReadByte()-1;\r
 235 \r
 236                 for(msg = ReadByte(); msg != ENTCS_MSG_END; msg = ReadByte())\r
 237                 {\r
 238                         switch(msg)\r
 239                         {\r
 240                         case ENTCS_MSG_ONS_GPS: ReadONS(); break;\r
 241                         case ENTCS_MSG_ONS_REMOVE: RemoveONS(); break;\r
 242                         default:\r
 243                                 error("unknown ENTCS_MSG type\n");\r
 244                         }\r
 245                 }\r
 246         }\r
 247         else\r
 248                 error("unknown entity type in CSQC_Ent_Update\n");\r
 249         \r
 250 };\r
 251 // CSQC_Ent_Remove : Called when the server requests a SSQC / CSQC entity to be removed.  Essentially call remove(self) as well.\r
 252 void CSQC_Ent_Remove()\r
 253 {\r
 254         if(self.enttype == ENT_CLIENT_ENTCS)\r
 255         {\r
 256                 if(using_gps) //gametype == GAME_ONSLAUGHT)\r
 257                 {\r
 258                         if(gps_start == self)\r
 259                                 gps_start = self.chain;\r
 260                         else\r
 261                         {\r
 262                                 local entity ent;\r
 263                                 ent = gps_start;\r
 264                         \r
 265                                 while(ent.chain != self && ent.chain != world)\r
 266                                         ent = ent.chain;\r
 267                                 if(ent.chain == self)\r
 268                                         ent.chain = self.chain;\r
 269                         }\r
 270                 }\r
 271         }\r
 272         remove(self);\r
 273 }\r
 274 \r
 275 void Gamemode_Init()\r
 276 {\r
 277         local string mapinfo, infoline;\r
 278         local float len;\r
 279         local float file;\r
 280         local vector mi_min, mi_max;\r
 281 \r
 282         gametype = cvar("gametype");\r
 283         if(gametype == GAME_ONSLAUGHT) {\r
 284                 if(!strcasecmp(substring(mapname, 0, 5), "maps/"))\r
 285                         minimapname = substring(mapname, 5, 999);\r
 286                 else\r
 287                         minimapname = mapname;\r
 288                 len = strlen(minimapname);\r
 289                 if(!strcasecmp(substring(minimapname, len-4, 4), ".bsp"))\r
 290                         minimapname = substring(minimapname, 0, len-4);\r
 291                 \r
 292                 mapinfo = strcat("maps/", minimapname, ".info");\r
 293                 minimapname = strzone(strcat("gfx/", minimapname, "_mini.tga"));\r
 294 \r
 295                 mi_min = world.mins;\r
 296                 mi_max = world.maxs;\r
 297                 \r
 298                 file = fopen(mapinfo, FILE_READ);\r
 299                 if(file >= 0) {\r
 300                         while((infoline = fgets(file))) {\r
 301                                 if(!strncasecmp(infoline, "mins", 4)) {\r
 302                                         mi_min = stov(substring(infoline, 5, 999));\r
 303                                 } else if(!strncasecmp(infoline, "maxs", 4)) {\r
 304                                         mi_max = stov(substring(infoline, 5, 999));\r
 305                                 } else if(strncasecmp(infoline, "//", 2)) { // don't print comment-style lines\r
 306                                         print(strcat("mapinfo: ", infoline, "\n"));\r
 307                                 }\r
 308                         }\r
 309                 } else {\r
 310                         print(strcat("Map has no .info file (", mapinfo, ").\n"));\r
 311                 }\r
 312                 fclose(file);\r
 313 \r
 314                 print(strcat("Mins: ", vtos(mi_min), "    Maxs: ", vtos(mi_max), "\n"));\r
 315                 \r
 316                 mi_center = (mi_min + mi_max) * 0.5;\r
 317                 mi_scale = mi_max - mi_min;\r
 318                 \r
 319                 \r
 320                 print(strcat("Using ", minimapname, " as minimap.\n"));\r
 321                 precache_pic(minimapname);\r
 322                 precache_pic("gfx/ons-cp-neutral.tga");\r
 323                 precache_pic("gfx/ons-cp-red.tga");\r
 324                 precache_pic("gfx/ons-cp-blue.tga");\r
 325                 precache_pic("gfx/ons-frame.tga");\r
 326                 precache_pic("gfx/ons-frame-team.tga");\r
 327         } else if(gametype == GAME_KEYHUNT) {\r
 328                 precache_pic("gfx/sb_key_carrying");\r
 329                 precache_pic("gfx/sb_key_carrying_outline");\r
 330         }\r
 331 }\r
 332 // 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
 333 void CSQC_Parse_StuffCmd(string strMessage)\r
 334 {\r
 335         localcmd(strMessage);\r
 336         // watch for gametype changes!\r
 337         if(gametype != cvar("gametype"))\r
 338         {\r
 339                 Gamemode_Init();\r
 340         }\r
 341 }\r
 342 // 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
 343 void CSQC_Parse_Print(string strMessage)\r
 344 {\r
 345         print(strMessage);\r
 346 }\r
 347 // 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
 348 void CSQC_Parse_CenterPrint(string strMessage)\r
 349 {\r
 350         cprint(strMessage);\r
 351 }\r
 352 \r
 353 void CSQC_CheckRevision();\r
 354 \r
 355 void Net_ReadInit()\r
 356 {\r
 357         csqc_revision = ReadShort();\r
 358         maxclients = ReadByte();\r
 359 \r
 360         CSQC_CheckRevision();\r
 361 }\r
 362 \r
 363 void Net_ReadPings()\r
 364 {\r
 365         float plnum, ping;\r
 366         for(plnum = ReadByte(); plnum != 0; plnum = ReadByte())\r
 367         {\r
 368                 ping = ReadShort();\r
 369                 bufstr_set(databuf, DATABUF_PING + plnum-1, ftos(ping));\r
 370         }\r
 371 }\r
 372 \r
 373 void Net_ReadCaptures()\r
 374 {\r
 375         float plnum, caps, mode;\r
 376         mode = ReadByte();\r
 377         caps_team1 = ReadByte();\r
 378         caps_team2 = ReadByte();\r
 379         for(plnum = ReadByte(); plnum != 0; plnum = ReadByte())\r
 380         {\r
 381                 caps = ReadByte();\r
 382                 bufstr_set(databuf, DATABUF_CAPTURES + plnum-1, ftos(caps));\r
 383         }\r
 384 }\r
 385 \r
 386 void Net_ReadDatabuf(float ofs)\r
 387 {\r
 388         float plnum, data;\r
 389         for(plnum = ReadByte(); plnum != 0; plnum = ReadByte())\r
 390         {\r
 391                 data = ReadByte();\r
 392                 bufstr_set(databuf, ofs + plnum-1, ftos(data));\r
 393         }\r
 394 }\r
 395 \r
 396 string Net_ReadPicture()\r
 397 {\r
 398         string img;\r
 399         if(csqc_flags & CSQC_FLAG_READPICTURE)\r
 400         {\r
 401                 img = ReadPicture();\r
 402                 print(strcat("Got Picture: ", img, "\n"));\r
 403         } else {\r
 404                 img = ReadString();\r
 405                 print(strcat("^3Warning: ^7Couldn't download ", img, ". This is probably because your engine build is outdated.\n"));\r
 406                 float psize, i;\r
 407                 psize = ReadShort();\r
 408                 // Can I be sure that ReadShort is 2 bytes and ReadLong is 4 bytes?\r
 409                 // Because then this could be optimized to first get all 4-byte-groups,\r
 410                 // then the remaining 2, then the remaining 1\r
 411                 for(i = 0; i < psize; ++i)\r
 412                         ReadByte();\r
 413         }\r
 414         return img;\r
 415 }\r
 416 \r
 417 void Net_Config()\r
 418 {\r
 419         string key, value;\r
 420         key = ReadString();\r
 421         value = ReadString();\r
 422         db_put(configdb, strcat("/v/", key), value);\r
 423         db_put(configdb, strcat("/s/", key), "1");\r
 424 }\r
 425 \r
 426 // CSQC_Parse_TempEntity : Handles all temporary entity network data in the CSQC layer.\r
 427 // You must ALWAYS first acquire the temporary ID, which is sent as a byte.\r
 428 // Return value should be 1 if CSQC handled the temporary entity, otherwise return 0 to have the engine process the event.\r
 429 float CSQC_Parse_TempEntity()\r
 430 {\r
 431         local float bHandled;\r
 432                 bHandled  = true;\r
 433         // Acquire TE ID\r
 434         local float nTEID;\r
 435                 nTEID = ReadByte();\r
 436 \r
 437                 // NOTE: Could just do return instead of break...\r
 438         switch(nTEID)\r
 439         {\r
 440                 case TE_CSQC_INIT:\r
 441                         Net_ReadInit();\r
 442                         bHandled = true;\r
 443                         break;\r
 444                 case TE_CSQC_PING:\r
 445                         Net_ReadPings();\r
 446                         bHandled = true;\r
 447                         break;\r
 448                 case TE_CSQC_CAPTURES:\r
 449                         Net_ReadCaptures();\r
 450                         bHandled = true;\r
 451                         break;\r
 452                 case TE_CSQC_RETURNS:\r
 453                         Net_ReadDatabuf(DATABUF_RETURNS);\r
 454                         bHandled = true;\r
 455                         break;\r
 456                 case TE_CSQC_DEATHS:\r
 457                         Net_ReadDatabuf(DATABUF_DEATHS);\r
 458                         bHandled = true;\r
 459                         break;\r
 460                 case TE_CSQC_MAPVOTE:\r
 461                         Net_Mapvote();\r
 462                         bHandled = true;\r
 463                         break;\r
 464                 case TE_CSQC_CONFIG:\r
 465                         Net_Config();\r
 466                         bHandled = true;\r
 467                         break;\r
 468                 default:\r
 469                         // No special logic for this temporary entity; return 0 so the engine can handle it\r
 470                         bHandled = false;\r
 471                         break;\r
 472         }\r
 473         \r
 474         if(!postinit)\r
 475                 PostInit();\r
 476                 \r
 477         return bHandled;\r
 478 }\r
 479 \r
 480 // COMMIT-TODO: Update if necessare, before committing\r
 481 float csqc_svn_map[CSQC_REVISION] =\r
 482 {\r
 483         3812, // 3795,\r
 484         3820 // mapvote protocol changed from there\r
 485 };\r
 486 \r
 487 // COMMIT-TODO: Update if necessare, before committing\r
 488 void CSQC_CheckRevision()\r
 489 {\r
 490         if(csqc_revision == CSQC_REVISION)\r
 491         {\r
 492                 print("^2SVQC and CSQC revisions are compatible.\n");\r
 493         } else if(csqc_revision < CSQC_REVISION) {\r
 494                 print("^1Your csprogs.dat (CSQC) version is newer than the one on the server.\n");\r
 495                 print("^1The last known svn revision for the server's CSQC is: ^7");\r
 496                 print(ftos(csqc_svn_map[csqc_revision])); // don't use strcat, fteqcc loves screwing up arrays...\r
 497                 print("\n");\r
 498         } else if(csqc_revision > CSQC_REVISION) {\r
 499                 print("^1Your csprogs.dat (CSQC) is too old for this server.\n");\r
 500                 print("^1Please update to a newer version.\n");\r
 501         }\r
 502 }\r