1 /*============================================
3 Wazat's Xonotic Grappling Hook
5 Contact: Wazat1@gmail.com
8 Installation instructions:
9 --------------------------
11 1. Place hook.c in your gamec source directory with the other source files.
13 2. Add this line to the bottom of progs.src:
17 3. Open defs.h and add these lines to the very bottom:
19 // Wazat's grappling hook
21 void GrapplingHookFrame();
22 void RemoveGrapplingHook(entity pl);
23 void SetGrappleHookBindings();
25 float GRAPHOOK_FIRE = 20;
26 float GRAPHOOK_RELEASE = 21;
27 // (note: you can change the hook impulse #'s to whatever you please)
29 4. Open client.c and add this to the top of PutClientInServer():
31 RemoveGrapplingHook(self); // Wazat's Grappling Hook
33 5. Find ClientConnect() (in client.c) and add these lines to the bottom:
35 // Wazat's grappling hook
36 SetGrappleHookBindings();
38 6. Still in client.c, find PlayerPreThink and add this line just above the call to W_WeaponFrame:
42 7. Build and test the mod. You'll want to bind a key to "+hook" like this:
45 And you should be done!
48 ============================================*/
51 .float hook_switchweapon;
53 void RemoveGrapplingHook(entity pl)
59 if(pl.movetype == MOVETYPE_FLY)
60 pl.movetype = MOVETYPE_WALK;
62 //pl.disableclientprediction = FALSE;
65 void GrapplingHookReset(void)
67 if(self.realowner.hook == self)
68 RemoveGrapplingHook(self.owner);
73 void GrapplingHookThink();
74 void GrapplingHook_Stop()
76 pointparticles(particleeffectnum("grapple_impact"), self.origin, '0 0 0', 1);
77 sound (self, CH_SHOTS, "weapons/hook_impact.wav", VOL_BASE, ATTN_NORM);
80 self.think = GrapplingHookThink;
81 self.nextthink = time;
82 self.touch = SUB_Null;
83 self.velocity = '0 0 0';
84 self.movetype = MOVETYPE_NONE;
85 self.hook_length = -1;
88 .vector hook_start, hook_end;
89 float GrapplingHookSend(entity to, float sf)
91 WriteByte(MSG_ENTITY, ENT_CLIENT_HOOK);
93 if(sound_allowed(MSG_BROADCAST, self.realowner))
95 WriteByte(MSG_ENTITY, sf);
98 WriteByte(MSG_ENTITY, num_for_edict(self.realowner));
102 WriteCoord(MSG_ENTITY, self.hook_start_x);
103 WriteCoord(MSG_ENTITY, self.hook_start_y);
104 WriteCoord(MSG_ENTITY, self.hook_start_z);
108 WriteCoord(MSG_ENTITY, self.hook_end_x);
109 WriteCoord(MSG_ENTITY, self.hook_end_y);
110 WriteCoord(MSG_ENTITY, self.hook_end_z);
115 void GrapplingHookThink()
117 float spd, dist, minlength, pullspeed, ropestretch, ropeairfriction, rubberforce, newlength, rubberforce_overstretch, s;
118 vector dir, org, end, v0, dv, v, myorg, vs;
119 if(self.realowner.hook != self) // how did that happen?
121 error("Owner lost the hook!\n");
124 if(LostMovetypeFollow(self) || intermission_running)
126 RemoveGrapplingHook(self.realowner);
130 WarpZone_RefSys_AddIncrementally(self, self.aiment);
132 self.nextthink = time;
134 s = self.realowner.cvar_cl_gunalign;
135 if(s != 1 && s != 2 && s != 4)
136 s = 3; // default value
138 vs = hook_shotorigin[s];
140 makevectors(self.realowner.v_angle);
141 org = self.realowner.origin + self.realowner.view_ofs + v_forward * vs_x + v_right * -vs_y + v_up * vs_z;
142 myorg = WarpZone_RefSys_TransformOrigin(self.realowner, self, org);
144 if(self.hook_length < 0)
145 self.hook_length = vlen(myorg - self.origin);
149 pullspeed = autocvar_g_balance_grapplehook_speed_pull;//2000;
150 // speed the rope is pulled with
152 rubberforce = autocvar_g_balance_grapplehook_force_rubber;//2000;
153 // force the rope will use if it is stretched
155 rubberforce_overstretch = autocvar_g_balance_grapplehook_force_rubber_overstretch;//1000;
156 // force the rope will use if it is stretched
158 minlength = autocvar_g_balance_grapplehook_length_min;//100;
159 // minimal rope length
160 // if the rope goes below this length, it isn't pulled any more
162 ropestretch = autocvar_g_balance_grapplehook_stretch;//400;
163 // if the rope is stretched by more than this amount, more rope is
164 // given to you again
166 ropeairfriction = autocvar_g_balance_grapplehook_airfriction;//0.2
167 // while hanging on the rope, this friction component will help you a
168 // bit to control the rope
170 dir = self.origin - myorg;
172 dir = normalize(dir);
174 if(autocvar_g_grappling_hook_tarzan)
176 v = v0 = WarpZone_RefSys_TransformVelocity(self.realowner, self, self.realowner.velocity);
178 // first pull the rope...
179 if(self.realowner.hook_state & HOOK_PULLING)
181 newlength = self.hook_length;
182 newlength = max(newlength - pullspeed * frametime, minlength);
184 if(newlength < dist - ropestretch) // overstretched?
186 newlength = dist - ropestretch;
187 if(v * dir < 0) // only if not already moving in hook direction
188 v = v + frametime * dir * rubberforce_overstretch;
191 self.hook_length = newlength;
194 if(self.realowner.hook_state & HOOK_RELEASING)
197 self.hook_length = newlength;
201 // then pull the player
202 spd = bound(0, (dist - self.hook_length) / ropestretch, 1);
203 v = v * (1 - frametime * ropeairfriction);
204 v = v + frametime * dir * spd * rubberforce;
206 dv = ((v - v0) * dir) * dir;
207 if(autocvar_g_grappling_hook_tarzan >= 2)
209 if(self.aiment.movetype == MOVETYPE_WALK)
212 self.aiment.velocity = self.aiment.velocity - dv * 0.5;
213 self.aiment.flags &~= FL_ONGROUND;
214 self.aiment.pusher = self.realowner;
215 self.aiment.pushltime = time + autocvar_g_maxpushtime;
216 self.aiment.istypefrag = self.aiment.BUTTON_CHAT;
220 self.realowner.flags &~= FL_ONGROUND;
223 self.realowner.velocity = WarpZone_RefSys_TransformVelocity(self, self.realowner, v);
227 end = self.origin - dir*50;
228 dist = vlen(end - myorg);
230 spd = dist * (pullspeed / 200);
235 self.realowner.velocity = dir*spd;
236 self.realowner.movetype = MOVETYPE_FLY;
238 self.realowner.flags &~= FL_ONGROUND;
242 makevectors(self.angles_x * '-1 0 0' + self.angles_y * '0 1 0');
243 myorg = WarpZone_RefSys_TransformOrigin(self, self.realowner, self.origin); // + v_forward * (-9);
245 if(myorg != self.hook_start)
248 self.hook_start = myorg;
250 if(org != self.hook_end)
257 void GrapplingHookTouch (void)
261 GrapplingHook_Stop();
264 if(other.movetype != MOVETYPE_NONE)
266 SetMovetypeFollow(self, other);
267 WarpZone_RefSys_BeginAddingIncrementally(self, self.aiment);
270 //self.realowner.disableclientprediction = TRUE;
273 void GrapplingHook_Damage (entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force)
278 if (!W_CheckProjectileDamage(inflictor.realowner, self.realowner, deathtype, -1)) // no exceptions
279 return; // g_balance_projectiledamage says to halt
281 self.health = self.health - damage;
283 if (self.health <= 0)
285 if(attacker != self.realowner)
287 self.realowner.pusher = attacker;
288 self.realowner.pushltime = time + autocvar_g_maxpushtime;
289 self.realowner.istypefrag = self.realowner.BUTTON_CHAT;
291 RemoveGrapplingHook(self.realowner);
295 void FireGrapplingHook (void)
302 if(time < game_starttime) return;
303 if(self.player_blocked) return;
304 if(self.freezetag_frozen) return;
305 if(self.vehicle) return;
307 makevectors(self.v_angle);
309 s = self.cvar_cl_gunalign;
310 if(s != 1 && s != 2 && s != 4)
311 s = 3; // default value
313 vs = hook_shotorigin[s];
315 // UGLY WORKAROUND: play this on CH_WEAPON_B so it can't cut off fire sounds
316 sound (self, CH_WEAPON_B, "weapons/hook_fire.wav", VOL_BASE, ATTN_NORM);
317 org = self.origin + self.view_ofs + v_forward * vs_x + v_right * -vs_y + v_up * vs_z;
319 tracebox(self.origin + self.view_ofs, '-3 -3 -3', '3 3 3', org, MOVE_NORMAL, self);
322 pointparticles(particleeffectnum("grapple_muzzleflash"), org, '0 0 0', 1);
324 missile = WarpZone_RefSys_SpawnSameRefSys(self);
325 missile.owner = missile.realowner = self;
327 missile.reset = GrapplingHookReset;
328 missile.classname = "grapplinghook";
329 missile.flags = FL_PROJECTILE;
331 missile.movetype = MOVETYPE_FLY;
332 PROJECTILE_MAKETRIGGER(missile);
334 //setmodel (missile, "models/hook.md3"); // precision set below
335 setsize (missile, '-3 -3 -3', '3 3 3');
336 setorigin (missile, org);
338 missile.state = 0; // not latched onto anything
340 W_SetupProjectileVelocityEx(missile, v_forward, v_up, autocvar_g_balance_grapplehook_speed_fly, 0, 0, 0, FALSE);
342 missile.angles = vectoangles (missile.velocity);
343 //missile.glow_color = 250; // 244, 250
344 //missile.glow_size = 120;
345 missile.touch = GrapplingHookTouch;
346 missile.think = GrapplingHookThink;
347 missile.nextthink = time;
349 missile.effects = /*EF_FULLBRIGHT | EF_ADDITIVE |*/ EF_LOWPRECISION;
351 missile.health = autocvar_g_balance_grapplehook_health;//120
352 missile.event_damage = GrapplingHook_Damage;
353 missile.takedamage = DAMAGE_AIM;
354 missile.damageforcescale = 0;
355 missile.damagedbycontents = (autocvar_g_balance_grapplehook_damagedbycontents);
357 missile.hook_start = missile.hook_end = missile.origin;
359 Net_LinkEntity(missile, FALSE, 0, GrapplingHookSend);
362 // void GrapplingHookFrame()
364 // // this function has been modified for Xonotic
365 // - if (self.BUTTON_HOOK && g_grappling_hook)
367 // - if (!self.hook && self.hook_time <= time && !self.button6_pressed_before)
368 // - if (timeoutStatus != 2) //only allow the player to fire the grappling hook if the game is not paused (timeout)
369 // - FireGrapplingHook();
374 // RemoveGrapplingHook(self);
376 // - self.button6_pressed_before = self.BUTTON_HOOK;
378 // // if I have no hook or it's not pulling yet, make sure I'm not flying!
379 // if((self.hook == world || !self.hook.state) && self.movetype == MOVETYPE_FLY)
381 void GrapplingHookFrame()
383 if(g_grappling_hook && timeout_status != TIMEOUT_ACTIVE && self.weapon != WEP_HOOK)
385 // offhand hook controls
388 if not(self.hook || (self.hook_state & HOOK_WAITING_FOR_RELEASE))
390 self.hook_state |= HOOK_FIRING;
391 self.hook_state |= HOOK_WAITING_FOR_RELEASE;
396 self.hook_state |= HOOK_REMOVING;
397 self.hook_state &~= HOOK_WAITING_FOR_RELEASE;
400 self.hook_state &~= HOOK_RELEASING;
401 if(self.BUTTON_CROUCH)
403 self.hook_state &~= HOOK_PULLING;
404 //self.hook_state |= HOOK_RELEASING;
408 self.hook_state |= HOOK_PULLING;
409 //self.hook_state &~= HOOK_RELEASING;
412 else if(!(self.items & IT_JETPACK) && !g_grappling_hook && self.switchweapon != WEP_HOOK)
414 if(self.BUTTON_HOOK && !self.hook_switchweapon)
415 W_SwitchWeapon(WEP_HOOK);
417 self.hook_switchweapon = self.BUTTON_HOOK;
419 if(!g_grappling_hook && self.weapon != WEP_HOOK)
421 self.hook_state &~= HOOK_FIRING;
422 self.hook_state |= HOOK_REMOVING;
425 if (self.hook_state & HOOK_FIRING)
428 RemoveGrapplingHook(self);
430 self.hook_state &~= HOOK_FIRING;
432 else if(self.hook_state & HOOK_REMOVING)
435 RemoveGrapplingHook(self);
436 self.hook_state &~= HOOK_REMOVING;
440 // if I have no hook or it's not pulling yet, make sure I'm not flying!
441 if((self.hook == world || !self.hook.state) && self.movetype == MOVETYPE_FLY)
443 self.movetype = MOVETYPE_WALK;
445 if(self.impulse == GRAPHOOK_FIRE && self.hook_time <= time && g_grappling_hook)
451 else if(self.hookimpulse == GRAPHOOK_RELEASE)
453 // remove hook, reset movement type
454 RemoveGrapplingHook(self);
458 /*else // make sure the player's movetype is correct
460 //if(self.hook == world && self.movetype == MOVETYPE_FLY)
461 if((self.hook == world || !self.hook.state) && self.movetype == MOVETYPE_FLY)
463 self.movetype = MOVETYPE_WALK;
466 // note: The hook entity does the actual pulling
469 void GrappleHookInit()
473 hook_shotorigin[0] = '8 8 -12';
474 hook_shotorigin[1] = '8 8 -12';
475 hook_shotorigin[2] = '8 8 -12';
476 hook_shotorigin[3] = '8 8 -12';
480 weapon_action(WEP_HOOK, WR_PRECACHE);
481 hook_shotorigin[0] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK), FALSE, FALSE, 1);
482 hook_shotorigin[1] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK), FALSE, FALSE, 2);
483 hook_shotorigin[2] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK), FALSE, FALSE, 3);
484 hook_shotorigin[3] = shotorg_adjust_values(CL_Weapon_GetShotOrg(WEP_HOOK), FALSE, FALSE, 4);
488 void SetGrappleHookBindings()
490 // this function has been modified for Xonotic
491 // don't remove these lines! old server or demos coud overwrite the new aliases
492 stuffcmd(self, "alias +hook +button6\n");
493 stuffcmd(self, "alias -hook -button6\n");