3 #include "weapons/common.qh"
4 #include "weapons/csqcprojectile.qh"
5 #include "weapons/weaponsystem.qh"
6 #include "weapons/selection.qh"
7 #include "weapons/tracing.qh"
9 #include "command/common.qh"
10 #include "round_handler.qh"
11 #include "../common/state.qh"
12 #include "../common/physics/player.qh"
13 #include "../common/vehicles/all.qh"
14 #include "../common/constants.qh"
15 #include "../common/util.qh"
16 #include <common/net_linked.qh>
17 #include <common/weapons/_all.qh>
18 #include "../lib/warpzone/common.qh"
19 #include "../lib/warpzone/server.qh"
23 /*============================================
25 Wazat's Xonotic Grappling Hook
27 Contact: Wazat1@gmail.com
30 Installation instructions:
31 --------------------------
33 1. Place hook.c in your gamec source directory with the other source files.
35 2. Add this line to the bottom of progs.src:
39 3. Open defs.h and add these lines to the very bottom:
41 // Wazat's grappling hook
43 void GrapplingHookFrame();
44 void RemoveGrapplingHook(entity pl);
45 void SetGrappleHookBindings();
47 const float GRAPHOOK_FIRE = 20;
48 const float GRAPHOOK_RELEASE = 21;
49 // (note: you can change the hook impulse #'s to whatever you please)
51 4. Open client.c and add this to the top of PutClientInServer():
53 RemoveGrapplingHook(this); // Wazat's Grappling Hook
55 5. Find ClientConnect() (in client.c) and add these lines to the bottom:
57 // Wazat's grappling hook
58 SetGrappleHookBindings();
60 6. Still in client.c, find PlayerPreThink and add this line just above the call to W_WeaponFrame:
64 7. Build and test the mod. You'll want to bind a key to "+hook" like this:
67 And you should be done!
70 ============================================*/
74 void RemoveGrapplingHooks(entity pl)
76 if(pl.move_movetype == MOVETYPE_FLY)
77 set_movetype(pl, MOVETYPE_WALK);
79 for(int slot = 0; slot < MAX_WEAPONSLOTS; ++slot)
81 .entity weaponentity = weaponentities[slot];
82 if(!pl.(weaponentity))
83 continue; // continue incase other slots exist?
84 if(pl.(weaponentity).hook)
85 delete(pl.(weaponentity).hook);
86 pl.(weaponentity).hook = NULL;
89 //pl.disableclientprediction = false;
92 void RemoveHook(entity this)
94 entity player = this.realowner;
95 .entity weaponentity = this.weaponentity_fld;
97 if(player.(weaponentity).hook == this)
98 player.(weaponentity).hook = NULL;
100 if(player.move_movetype == MOVETYPE_FLY)
101 set_movetype(player, MOVETYPE_WALK);
105 void GrapplingHookReset(entity this)
110 void GrapplingHookThink(entity this);
111 void GrapplingHook_Stop(entity this)
113 Send_Effect(EFFECT_HOOK_IMPACT, this.origin, '0 0 0', 1);
114 sound (this, CH_SHOTS, SND_HOOK_IMPACT, VOL_BASE, ATTEN_NORM);
117 setthink(this, GrapplingHookThink);
118 this.nextthink = time;
119 settouch(this, func_null);
120 this.velocity = '0 0 0';
121 set_movetype(this, MOVETYPE_NONE);
122 this.hook_length = -1;
125 .vector hook_start, hook_end;
126 bool GrapplingHookSend(entity this, entity to, int sf)
128 WriteHeader(MSG_ENTITY, ENT_CLIENT_HOOK);
130 if(sound_allowed(MSG_BROADCAST, this.realowner))
132 WriteByte(MSG_ENTITY, sf);
135 WriteByte(MSG_ENTITY, etof(this.realowner));
136 WriteByte(MSG_ENTITY, weaponslot(this.weaponentity_fld));
140 WriteCoord(MSG_ENTITY, this.hook_start.x);
141 WriteCoord(MSG_ENTITY, this.hook_start.y);
142 WriteCoord(MSG_ENTITY, this.hook_start.z);
146 WriteCoord(MSG_ENTITY, this.hook_end.x);
147 WriteCoord(MSG_ENTITY, this.hook_end.y);
148 WriteCoord(MSG_ENTITY, this.hook_end.z);
153 int autocvar_g_grappling_hook_tarzan;
155 void GrapplingHookThink(entity this)
157 float spd, dist, minlength, pullspeed, ropestretch, ropeairfriction, rubberforce, newlength, rubberforce_overstretch;
158 vector dir, org, end, v0, dv, v, myorg, vs;
159 .entity weaponentity = this.weaponentity_fld;
160 if(this.realowner.(weaponentity).hook != this) // how did that happen?
162 error("Owner lost the hook!\n");
165 if(LostMovetypeFollow(this) || game_stopped || (round_handler_IsActive() && !round_handler_IsRoundStarted()) || ((this.aiment.flags & FL_PROJECTILE) && this.aiment.classname != "nade"))
171 WarpZone_RefSys_AddIncrementally(this, this.aiment);
173 this.nextthink = time;
175 int s = W_GunAlign(this.realowner.(weaponentity), STAT(GUNALIGN, this.realowner)) - 1;
176 vs = hook_shotorigin[s];
178 makevectors(this.realowner.v_angle);
179 org = this.realowner.origin + this.realowner.view_ofs + v_forward * vs.x + v_right * -vs.y + v_up * vs.z;
180 myorg = WarpZone_RefSys_TransformOrigin(this.realowner, this, org);
182 if(this.hook_length < 0)
183 this.hook_length = vlen(myorg - this.origin);
185 int tarzan = autocvar_g_grappling_hook_tarzan;
186 entity pull_entity = this.realowner;
187 float velocity_multiplier = 1;
188 MUTATOR_CALLHOOK(GrappleHookThink, this, tarzan, pull_entity, velocity_multiplier);
189 tarzan = M_ARGV(1, int);
190 pull_entity = M_ARGV(2, entity);
191 velocity_multiplier = M_ARGV(3, float);
195 pullspeed = autocvar_g_balance_grapplehook_speed_pull;//2000;
196 // speed the rope is pulled with
198 rubberforce = autocvar_g_balance_grapplehook_force_rubber;//2000;
199 // force the rope will use if it is stretched
201 rubberforce_overstretch = autocvar_g_balance_grapplehook_force_rubber_overstretch;//1000;
202 // force the rope will use if it is stretched
204 minlength = autocvar_g_balance_grapplehook_length_min;//100;
205 // minimal rope length
206 // if the rope goes below this length, it isn't pulled any more
208 ropestretch = autocvar_g_balance_grapplehook_stretch;//400;
209 // if the rope is stretched by more than this amount, more rope is
210 // given to you again
212 ropeairfriction = autocvar_g_balance_grapplehook_airfriction;//0.2
213 // while hanging on the rope, this friction component will help you a
214 // bit to control the rope
216 bool frozen_pulling = (autocvar_g_grappling_hook_tarzan >= 2 && autocvar_g_balance_grapplehook_pull_frozen);
218 dir = this.origin - myorg;
220 dir = normalize(dir);
224 v = v0 = WarpZone_RefSys_TransformVelocity(pull_entity, this, pull_entity.velocity);
226 // first pull the rope...
227 if(this.realowner.(weaponentity).hook_state & HOOK_PULLING)
229 newlength = this.hook_length;
230 newlength = max(newlength - pullspeed * frametime, minlength);
232 if(newlength < dist - ropestretch) // overstretched?
234 newlength = dist - ropestretch;
235 if(v * dir < 0) // only if not already moving in hook direction
236 v = v + frametime * dir * rubberforce_overstretch;
239 this.hook_length = newlength;
242 if(pull_entity.move_movetype == MOVETYPE_FLY)
243 set_movetype(pull_entity, MOVETYPE_WALK);
245 if(this.realowner.(weaponentity).hook_state & HOOK_RELEASING)
248 this.hook_length = newlength;
252 // then pull the player
253 spd = bound(0, (dist - this.hook_length) / ropestretch, 1);
254 v = v * (1 - frametime * ropeairfriction);
255 v = v + frametime * dir * spd * rubberforce;
257 dv = ((v - v0) * dir) * dir;
260 if(this.aiment.move_movetype == MOVETYPE_WALK || this.aiment.classname == "nade")
262 entity aim_ent = ((IS_VEHICLE(this.aiment) && this.aiment.owner) ? this.aiment.owner : this.aiment);
264 if((frozen_pulling && STAT(FROZEN, this.aiment)) || !frozen_pulling)
266 this.aiment.velocity = this.aiment.velocity - dv * 0.5;
267 UNSET_ONGROUND(this.aiment);
268 if(this.aiment.flags & FL_PROJECTILE)
269 UpdateCSQCProjectile(this.aiment);
271 if(this.aiment.classname == "nade")
272 this.aiment.nextthink = time + autocvar_g_balance_grapplehook_nade_time; // set time after letting go?
273 aim_ent.pusher = this.realowner;
274 aim_ent.pushltime = time + autocvar_g_maxpushtime;
275 aim_ent.istypefrag = PHYS_INPUT_BUTTON_CHAT(aim_ent);
279 UNSET_ONGROUND(pull_entity);
282 if(!frozen_pulling && !(this.aiment.flags & FL_PROJECTILE))
283 pull_entity.velocity = WarpZone_RefSys_TransformVelocity(this, pull_entity, v * velocity_multiplier);
285 if(frozen_pulling && autocvar_g_balance_grapplehook_pull_frozen == 2 && !STAT(FROZEN, this.aiment))
293 end = this.origin - dir*50;
294 dist = vlen(end - myorg);
296 spd = dist * (pullspeed / 200);
301 this.realowner.velocity = dir*spd;
302 set_movetype(this.realowner, MOVETYPE_FLY);
304 UNSET_ONGROUND(this.realowner);
308 makevectors(this.angles.x * '-1 0 0' + this.angles.y * '0 1 0');
309 myorg = WarpZone_RefSys_TransformOrigin(this, this.realowner, this.origin); // + v_forward * (-9);
311 if(myorg != this.hook_start)
314 this.hook_start = myorg;
316 if(org != this.hook_end)
323 void GrapplingHookTouch(entity this, entity toucher)
325 if(toucher.move_movetype == MOVETYPE_FOLLOW)
327 PROJECTILE_TOUCH(this, toucher);
329 GrapplingHook_Stop(this);
332 if(toucher.move_movetype != MOVETYPE_NONE)
334 SetMovetypeFollow(this, toucher);
335 WarpZone_RefSys_BeginAddingIncrementally(this, this.aiment);
338 //this.realowner.disableclientprediction = true;
341 void GrapplingHook_Damage(entity this, entity inflictor, entity attacker, float damage, int deathtype, vector hitloc, vector force)
346 if (!W_CheckProjectileDamage(inflictor.realowner, this.realowner, deathtype, -1)) // no exceptions
347 return; // g_balance_projectiledamage says to halt
349 this.health = this.health - damage;
351 if (this.health <= 0)
353 if(attacker != this.realowner)
355 this.realowner.pusher = attacker;
356 this.realowner.pushltime = time + autocvar_g_maxpushtime;
357 this.realowner.istypefrag = PHYS_INPUT_BUTTON_CHAT(this.realowner);
363 void FireGrapplingHook(entity actor, .entity weaponentity)
365 if(forbidWeaponUse(actor)) return;
366 if(actor.vehicle) return;
368 makevectors(actor.v_angle);
370 int s = W_GunAlign(actor.(weaponentity), STAT(GUNALIGN, actor)) - 1;
371 vector vs = hook_shotorigin[s];
373 // UGLY WORKAROUND: play this on CH_WEAPON_B so it can't cut off fire sounds
374 sound (actor, CH_WEAPON_B, SND_HOOK_FIRE, VOL_BASE, ATTEN_NORM);
375 vector org = actor.origin + actor.view_ofs + v_forward * vs.x + v_right * -vs.y + v_up * vs.z;
377 tracebox(actor.origin + actor.view_ofs, '-3 -3 -3', '3 3 3', org, MOVE_NORMAL, actor);
380 Send_Effect(EFFECT_HOOK_MUZZLEFLASH, org, '0 0 0', 1);
382 entity missile = WarpZone_RefSys_SpawnSameRefSys(actor);
383 missile.owner = missile.realowner = actor;
384 actor.(weaponentity).hook = missile;
385 missile.weaponentity_fld = weaponentity;
386 missile.reset = GrapplingHookReset;
387 missile.classname = "grapplinghook";
388 missile.flags = FL_PROJECTILE;
389 IL_PUSH(g_projectiles, missile);
390 IL_PUSH(g_bot_dodge, missile);
392 set_movetype(missile, ((autocvar_g_balance_grapplehook_gravity) ? MOVETYPE_TOSS : MOVETYPE_FLY));
393 PROJECTILE_MAKETRIGGER(missile);
395 //setmodel (missile, MDL_HOOK); // precision set below
396 setsize (missile, '-3 -3 -3', '3 3 3');
397 setorigin(missile, org);
399 missile.state = 0; // not latched onto anything
401 W_SetupProjVelocity_Explicit(missile, v_forward, v_up, autocvar_g_balance_grapplehook_speed_fly, 0, 0, 0, false);
403 missile.angles = vectoangles (missile.velocity);
404 //missile.glow_color = 250; // 244, 250
405 //missile.glow_size = 120;
406 settouch(missile, GrapplingHookTouch);
407 setthink(missile, GrapplingHookThink);
408 missile.nextthink = time;
410 missile.effects = /*EF_FULLBRIGHT | EF_ADDITIVE |*/ EF_LOWPRECISION;
412 missile.health = autocvar_g_balance_grapplehook_health;//120
413 missile.event_damage = GrapplingHook_Damage;
414 missile.takedamage = DAMAGE_AIM;
415 missile.damageforcescale = 0;
416 missile.damagedbycontents = (autocvar_g_balance_grapplehook_damagedbycontents);
417 if(missile.damagedbycontents)
418 IL_PUSH(g_damagedbycontents, missile);
420 missile.hook_start = missile.hook_end = missile.origin;
422 Net_LinkEntity(missile, false, 0, GrapplingHookSend);
425 void GrappleHookInit()
429 hook_shotorigin[0] = '8 8 -12';
430 hook_shotorigin[1] = '8 8 -12';
431 hook_shotorigin[2] = '8 8 -12';
432 hook_shotorigin[3] = '8 8 -12';
438 hook_shotorigin[0] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 1);
439 hook_shotorigin[1] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 2);
440 hook_shotorigin[2] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 3);
441 hook_shotorigin[3] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK.m_id), false, false, 4);