qcsrc/server/g_hook.qc

   1 #include "g_hook.qh"
   2
   3 #include <server/defs.qh>
   4 #include <server/miscfunctions.qh>
   5 #include <common/effects/all.qh>
   6 #include "weapons/common.qh"
   7 #include "weapons/csqcprojectile.qh"
   8 #include "weapons/weaponsystem.qh"
   9 #include "weapons/selection.qh"
  10 #include "weapons/tracing.qh"
  11 #include "player.qh"
  12 #include "command/common.qh"
  13 #include "round_handler.qh"
  14 #include "../common/state.qh"
  15 #include "../common/physics/player.qh"
  16 #include "../common/vehicles/all.qh"
  17 #include "../common/constants.qh"
  18 #include "../common/util.qh"
  19 #include <common/net_linked.qh>
  20 #include <common/weapons/_all.qh>
  21 #include "../lib/warpzone/common.qh"
  22 #include "../lib/warpzone/server.qh"
  23
  24 .int state;
  25
  26 /*============================================
  27
  28       Wazat's Xonotic Grappling Hook
  29
  30         Contact: Wazat1@gmail.com
  31
  32
  33 Installation instructions:
  34 --------------------------
  35
  36 1. Place hook.c in your gamec source directory with the other source files.
  37
  38 2. Add this line to the bottom of progs.src:
  39
  40 gamec/hook.c
  41
  42 3. Open defs.h and add these lines to the very bottom:
  43
  44 // Wazat's grappling hook
  45 .entity         hook;
  46 void GrapplingHookFrame();
  47 void RemoveGrapplingHook(entity pl);
  48 void SetGrappleHookBindings();
  49 // hook impulses
  50 const float GRAPHOOK_FIRE               = 20;
  51 const float GRAPHOOK_RELEASE            = 21;
  52 // (note: you can change the hook impulse #'s to whatever you please)
  53
  54 4. Open client.c and add this to the top of PutClientInServer():
  55
  56         RemoveGrapplingHook(this); // Wazat's Grappling Hook
  57
  58 5. Find ClientConnect() (in client.c) and add these lines to the bottom:
  59
  60         // Wazat's grappling hook
  61         SetGrappleHookBindings();
  62
  63 6. Still in client.c, find PlayerPreThink and add this line just above the call to W_WeaponFrame:
  64
  65         GrapplingHookFrame();
  66
  67 7. Build and test the mod.  You'll want to bind a key to "+hook" like this:
  68 bind ctrl "+hook"
  69
  70 And you should be done!
  71
  72
  73 ============================================*/
  74
  75 .float hook_length;
  76
  77 void RemoveGrapplingHooks(entity pl)
  78 {
  79         if(pl.move_movetype == MOVETYPE_FLY)
  80                 set_movetype(pl, MOVETYPE_WALK);
  81
  82         for(int slot = 0; slot < MAX_WEAPONSLOTS; ++slot)
  83     {
  84         .entity weaponentity = weaponentities[slot];
  85         if(!pl.(weaponentity))
  86                 continue; // continue incase other slots exist?
  87         if(pl.(weaponentity).hook)
  88                 delete(pl.(weaponentity).hook);
  89         pl.(weaponentity).hook = NULL;
  90     }
  91
  92         //pl.disableclientprediction = false;
  93 }
  94
  95 void RemoveHook(entity this)
  96 {
  97         entity player = this.realowner;
  98     .entity weaponentity = this.weaponentity_fld;
  99
 100     if(player.(weaponentity).hook == this)
 101         player.(weaponentity).hook = NULL;
 102
 103     if(player.move_movetype == MOVETYPE_FLY)
 104         set_movetype(player, MOVETYPE_WALK);
 105     delete(this);
 106 }
 107
 108 void GrapplingHookReset(entity this)
 109 {
 110         RemoveHook(this);
 111 }
 112
 113 void GrapplingHook_Stop(entity this)
 114 {
 115         Send_Effect(EFFECT_HOOK_IMPACT, this.origin, '0 0 0', 1);
 116         sound (this, CH_SHOTS, SND_HOOK_IMPACT, VOL_BASE, ATTEN_NORM);
 117
 118         this.state = 1;
 119         setthink(this, GrapplingHookThink);
 120         this.nextthink = time;
 121         settouch(this, func_null);
 122         this.velocity = '0 0 0';
 123         set_movetype(this, MOVETYPE_NONE);
 124         this.hook_length = -1;
 125 }
 126
 127 .vector hook_start, hook_end;
 128 bool GrapplingHookSend(entity this, entity to, int sf)
 129 {
 130         WriteHeader(MSG_ENTITY, ENT_CLIENT_HOOK);
 131         sf = sf & 0x7F;
 132         if(sound_allowed(MSG_BROADCAST, this.realowner))
 133                 sf |= 0x80;
 134         WriteByte(MSG_ENTITY, sf);
 135         if(sf & 1)
 136         {
 137                 WriteByte(MSG_ENTITY, etof(this.realowner));
 138                 WriteByte(MSG_ENTITY, weaponslot(this.weaponentity_fld));
 139         }
 140         if(sf & 2)
 141         {
 142                 WriteVector(MSG_ENTITY, this.hook_start);
 143         }
 144         if(sf & 4)
 145         {
 146                 WriteVector(MSG_ENTITY, this.hook_end);
 147         }
 148         return true;
 149 }
 150
 151 int autocvar_g_grappling_hook_tarzan;
 152
 153 void GrapplingHookThink(entity this)
 154 {
 155         float spd, dist, minlength, pullspeed, ropestretch, ropeairfriction, rubberforce, newlength, rubberforce_overstretch;
 156         vector dir, org, end, v0, dv, v, myorg, vs;
 157         .entity weaponentity = this.weaponentity_fld;
 158         if(this.realowner.(weaponentity).hook != this)  // how did that happen?
 159         {
 160                 error("Owner lost the hook!\n");
 161                 return;
 162         }
 163         if(LostMovetypeFollow(this) || game_stopped || (round_handler_IsActive() && !round_handler_IsRoundStarted()) || ((this.aiment.flags & FL_PROJECTILE) && this.aiment.classname != "nade"))
 164         {
 165                 RemoveHook(this);
 166                 return;
 167         }
 168         if(this.aiment)
 169                 WarpZone_RefSys_AddIncrementally(this, this.aiment);
 170
 171         this.nextthink = time;
 172
 173         int s = W_GunAlign(this.realowner.(weaponentity), STAT(GUNALIGN, this.realowner)) - 1;
 174         vs = hook_shotorigin[s];
 175
 176         makevectors(this.realowner.v_angle);
 177         org = this.realowner.origin + this.realowner.view_ofs + v_forward * vs.x + v_right * -vs.y + v_up * vs.z;
 178         myorg = WarpZone_RefSys_TransformOrigin(this.realowner, this, org);
 179
 180         if(this.hook_length < 0)
 181                 this.hook_length = vlen(myorg - this.origin);
 182
 183         int tarzan = autocvar_g_grappling_hook_tarzan;
 184         entity pull_entity = this.realowner;
 185         float velocity_multiplier = 1;
 186         MUTATOR_CALLHOOK(GrappleHookThink, this, tarzan, pull_entity, velocity_multiplier);
 187         tarzan = M_ARGV(1, int);
 188         pull_entity = M_ARGV(2, entity);
 189         velocity_multiplier = M_ARGV(3, float);
 190
 191         if(this.state == 1)
 192         {
 193                 pullspeed = autocvar_g_balance_grapplehook_speed_pull;//2000;
 194                 // speed the rope is pulled with
 195
 196                 rubberforce = autocvar_g_balance_grapplehook_force_rubber;//2000;
 197                 // force the rope will use if it is stretched
 198
 199                 rubberforce_overstretch = autocvar_g_balance_grapplehook_force_rubber_overstretch;//1000;
 200                 // force the rope will use if it is stretched
 201
 202                 minlength = autocvar_g_balance_grapplehook_length_min;//100;
 203                 // minimal rope length
 204                 // if the rope goes below this length, it isn't pulled any more
 205
 206                 ropestretch = autocvar_g_balance_grapplehook_stretch;//400;
 207                 // if the rope is stretched by more than this amount, more rope is
 208                 // given to you again
 209
 210                 ropeairfriction = autocvar_g_balance_grapplehook_airfriction;//0.2
 211                 // while hanging on the rope, this friction component will help you a
 212                 // bit to control the rope
 213
 214                 bool frozen_pulling = (autocvar_g_grappling_hook_tarzan >= 2 && autocvar_g_balance_grapplehook_pull_frozen);
 215
 216                 dir = this.origin - myorg;
 217                 dist = vlen(dir);
 218                 dir = normalize(dir);
 219
 220                 if(tarzan)
 221                 {
 222                         v = v0 = WarpZone_RefSys_TransformVelocity(pull_entity, this, pull_entity.velocity);
 223
 224                         // first pull the rope...
 225                         if(this.realowner.(weaponentity).hook_state & HOOK_PULLING)
 226                         {
 227                                 newlength = this.hook_length;
 228                                 newlength = max(newlength - pullspeed * frametime, minlength);
 229
 230                                 if(newlength < dist - ropestretch) // overstretched?
 231                                 {
 232                                         newlength = dist - ropestretch;
 233                                         if(v * dir < 0) // only if not already moving in hook direction
 234                                                 v = v + frametime * dir * rubberforce_overstretch;
 235                                 }
 236
 237                                 this.hook_length = newlength;
 238                         }
 239
 240                         if(pull_entity.move_movetype == MOVETYPE_FLY)
 241                                 set_movetype(pull_entity, MOVETYPE_WALK);
 242
 243                         if(this.realowner.(weaponentity).hook_state & HOOK_RELEASING)
 244                         {
 245                                 newlength = dist;
 246                                 this.hook_length = newlength;
 247                         }
 248                         else
 249                         {
 250                                 // then pull the player
 251                                 spd = bound(0, (dist - this.hook_length) / ropestretch, 1);
 252                                 v = v * (1 - frametime * ropeairfriction);
 253                                 v = v + frametime * dir * spd * rubberforce;
 254
 255                                 dv = ((v - v0) * dir) * dir;
 256                                 if(tarzan >= 2)
 257                                 {
 258                                         if(this.aiment.move_movetype == MOVETYPE_WALK || this.aiment.classname == "nade")
 259                                         {
 260                                                 entity aim_ent = ((IS_VEHICLE(this.aiment) && this.aiment.owner) ? this.aiment.owner : this.aiment);
 261                                                 v = v - dv * 0.5;
 262                                                 if((frozen_pulling && STAT(FROZEN, this.aiment)) || !frozen_pulling)
 263                                                 {
 264                                                         this.aiment.velocity = this.aiment.velocity - dv * 0.5;
 265                                                         UNSET_ONGROUND(this.aiment);
 266                                                         if(this.aiment.flags & FL_PROJECTILE)
 267                                                                 UpdateCSQCProjectile(this.aiment);
 268                                                 }
 269                                                 if(this.aiment.classname == "nade")
 270                                                         this.aiment.nextthink = time + autocvar_g_balance_grapplehook_nade_time; // set time after letting go?
 271                                                 aim_ent.pusher = this.realowner;
 272                                                 aim_ent.pushltime = time + autocvar_g_maxpushtime;
 273                                                 aim_ent.istypefrag = PHYS_INPUT_BUTTON_CHAT(aim_ent);
 274                                         }
 275                                 }
 276
 277                                 UNSET_ONGROUND(pull_entity);
 278                         }
 279
 280                         if(!frozen_pulling && !(this.aiment.flags & FL_PROJECTILE))
 281                                 pull_entity.velocity = WarpZone_RefSys_TransformVelocity(this, pull_entity, v * velocity_multiplier);
 282
 283                         if(frozen_pulling && autocvar_g_balance_grapplehook_pull_frozen == 2 && !STAT(FROZEN, this.aiment))
 284                         {
 285                                 RemoveHook(this);
 286                                 return;
 287                         }
 288                 }
 289                 else
 290                 {
 291                         end = this.origin - dir*50;
 292                         dist = vlen(end - myorg);
 293                         if(dist < 200)
 294                                 spd = dist * (pullspeed / 200);
 295                         else
 296                                 spd = pullspeed;
 297                         if(spd < 50)
 298                                 spd = 0;
 299                         this.realowner.velocity = dir*spd;
 300                         set_movetype(this.realowner, MOVETYPE_FLY);
 301
 302                         UNSET_ONGROUND(this.realowner);
 303                 }
 304         }
 305
 306         makevectors(this.angles.x * '-1 0 0' + this.angles.y * '0 1 0');
 307         myorg = WarpZone_RefSys_TransformOrigin(this, this.realowner, this.origin); // + v_forward * (-9);
 308
 309         if(myorg != this.hook_start)
 310         {
 311                 this.SendFlags |= 2;
 312                 this.hook_start = myorg;
 313         }
 314         if(org != this.hook_end)
 315         {
 316                 this.SendFlags |= 4;
 317                 this.hook_end = org;
 318         }
 319 }
 320
 321 void GrapplingHookTouch(entity this, entity toucher)
 322 {
 323         if(toucher.move_movetype == MOVETYPE_FOLLOW)
 324                 return;
 325         PROJECTILE_TOUCH(this, toucher);
 326
 327         GrapplingHook_Stop(this);
 328
 329         if(toucher)
 330                 //if(toucher.move_movetype != MOVETYPE_NONE)
 331                 {
 332                         SetMovetypeFollow(this, toucher);
 333                         WarpZone_RefSys_BeginAddingIncrementally(this, this.aiment);
 334                 }
 335
 336         //this.realowner.disableclientprediction = true;
 337 }
 338
 339 void GrapplingHook_Damage(entity this, entity inflictor, entity attacker, float damage, int deathtype, .entity weaponentity, vector hitloc, vector force)
 340 {
 341         if(GetResourceAmount(this, RES_HEALTH) <= 0)
 342                 return;
 343
 344         if (!W_CheckProjectileDamage(inflictor.realowner, this.realowner, deathtype, -1)) // no exceptions
 345                 return; // g_balance_projectiledamage says to halt
 346
 347         TakeResource(this, RES_HEALTH, damage);
 348
 349         if (GetResourceAmount(this, RES_HEALTH) <= 0)
 350         {
 351                 if(attacker != this.realowner)
 352                 {
 353                         this.realowner.pusher = attacker;
 354                         this.realowner.pushltime = time + autocvar_g_maxpushtime;
 355                         this.realowner.istypefrag = PHYS_INPUT_BUTTON_CHAT(this.realowner);
 356                 }
 357                 RemoveHook(this);
 358         }
 359 }
 360
 361 void FireGrapplingHook(entity actor, .entity weaponentity)
 362 {
 363         if(forbidWeaponUse(actor)) return;
 364         if(actor.vehicle) return;
 365
 366         // TODO: offhand hook shoots from eye
 367         W_SetupShot_ProjectileSize(actor, weaponentity, '-3 -3 -3', '3 3 3', true, 0, SND_HOOK_FIRE, CH_WEAPON_B, 0, WEP_HOOK.m_id);
 368         Send_Effect(EFFECT_HOOK_MUZZLEFLASH, w_shotorg, '0 0 0', 1);
 369
 370         entity missile = WarpZone_RefSys_SpawnSameRefSys(actor);
 371         missile.owner = missile.realowner = actor;
 372         actor.(weaponentity).hook = missile;
 373         missile.weaponentity_fld = weaponentity;
 374         missile.reset = GrapplingHookReset;
 375         missile.classname = "grapplinghook";
 376         missile.flags = FL_PROJECTILE;
 377         IL_PUSH(g_projectiles, missile);
 378         IL_PUSH(g_bot_dodge, missile);
 379
 380         set_movetype(missile, ((autocvar_g_balance_grapplehook_gravity) ? MOVETYPE_TOSS : MOVETYPE_FLY));
 381         PROJECTILE_MAKETRIGGER(missile);
 382
 383         //setmodel (missile, MDL_HOOK); // precision set below
 384         setsize (missile, '-3 -3 -3', '3 3 3');
 385         setorigin(missile, w_shotorg);
 386
 387         missile.state = 0; // not latched onto anything
 388
 389         W_SetupProjVelocity_Explicit(missile, w_shotdir, v_up, autocvar_g_balance_grapplehook_speed_fly, 0, 0, 0, false);
 390
 391         missile.angles = vectoangles (missile.velocity);
 392         //missile.glow_color = 250; // 244, 250
 393         //missile.glow_size = 120;
 394         settouch(missile, GrapplingHookTouch);
 395         setthink(missile, GrapplingHookThink);
 396         missile.nextthink = time;
 397
 398         missile.effects = /*EF_FULLBRIGHT | EF_ADDITIVE |*/ EF_LOWPRECISION;
 399
 400         SetResourceAmount(missile, RES_HEALTH, autocvar_g_balance_grapplehook_health);
 401         missile.event_damage = GrapplingHook_Damage;
 402         missile.takedamage = DAMAGE_AIM;
 403         missile.damageforcescale = 0;
 404         missile.damagedbycontents = (autocvar_g_balance_grapplehook_damagedbycontents);
 405         if(missile.damagedbycontents)
 406                 IL_PUSH(g_damagedbycontents, missile);
 407
 408         missile.hook_start = missile.hook_end = missile.origin;
 409
 410         Net_LinkEntity(missile, false, 0, GrapplingHookSend);
 411 }
 412
 413 void GrappleHookInit()
 414 {
 415         if(g_grappling_hook)
 416         {
 417                 hook_shotorigin[0] = '8 8 -12';
 418                 hook_shotorigin[1] = '8 8 -12';
 419                 hook_shotorigin[2] = '8 8 -12';
 420                 hook_shotorigin[3] = '8 8 -12';
 421         }
 422         else
 423         {
 424                 Weapon w = WEP_HOOK;
 425                 w.wr_init(w);
 426                 hook_shotorigin[0] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 1);
 427                 hook_shotorigin[1] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 2);
 428                 hook_shotorigin[2] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 3);
 429                 hook_shotorigin[3] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 4);
 430         }
 431 }