]> icculus.org git repositories - divverent/nexuiz.git/blob - data/qcsrc/server/gamec/g_hook.c
reduced grappling hook minimum length; pull can now be stopped using the crouch key
[divverent/nexuiz.git] / data / qcsrc / server / gamec / g_hook.c
1 /*============================================
2
3       Wazat's Nexuiz Grappling Hook
4
5         Contact: Wazat1@gmail.com
6
7
8 Installation instructions:
9 --------------------------
10
11 1. Place hook.c in your gamec source directory with the other source files.
12
13 2. Add this line to the bottom of progs.src:
14
15 gamec/hook.c
16
17 3. Open defs.h and add these lines to the very bottom:
18
19 // Wazat's grappling hook
20 .entity         hook;
21 void GrapplingHookFrame();
22 void RemoveGrapplingHook(entity pl);
23 void SetGrappleHookBindings();
24 // hook impulses
25 float GRAPHOOK_FIRE             = 20;
26 float GRAPHOOK_RELEASE          = 21;
27 // (note: you can change the hook impulse #'s to whatever you please)
28
29 4. Open client.c and add this to the top of PutClientInServer():
30
31         RemoveGrapplingHook(self); // Wazat's Grappling Hook
32
33 5. Find ClientConnect() (in client.c) and add these lines to the bottom:
34
35         // Wazat's grappling hook
36         SetGrappleHookBindings();
37
38 6. Still in client.c, find PlayerPreThink and add this line just above the call to W_WeaponFrame:
39
40         GrapplingHookFrame();
41
42 7. Build and test the mod.  You'll want to bind a key to "+hook" like this:
43 bind ctrl "+hook"
44
45 And you should be done!
46
47
48 ============================================*/
49
50 .float rope_length;
51 .float button6_pressed_before;
52
53 void RemoveGrapplingHook(entity pl)
54 {
55         if(pl.hook == world)
56                 return;
57         remove(pl.hook);
58         pl.hook = world;
59         if(pl.movetype == MOVETYPE_FLY)
60                 pl.movetype = MOVETYPE_WALK;
61
62         pl.hook_time = time + 0.0;
63 }
64
65 void GrapplingHookThink()
66 {
67         float spd, dist, minlength, pullspeed, ropestretch, ropeairfriction, rubberforce, newlength, rubberforce_overstretch;
68         vector dir, org, end;
69         if(self.owner.health <= 0 || self.owner.hook != self)   // how did that happen?
70         {                                                                                                               // well, better fix it anyway
71                 remove(self);
72                 return;
73         }
74
75         self.nextthink = time + 0.1;
76
77         makevectors(self.owner.v_angle);
78         org = self.owner.origin + self.owner.view_ofs + v_forward * 15 - v_right * 5 + v_up * -12;
79
80         if(self.rope_length < 0)
81                 self.rope_length = vlen(org - self.origin);
82
83         if(self.state == 1)
84         {
85                 pullspeed = cvar("g_balance_grapplehook_speed_pull");//2000;
86                 // speed the rope is pulled with
87
88                 rubberforce = cvar("g_balance_grapplehook_force_rubber");//2000;
89                 // force the rope will use if it is stretched
90
91                 rubberforce_overstretch = cvar("g_balance_grapplehook_force_rubber_overstretch");//1000;
92                 // force the rope will use if it is stretched
93
94                 minlength = cvar("g_balance_grapplehook_length_min");//100;
95                 // minimal rope length
96                 // if the rope goes below this length, it isn't pulled any more
97
98                 ropestretch = cvar("g_balance_grapplehook_stretch");//400;
99                 // if the rope is stretched by more than this amount, more rope is
100                 // given to you again
101
102                 ropeairfriction = cvar("g_balance_grapplehook_airfriction");//0.2
103                 // while hanging on the rope, this friction component will help you a
104                 // bit to control the rope
105
106                 dir = self.origin - org;
107                 dist = vlen(dir);
108                 dir = normalize(dir);
109
110                 if(cvar("g_grappling_hook_tarzan"))
111                 {
112                         newlength = self.rope_length;
113
114                         // first pull the rope...
115                         if(!self.owner.button5) // crouch key = don't pull
116                         {
117                                 newlength = max(newlength - pullspeed * 0.1, minlength);
118
119                                 if(newlength < dist - ropestretch) // overstretched?
120                                 {
121                                         newlength = dist - ropestretch;
122                                         if(self.owner.velocity * dir < 0) // only if not already moving in hook direction
123                                                 self.owner.velocity = self.owner.velocity + 0.1 * dir * rubberforce_overstretch;
124                                 }
125                         }
126
127                         self.rope_length = newlength;
128
129                         // then pull the player
130                         spd = bound(0, (dist - self.rope_length) / ropestretch, 1);
131                         self.owner.velocity = self.owner.velocity * (1 - 0.1 * ropeairfriction);
132                         self.owner.velocity = self.owner.velocity + 0.1 * dir * spd * rubberforce;
133                 }
134                 else
135                 {
136                         end = self.origin - dir*50;
137                         dist = vlen(end - org);
138                         if(dist < 200)
139                                 spd = dist * (pullspeed / 200);
140                         else
141                                 spd = pullspeed;
142                         if(spd < 50)
143                                 spd = 0;
144                         self.owner.velocity = dir*spd;
145                         self.owner.movetype = MOVETYPE_FLY;
146                 }
147
148                 self.owner.flags = self.owner.flags - (self.owner.flags & FL_ONGROUND);
149
150                 org = org + dir*50; // get the beam out of the player's eyes
151         }
152
153         WriteByte (MSG_BROADCAST, SVC_TEMPENTITY);
154         WriteByte (MSG_BROADCAST, TE_BEAM);
155         WriteEntity (MSG_BROADCAST, self);
156         WriteCoord (MSG_BROADCAST, self.origin_x);
157         WriteCoord (MSG_BROADCAST, self.origin_y);
158         WriteCoord (MSG_BROADCAST, self.origin_z);
159         WriteCoord (MSG_BROADCAST, org_x);
160         WriteCoord (MSG_BROADCAST, org_y);
161         WriteCoord (MSG_BROADCAST, org_z);
162 }
163
164 void GrapplingHookTouch (void)
165 {
166         if (other == self.owner)
167                 return;
168         // altered for Nexuiz
169         //else if (pointcontents (self.origin) == CONTENT_SKY)
170         else if (trace_dphitq3surfaceflags & Q3SURFACEFLAG_NOIMPACT)
171         {
172                 RemoveGrapplingHook(self.owner);
173                 return;
174         }
175
176         sound (self, CHAN_BODY, "weapons/hook_impact.ogg", 1, ATTN_NORM);
177
178         self.state = 1;
179         self.think = GrapplingHookThink;
180         self.nextthink = time + 0.1;
181         self.touch = SUB_Null;
182         self.velocity = '0 0 0';
183         self.movetype = MOVETYPE_NONE;
184         self.rope_length = -1;
185 }
186
187 void GrapplingHook_Damage (entity inflictor, entity attacker, float damage, float deathtype, vector hitloc, vector force)
188 {
189         if(self.health > 0)
190         {
191                 self.health = self.health - damage;
192                 if (self.health <= 0)
193                 {
194                         if(attacker != self.owner)
195                         {
196                                 self.owner.pusher = attacker;
197                                 self.owner.pushltime = time + cvar("g_maxpushtime");
198                         }
199                         RemoveGrapplingHook(self.owner);
200                 }
201         }
202 }
203
204 void FireGrapplingHook (void)
205 {
206         local entity missile;
207         local vector org;
208
209         if(arena_roundbased)
210         if(time < self.arena_warmup_end)
211                 return;
212
213         makevectors(self.v_angle);
214
215         sound (self, CHAN_WEAPON, "weapons/hook_fire.ogg", 1, ATTN_NORM);
216         org = self.origin + self.view_ofs + v_forward * 15 - v_right * 5 + v_up * -12;
217         te_customflash(org, 160, 0.2, '1 0 0');
218
219         missile = spawn ();
220         missile.owner = self;
221         self.hook = missile;
222         missile.classname = "grapplinghook";
223
224         missile.movetype = MOVETYPE_FLY;
225         missile.solid = SOLID_BBOX;
226
227         setmodel (missile, "models/ebomb.mdl"); // replace by something CENTERED!
228         setsize (missile, '-3 -3 -3', '3 3 3');
229         setorigin (missile, org);
230
231         missile.state = 0; // not latched onto anything
232
233         missile.velocity = v_forward * cvar("g_balance_grapplehook_speed_fly");
234         missile.angles = vectoangles (missile.velocity);
235         //missile.glow_color = 250; // 244, 250
236         //missile.glow_size = 120;
237         missile.touch = GrapplingHookTouch;
238         missile.think = GrapplingHookThink;
239         missile.nextthink = time + 0.1;
240
241         missile.effects = EF_FULLBRIGHT | EF_ADDITIVE | EF_LOWPRECISION;
242
243         missile.health = cvar("g_balance_grapplehook_health");//120
244         missile.event_damage = GrapplingHook_Damage;
245         missile.takedamage = DAMAGE_AIM;
246         missile.damageforcescale = 0;
247 }
248
249 void GrapplingHookFrame()
250 {
251         // this function has been modified for Nexuiz
252         if (self.button6 && cvar("g_grappling_hook"))
253         {
254                 if (!self.hook && self.hook_time <= time && !self.button6_pressed_before)
255                         FireGrapplingHook();
256         }
257         else
258         {
259                 if (self.hook)
260                         RemoveGrapplingHook(self);
261         }
262         self.button6_pressed_before = self.button6;
263         /*
264         // if I have no hook or it's not pulling yet, make sure I'm not flying!
265         if((self.hook == world || !self.hook.state) && self.movetype == MOVETYPE_FLY)
266         {
267                 self.movetype = MOVETYPE_WALK;
268         }
269         if(self.impulse == GRAPHOOK_FIRE && self.hook_time <= time && cvar("g_grappling_hook"))
270         {
271                 // fire hook
272                 FireGrapplingHook();
273                 return;
274         }
275         else if(self.hookimpulse == GRAPHOOK_RELEASE)
276         {
277                 // remove hook, reset movement type
278                 RemoveGrapplingHook(self);
279                 return;
280         }
281         */
282         /*else // make sure the player's movetype is correct
283         {
284                 //if(self.hook == world && self.movetype == MOVETYPE_FLY)
285                 if((self.hook == world || !self.hook.state) && self.movetype == MOVETYPE_FLY)
286                 {
287                         self.movetype = MOVETYPE_WALK;
288                 }
289         }*/
290         // note: The hook entity does the actual pulling
291 }
292
293 void SetGrappleHookBindings()
294 {
295         // this function has been modified for Nexuiz
296         // don't remove these lines! old server or demos coud overwrite the new aliases
297         stuffcmd(self, "alias +hook +button6\n");
298         stuffcmd(self, "alias -hook -button6\n");
299 }