qcsrc/common/mutators/mutator/superspec/superspec.qc

   1 #ifdef IMPLEMENTATION
   2 REGISTER_MUTATOR(superspec, cvar("g_superspectate"));
   3
   4 #define _SSMAGIX "SUPERSPEC_OPTIONSFILE_V1"
   5 #define _ISLOCAL ((edict_num(1) == self) ? true : false)
   6
   7 const float ASF_STRENGTH                = BIT(0);
   8 const float ASF_SHIELD                  = BIT(1);
   9 const float ASF_MEGA_AR                 = BIT(2);
  10 const float ASF_MEGA_HP                 = BIT(3);
  11 const float ASF_FLAG_GRAB               = BIT(4);
  12 const float ASF_OBSERVER_ONLY   = BIT(5);
  13 const float ASF_SHOWWHAT                = BIT(6);
  14 const float ASF_SSIM                    = BIT(7);
  15 const float ASF_FOLLOWKILLER    = BIT(8);
  16 const float ASF_ALL                     = 0xFFFFFF;
  17 .float autospec_flags;
  18
  19 const float SSF_SILENT = 1;
  20 const float SSF_VERBOSE = 2;
  21 const float SSF_ITEMMSG = 4;
  22 .float superspec_flags;
  23
  24 .string superspec_itemfilter; //"classname1 classname2 ..."
  25
  26 bool superspec_Spectate(entity _player)
  27 {SELFPARAM();
  28         if(Spectate(_player) == 1)
  29             TRANSMUTE(Spectator, self);
  30
  31         return true;
  32 }
  33
  34 void superspec_save_client_conf()
  35 {SELFPARAM();
  36         string fn = "superspec-local.options";
  37         float fh;
  38
  39         if (!_ISLOCAL)
  40         {
  41                 if(self.crypto_idfp == "")
  42                         return;
  43
  44                 fn = sprintf("superspec-%s.options", uri_escape(self.crypto_idfp));
  45         }
  46
  47         fh = fopen(fn, FILE_WRITE);
  48         if(fh < 0)
  49         {
  50                 LOG_TRACE("^1ERROR: ^7 superspec can not open ", fn, " for writing.\n");
  51         }
  52         else
  53         {
  54                 fputs(fh, _SSMAGIX);
  55                 fputs(fh, "\n");
  56                 fputs(fh, ftos(self.autospec_flags));
  57                 fputs(fh, "\n");
  58                 fputs(fh, ftos(self.superspec_flags));
  59                 fputs(fh, "\n");
  60                 fputs(fh, self.superspec_itemfilter);
  61                 fputs(fh, "\n");
  62                 fclose(fh);
  63         }
  64 }
  65
  66 void superspec_msg(string _center_title, string _con_title, entity _to, string _msg, float _spamlevel)
  67 {
  68         sprint(_to, strcat(_con_title, _msg));
  69
  70         if(_to.superspec_flags & SSF_SILENT)
  71                 return;
  72
  73         if(_spamlevel > 1)
  74                 if (!(_to.superspec_flags & SSF_VERBOSE))
  75                         return;
  76
  77         centerprint(_to, strcat(_center_title, _msg));
  78 }
  79
  80 float superspec_filteritem(entity _for, entity _item)
  81 {
  82         float i;
  83
  84         if(_for.superspec_itemfilter == "")
  85                 return true;
  86
  87         if(_for.superspec_itemfilter == "")
  88                 return true;
  89
  90         float l = tokenize_console(_for.superspec_itemfilter);
  91         for(i = 0; i < l; ++i)
  92         {
  93                 if(argv(i) == _item.classname)
  94                         return true;
  95         }
  96
  97         return false;
  98 }
  99
 100 MUTATOR_HOOKFUNCTION(superspec, ItemTouch)
 101 {SELFPARAM();
 102         entity _item = self;
 103
 104         FOREACH_CLIENT(true, LAMBDA(
 105                 if(!IS_SPEC(it) && !IS_OBSERVER(it))
 106                         continue;
 107                 if(it.superspec_flags & SSF_ITEMMSG)
 108                         if(superspec_filteritem(it, _item))
 109                         {
 110                                 if(it.superspec_flags & SSF_VERBOSE)
 111                                         superspec_msg("", "", it, sprintf("Player %s^7 just picked up ^3%s\n", other.netname, _item.netname), 1);
 112                                 else
 113                                         superspec_msg("", "", it, sprintf("Player %s^7 just picked up ^3%s\n^8(%s^8)\n", other.netname, _item.netname, _item.classname), 1);
 114                                 if((it.autospec_flags & ASF_SSIM) && it.enemy != other)
 115                                 {
 116                                         WITHSELF(it, superspec_Spectate(other));
 117                                         return MUT_ITEMTOUCH_CONTINUE;
 118                                 }
 119                         }
 120
 121                 if((it.autospec_flags & ASF_SHIELD && _item.invincible_finished) ||
 122                         (it.autospec_flags & ASF_STRENGTH && _item.strength_finished) ||
 123                         (it.autospec_flags & ASF_MEGA_AR && _item.itemdef == ITEM_ArmorMega) ||
 124                         (it.autospec_flags & ASF_MEGA_HP && _item.itemdef == ITEM_HealthMega) ||
 125                         (it.autospec_flags & ASF_FLAG_GRAB && _item.classname == "item_flag_team"))
 126                 {
 127
 128                         if((it.enemy != other) || IS_OBSERVER(it))
 129                         {
 130                                 if(it.autospec_flags & ASF_OBSERVER_ONLY && !IS_OBSERVER(it))
 131                                 {
 132                                         if(it.superspec_flags & SSF_VERBOSE)
 133                                                 superspec_msg("", "", it, sprintf("^8Ignored that ^7%s^8 grabbed %s^8 since the observer_only option is ON\n", other.netname, _item.netname), 2);
 134                                 }
 135                                 else
 136                                 {
 137                                         if(it.autospec_flags & ASF_SHOWWHAT)
 138                                                 superspec_msg("", "", it, sprintf("^7Following %s^7 due to picking up %s\n", other.netname, _item.netname), 2);
 139
 140                                         WITHSELF(it, superspec_Spectate(other));
 141                                 }
 142                         }
 143                 }
 144         ));
 145
 146         return MUT_ITEMTOUCH_CONTINUE;
 147 }
 148
 149 MUTATOR_HOOKFUNCTION(superspec, SV_ParseClientCommand)
 150 {
 151 #define OPTIONINFO(flag,var,test,text,long,short) \
 152     var = strcat(var, ((flag & test) ? "^2[ON]  ^7" : "^1[OFF] ^7")); \
 153     var = strcat(var, text," ^7(^3 ", long, "^7 | ^3", short, " ^7)\n")
 154
 155         if(MUTATOR_RETURNVALUE) // command was already handled?
 156                 return false;
 157
 158         entity player = M_ARGV(0, entity);
 159         string cmd_name = M_ARGV(1, string);
 160         int cmd_argc = M_ARGV(2, int);
 161
 162         if(IS_PLAYER(player))
 163                 return false;
 164
 165         if(cmd_name == "superspec_itemfilter")
 166         {
 167                 if(argv(1) == "help")
 168                 {
 169                         string _aspeco;
 170                         _aspeco = "^7 superspec_itemfilter ^3\"item_classname1 item_classname2\"^7 only show thise items when ^2superspec ^3item_message^7 is on\n";
 171                         _aspeco = strcat(_aspeco, "^3 clear^7 Remove the filter (show all pickups)\n");
 172                         _aspeco = strcat(_aspeco, "^3 show ^7 Display current filter\n");
 173                         superspec_msg("^3superspec_itemfilter help:\n\n\n", "\n^3superspec_itemfilter help:\n", player, _aspeco, 1);
 174                 }
 175                 else if(argv(1) == "clear")
 176                 {
 177                         if(player.superspec_itemfilter != "")
 178                                 strunzone(player.superspec_itemfilter);
 179
 180                         player.superspec_itemfilter = "";
 181                 }
 182                 else if(argv(1) == "show" || argv(1) == "")
 183                 {
 184                         if(player.superspec_itemfilter == "")
 185                         {
 186                                 superspec_msg("^3superspec_itemfilter^7 is ^1not^7 set", "\n^3superspec_itemfilter^7 is ^1not^7 set\n", player, "", 1);
 187                                 return true;
 188                         }
 189                         float i;
 190                         float l = tokenize_console(player.superspec_itemfilter);
 191                         string _msg = "";
 192                         for(i = 0; i < l; ++i)
 193                                 _msg = strcat(_msg, "^3#", ftos(i), " ^7", argv(i), "\n");
 194                                 //_msg = sprintf("^3#%d^7 %s\n%s", i, _msg, argv(i));
 195
 196                         _msg = strcat(_msg,"\n");
 197
 198                         superspec_msg("^3superspec_itemfilter is:\n\n\n", "\n^3superspec_itemfilter is:\n", player, _msg, 1);
 199                 }
 200                 else
 201                 {
 202                         if(player.superspec_itemfilter != "")
 203                                 strunzone(player.superspec_itemfilter);
 204
 205                         player.superspec_itemfilter = strzone(argv(1));
 206                 }
 207
 208                 return true;
 209         }
 210
 211         if(cmd_name == "superspec")
 212         {
 213                 string _aspeco;
 214
 215                 if(cmd_argc > 1)
 216                 {
 217                         float i, _bits = 0, _start = 1;
 218                         if(argv(1) == "help")
 219                         {
 220                                 _aspeco = "use cmd superspec [option] [on|off] to set options\n\n";
 221                                 _aspeco = strcat(_aspeco, "^3 silent ^7(short^5 si^7) supresses ALL messages from superspectate.\n");
 222                                 _aspeco = strcat(_aspeco, "^3 verbose ^7(short^5 ve^7) makes superspectate print some additional information.\n");
 223                                 _aspeco = strcat(_aspeco, "^3 item_message ^7(short^5 im^7) makes superspectate print items that were picked up.\n");
 224                                 _aspeco = strcat(_aspeco, "^7    Use cmd superspec_itemfilter \"item_class1 item_class2\" to set up a filter of what to show with ^3item_message.\n");
 225                                 superspec_msg("^2Available Super Spectate ^3options:\n\n\n", "\n^2Available Super Spectate ^3options:\n", player, _aspeco, 1);
 226                                 return true;
 227                         }
 228
 229                         if(argv(1) == "clear")
 230                         {
 231                                 player.superspec_flags = 0;
 232                                 _start = 2;
 233                         }
 234
 235                         for(i = _start; i < cmd_argc; ++i)
 236                         {
 237                                 if(argv(i) == "on" || argv(i) == "1")
 238                                 {
 239                                         player.superspec_flags |= _bits;
 240                                         _bits = 0;
 241                                 }
 242                                 else if(argv(i) == "off" || argv(i) == "0")
 243                                 {
 244                                         if(_start == 1)
 245                                                 player.superspec_flags &= ~_bits;
 246
 247                                         _bits = 0;
 248                                 }
 249                                 else
 250                                 {
 251                                         if((argv(i) == "silent") || (argv(i) == "si")) _bits |= SSF_SILENT ;
 252                                         if((argv(i) == "verbose") || (argv(i) == "ve")) _bits |= SSF_VERBOSE;
 253                                         if((argv(i) == "item_message") || (argv(i) == "im")) _bits |= SSF_ITEMMSG;
 254                                 }
 255                         }
 256                 }
 257
 258                 _aspeco = "";
 259                 OPTIONINFO(player.superspec_flags, _aspeco, SSF_SILENT, "Silent", "silent", "si");
 260                 OPTIONINFO(player.superspec_flags, _aspeco, SSF_VERBOSE, "Verbose", "verbose", "ve");
 261                 OPTIONINFO(player.superspec_flags, _aspeco, SSF_ITEMMSG, "Item pickup messages", "item_message", "im");
 262
 263                 superspec_msg("^3Current Super Spectate options are:\n\n\n\n\n", "\n^3Current Super Spectate options are:\n", player, _aspeco, 1);
 264
 265                 return true;
 266         }
 267
 268 /////////////////////
 269
 270         if(cmd_name == "autospec")
 271         {
 272                 string _aspeco;
 273                 if(cmd_argc > 1)
 274                 {
 275                         if(argv(1) == "help")
 276                         {
 277                                 _aspeco = "use cmd autospec [option] [on|off] to set options\n\n";
 278                                 _aspeco = strcat(_aspeco, "^3 strength ^7(short^5 st^7) for automatic spectate on strength powerup\n");
 279                                 _aspeco = strcat(_aspeco, "^3 shield ^7(short^5 sh^7) for automatic spectate on shield powerup\n");
 280                                 _aspeco = strcat(_aspeco, "^3 mega_health ^7(short^5 mh^7) for automatic spectate on mega health\n");
 281                                 _aspeco = strcat(_aspeco, "^3 mega_armor ^7(short^5 ma^7) for automatic spectate on mega armor\n");
 282                                 _aspeco = strcat(_aspeco, "^3 flag_grab ^7(short^5 fg^7) for automatic spectate on CTF flag grab\n");
 283                                 _aspeco = strcat(_aspeco, "^3 observer_only ^7(short^5 oo^7) for automatic spectate only if in observer mode\n");
 284                                 _aspeco = strcat(_aspeco, "^3 show_what ^7(short^5 sw^7) to display what event triggered autospectate\n");
 285                                 _aspeco = strcat(_aspeco, "^3 item_msg ^7(short^5 im^7) to autospec when item_message in superspectate is triggered\n");
 286                                 _aspeco = strcat(_aspeco, "^3 followkiller ^7(short ^5fk^7) to autospec the killer/off\n");
 287                                 _aspeco = strcat(_aspeco, "^3 all ^7(short ^5aa^7) to turn everything on/off\n");
 288                                 superspec_msg("^2Available Auto Spectate ^3options:\n\n\n", "\n^2Available Auto Spectate ^3options:\n", player, _aspeco, 1);
 289                                 return true;
 290                         }
 291
 292                         float i, _bits = 0, _start = 1;
 293                         if(argv(1) == "clear")
 294                         {
 295                                 player.autospec_flags = 0;
 296                                 _start = 2;
 297                         }
 298
 299                         for(i = _start; i < cmd_argc; ++i)
 300                         {
 301                                 if(argv(i) == "on" || argv(i) == "1")
 302                                 {
 303                                         player.autospec_flags |= _bits;
 304                                         _bits = 0;
 305                                 }
 306                                 else if(argv(i) == "off" || argv(i) == "0")
 307                                 {
 308                                         if(_start == 1)
 309                                                 player.autospec_flags &= ~_bits;
 310
 311                                         _bits = 0;
 312                                 }
 313                                 else
 314                                 {
 315                                         if((argv(i) == "strength") || (argv(i) == "st")) _bits |= ASF_STRENGTH;
 316                                         if((argv(i) == "shield") || (argv(i) == "sh")) _bits |= ASF_SHIELD;
 317                                         if((argv(i) == "mega_health") || (argv(i) == "mh")) _bits |= ASF_MEGA_HP;
 318                                         if((argv(i) == "mega_armor") || (argv(i) == "ma")) _bits |= ASF_MEGA_AR;
 319                                         if((argv(i) == "flag_grab") || (argv(i) == "fg")) _bits |= ASF_FLAG_GRAB;
 320                                         if((argv(i) == "observer_only") || (argv(i) == "oo")) _bits |= ASF_OBSERVER_ONLY;
 321                                         if((argv(i) == "show_what") || (argv(i) == "sw")) _bits |= ASF_SHOWWHAT;
 322                                         if((argv(i) == "item_msg") || (argv(i) == "im")) _bits |= ASF_SSIM;
 323                                         if((argv(i) == "followkiller") || (argv(i) == "fk")) _bits |= ASF_FOLLOWKILLER;
 324                                         if((argv(i) == "all") || (argv(i) == "aa")) _bits |= ASF_ALL;
 325                                 }
 326                         }
 327                 }
 328
 329                 _aspeco = "";
 330                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_STRENGTH, "Strength", "strength", "st");
 331                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_SHIELD, "Shield", "shield", "sh");
 332                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_MEGA_HP, "Mega Health", "mega_health", "mh");
 333                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_MEGA_AR, "Mega Armor", "mega_armor", "ma");
 334                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_FLAG_GRAB, "Flag grab", "flag_grab","fg");
 335                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_OBSERVER_ONLY, "Only switch if observer", "observer_only", "oo");
 336                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_SHOWWHAT, "Show what item triggered spectate", "show_what", "sw");
 337                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_SSIM, "Switch on superspec item message", "item_msg", "im");
 338                 OPTIONINFO(player.autospec_flags, _aspeco, ASF_FOLLOWKILLER, "Followkiller", "followkiller", "fk");
 339
 340                 superspec_msg("^3Current auto spectate options are:\n\n\n\n\n", "\n^3Current auto spectate options are:\n", player, _aspeco, 1);
 341                 return true;
 342         }
 343
 344         if(cmd_name == "followpowerup")
 345         {
 346                 FOREACH_CLIENT(IS_PLAYER(it) && (it.strength_finished > time || it.invincible_finished > time), LAMBDA(return superspec_Spectate(it)));
 347
 348                 superspec_msg("", "", player, "No active powerup\n", 1);
 349                 return true;
 350         }
 351
 352         if(cmd_name == "followstrength")
 353         {
 354                 FOREACH_CLIENT(IS_PLAYER(it) && it.strength_finished > time, LAMBDA(return superspec_Spectate(it)));
 355
 356                 superspec_msg("", "", player, "No active Strength\n", 1);
 357                 return true;
 358         }
 359
 360         if(cmd_name == "followshield")
 361         {
 362                 FOREACH_CLIENT(IS_PLAYER(it) && it.invincible_finished > time, LAMBDA(return superspec_Spectate(it)));
 363
 364                 superspec_msg("", "", player, "No active Shield\n", 1);
 365                 return true;
 366         }
 367
 368         return false;
 369 #undef OPTIONINFO
 370 }
 371
 372 MUTATOR_HOOKFUNCTION(superspec, BuildMutatorsString)
 373 {
 374         ret_string = strcat(ret_string, ":SS");
 375         return 0;
 376 }
 377
 378 MUTATOR_HOOKFUNCTION(superspec, BuildMutatorsPrettyString)
 379 {
 380         ret_string = strcat(ret_string, ", Super Spectators");
 381         return 0;
 382 }
 383
 384 void superspec_hello(entity this)
 385 {
 386         if(self.enemy.crypto_idfp == "")
 387                 Send_Notification(NOTIF_ONE_ONLY, self.enemy, MSG_INFO, INFO_SUPERSPEC_MISSING_UID);
 388
 389         remove(self);
 390 }
 391
 392 MUTATOR_HOOKFUNCTION(superspec, ClientConnect)
 393 {SELFPARAM();
 394         if(!IS_REAL_CLIENT(self))
 395                 return false;
 396
 397         string fn = "superspec-local.options";
 398         float fh;
 399
 400         self.superspec_flags = SSF_VERBOSE;
 401         self.superspec_itemfilter = "";
 402
 403         entity _hello = spawn();
 404         _hello.enemy = self;
 405         setthink(_hello, superspec_hello);
 406         _hello.nextthink = time + 5;
 407
 408         if (!_ISLOCAL)
 409         {
 410                 if(self.crypto_idfp == "")
 411                         return false;
 412
 413                 fn = sprintf("superspec-%s.options", uri_escape(self.crypto_idfp));
 414         }
 415
 416         fh = fopen(fn, FILE_READ);
 417         if(fh < 0)
 418         {
 419                 LOG_TRACE("^1ERROR: ^7 superspec can not open ", fn, " for reading.\n");
 420         }
 421         else
 422         {
 423                 string _magic = fgets(fh);
 424                 if(_magic != _SSMAGIX)
 425                 {
 426                         LOG_TRACE("^1ERROR^7 While reading superspec options file: unknown magic\n");
 427                 }
 428                 else
 429                 {
 430                         self.autospec_flags = stof(fgets(fh));
 431                         self.superspec_flags = stof(fgets(fh));
 432                         self.superspec_itemfilter = strzone(fgets(fh));
 433                 }
 434                 fclose(fh);
 435         }
 436
 437         return false;
 438 }
 439
 440 MUTATOR_HOOKFUNCTION(superspec, PlayerDies)
 441 {
 442         entity frag_attacker = M_ARGV(1, entity);
 443         entity frag_target = M_ARGV(2, entity);
 444
 445         FOREACH_CLIENT(IS_SPEC(it), LAMBDA(
 446                 if(it.autospec_flags & ASF_FOLLOWKILLER && IS_PLAYER(frag_attacker) && it.enemy == frag_target)
 447                 {
 448                         if(it.autospec_flags & ASF_SHOWWHAT)
 449                                 superspec_msg("", "", it, sprintf("^7Following %s^7 due to followkiller\n", frag_attacker.netname), 2);
 450
 451                         WITHSELF(it, superspec_Spectate(frag_attacker));
 452                 }
 453         ));
 454
 455         return false;
 456 }
 457
 458 MUTATOR_HOOKFUNCTION(superspec, ClientDisconnect)
 459 {
 460         superspec_save_client_conf();
 461         return false;
 462 }
 463 #endif