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