1 #include "weaponsystem.qh"
3 #include "selection.qh"
5 #include "../command/common.qh"
6 #include "../mutators/_mod.qh"
7 #include "../round_handler.qh"
8 #include <common/t_items.qh>
9 #include <common/animdecide.qh>
10 #include <common/constants.qh>
11 #include <common/monsters/_mod.qh>
12 #include <common/notifications/all.qh>
13 #include <common/util.qh>
14 #include <common/weapons/_all.qh>
15 #include <common/state.qh>
16 #include <lib/csqcmodel/sv_model.qh>
20 .float weapon_frametime;
22 float W_WeaponRateFactor(entity this)
25 if(g_weaponratefactor > 0)
26 t = 1.0 / g_weaponratefactor;
28 MUTATOR_CALLHOOK(WeaponRateFactor, t, this);
34 float W_WeaponSpeedFactor(entity this)
36 float t = 1.0 * g_weaponspeedfactor;
38 MUTATOR_CALLHOOK(WeaponSpeedFactor, t, this);
45 bool CL_Weaponentity_CustomizeEntityForClient(entity this, entity client)
47 this.viewmodelforclient = this.owner;
48 if (IS_SPEC(client) && client.enemy == this.owner) this.viewmodelforclient = client;
52 vector CL_Weapon_GetShotOrg(int wpn)
54 entity wi = Weapons_from(wpn);
56 CL_WeaponEntity_SetModel(e, wi.mdl, false);
57 vector ret = e.movedir;
58 CL_WeaponEntity_SetModel(e, "", false);
63 ..entity weaponentity_fld;
69 void CL_Weaponentity_Think(entity this)
71 this.nextthink = time;
72 if (intermission_running) this.frame = this.anim_idle.x;
73 .entity weaponentity = this.weaponentity_fld;
74 if (this.owner.(weaponentity) != this)
76 // owner has new gun; remove old one
77 if (this.weaponchild) delete(this.weaponchild);
81 if (IS_DEAD(this.owner))
83 // owner died; disappear
85 if (this.weaponchild) this.weaponchild.model = "";
88 if (this.w_weaponname != this.weaponname
89 || this.w_dmg != this.modelindex
90 || this.w_deadflag != this.deadflag)
92 // owner changed weapons; update appearance
93 this.w_weaponname = this.weaponname;
94 this.w_dmg = this.modelindex;
95 this.w_deadflag = this.deadflag;
97 CL_WeaponEntity_SetModel(this, this.weaponname, true);
100 this.alpha = -1; // TODO: don't render this entity at all
102 if (this.owner.alpha == default_player_alpha) this.m_alpha = default_weapon_alpha;
103 else if (this.owner.alpha != 0) this.m_alpha = this.owner.alpha;
104 else this.m_alpha = 1;
106 if (this.weaponchild)
108 this.weaponchild.alpha = this.alpha;
109 this.weaponchild.effects = this.effects;
115 void CL_ExteriorWeaponentity_Think(entity this)
117 this.nextthink = time;
118 .entity weaponentity = this.weaponentity_fld;
119 entity wepent = this.owner.(weaponentity);
120 if (this.owner.exteriorweaponentity != this)
125 if (IS_DEAD(this.owner))
130 if (this.weaponname != wepent.weaponname || this.dmg != wepent.modelindex
131 || this.deadflag != wepent.deadflag)
133 this.weaponname = wepent.weaponname;
134 this.dmg = wepent.modelindex;
135 this.deadflag = wepent.deadflag;
136 if (wepent.weaponname != "")
138 _setmodel(this, W_Model(strcat("v_", wepent.weaponname, ".md3")));
139 setsize(this, '0 0 0', '0 0 0');
141 else this.model = "";
144 if ((tag_found = gettagindex(this.owner, "tag_weapon")))
146 this.tag_index = tag_found;
147 this.tag_entity = this.owner;
151 setattachment(this, this.owner, "bip01 r hand");
154 this.effects = this.owner.effects;
155 this.effects |= EF_LOWPRECISION;
156 this.effects = this.effects & EFMASK_CHEAP; // eat performance
157 if (this.owner.alpha == default_player_alpha) this.alpha = default_weapon_alpha;
158 else if (this.owner.alpha != 0) this.alpha = this.owner.alpha;
161 Weapon wep = this.owner.(weaponentity).m_weapon;
162 if (wep) this.glowmod = weaponentity_glowmod(wep, this.owner, this.owner.clientcolors);
163 this.colormap = this.owner.colormap;
165 CSQCMODEL_AUTOUPDATE(this);
168 // spawning weaponentity for client
169 void CL_SpawnWeaponentity(entity actor, .entity weaponentity)
171 entity view = actor.(weaponentity) = new(weaponentity);
172 view.solid = SOLID_NOT;
174 setmodel(view, MDL_Null); // precision set when changed
175 setorigin(view, '0 0 0');
176 view.weaponentity_fld = weaponentity;
177 setthink(view, CL_Weaponentity_Think);
178 view.nextthink = time;
179 view.viewmodelforclient = actor;
180 setcefc(view, CL_Weaponentity_CustomizeEntityForClient);
184 if (weaponentity == weaponentities[0])
186 entity exterior = actor.exteriorweaponentity = new(exteriorweaponentity);
187 exterior.solid = SOLID_NOT;
188 exterior.owner = actor;
189 exterior.weaponentity_fld = weaponentity;
190 setorigin(exterior, '0 0 0');
191 setthink(exterior, CL_ExteriorWeaponentity_Think);
192 exterior.nextthink = time;
194 CSQCMODEL_AUTOINIT(exterior);
199 void w_clear(Weapon thiswep, entity actor, .entity weaponentity, int fire)
201 actor.(weaponentity).m_weapon = WEP_Null;
202 actor.(weaponentity).m_switchingweapon = WEP_Null;
203 entity this = actor.(weaponentity);
206 this.state = WS_CLEAR;
211 void w_ready(Weapon thiswep, entity actor, .entity weaponentity, int fire)
213 entity this = actor.(weaponentity);
214 if (this) this.state = WS_READY;
215 weapon_thinkf(actor, weaponentity, WFRAME_IDLE, 1000000, w_ready);
220 bool weapon_prepareattack_checkammo(Weapon thiswep, entity actor, bool secondary, .entity weaponentity)
222 if ((actor.items & IT_UNLIMITED_WEAPON_AMMO)) return true;
224 if (secondary) ammo = thiswep.wr_checkammo2(thiswep, actor);
225 else ammo = thiswep.wr_checkammo1(thiswep, actor);
226 if (ammo) return true;
227 // always keep the Mine Layer if we placed mines, so that we can detonate them
228 if (thiswep == WEP_MINE_LAYER)
230 IL_EACH(g_mines, it.owner == actor,
236 if (thiswep == WEP_SHOTGUN)
237 if (!secondary && WEP_CVAR(shotgun, secondary) == 1) return false; // no clicking, just allow
239 if (thiswep == actor.(weaponentity).m_switchweapon && time - actor.prevdryfire > 1) // only play once BEFORE starting to switch weapons
241 sound(actor, CH_WEAPON_A, SND_DRYFIRE, VOL_BASE, ATTEN_NORM);
242 actor.prevdryfire = time;
245 // check if the other firing mode has enough ammo
246 bool ammo_other = false;
247 if (secondary) ammo_other = thiswep.wr_checkammo1(thiswep, actor);
248 else ammo_other = thiswep.wr_checkammo2(thiswep, actor);
251 if (time - actor.prevwarntime > 1)
257 ITEM_WEAPON_PRIMORSEC,
263 actor.prevwarntime = time;
265 else // this weapon is totally unable to fire, switch to another one
267 W_SwitchToOtherWeapon(actor, weaponentity);
274 bool weapon_prepareattack_check(Weapon thiswep, entity actor, .entity weaponentity, bool secondary, float attacktime)
276 if (actor.weaponentity == NULL) return true;
277 if (!weapon_prepareattack_checkammo(thiswep, actor, secondary, weaponentity)) return false;
279 // if sv_ready_restart_after_countdown is set, don't allow the player to shoot
280 // if all players readied up and the countdown is running
281 if (time < game_starttime || time < actor.race_penalty) return false;
283 if (timeout_status == TIMEOUT_ACTIVE) // don't allow the player to shoot while game is paused
286 // do not even think about shooting if switching
287 if (actor.(weaponentity).m_switchweapon != actor.(weaponentity).m_weapon) return false;
291 int slot = weaponslot(weaponentity);
292 // don't fire if previous attack is not finished
293 if (ATTACK_FINISHED(actor, slot) > time + actor.weapon_frametime * 0.5) return false;
294 entity this = actor.(weaponentity);
295 // don't fire while changing weapon
296 if (this.state != WS_READY) return false;
301 void weapon_prepareattack_do(entity actor, .entity weaponentity, bool secondary, float attacktime)
303 entity this = actor.(weaponentity);
304 if (this == NULL) return;
305 this.state = WS_INUSE;
307 actor.spawnshieldtime = min(actor.spawnshieldtime, time); // kill spawn shield when you fire
309 // if the weapon hasn't been firing continuously, reset the timer
312 int slot = weaponslot(weaponentity);
313 if (ATTACK_FINISHED(actor, slot) < time - actor.weapon_frametime * 1.5)
315 ATTACK_FINISHED(actor, slot) = time;
316 // dprint("resetting attack finished to ", ftos(time), "\n");
318 ATTACK_FINISHED(actor, slot) = ATTACK_FINISHED(actor, slot) + attacktime * W_WeaponRateFactor(actor);
320 actor.bulletcounter += 1;
321 // dprint("attack finished ", ftos(ATTACK_FINISHED(actor, slot)), "\n");
324 bool weapon_prepareattack(Weapon thiswep, entity actor, .entity weaponentity, bool secondary, float attacktime)
326 if (weapon_prepareattack_check(thiswep, actor, weaponentity, secondary, attacktime))
328 weapon_prepareattack_do(actor, weaponentity, secondary, attacktime);
334 void wframe_send(entity actor, entity weaponentity, vector a, bool restartanim);
337 * @param t defer thinking until time + t
338 * @param func next think function
340 void weapon_thinkf(entity actor, .entity weaponentity, WFRAME fr, float t, void(Weapon thiswep, entity actor,
341 .entity weaponentity, int fire) func)
343 entity this = actor.(weaponentity);
344 if (this == NULL) return;
346 if (fr == WFRAME_DONTCHANGE)
353 restartanim = fr != WFRAME_IDLE;
356 vector of = v_forward;
362 if (fr == WFRAME_IDLE) a = this.anim_idle;
363 else if (fr == WFRAME_FIRE1) a = this.anim_fire1;
364 else if (fr == WFRAME_FIRE2) a = this.anim_fire2;
365 else // if (fr == WFRAME_RELOAD)
366 a = this.anim_reload;
367 a.z *= g_weaponratefactor;
373 if (this.weapon_think == w_ready && func != w_ready && this.state == WS_RAISE) backtrace(
374 "Tried to override initial weapon think function - should this really happen?");
376 t *= W_WeaponRateFactor(actor);
378 // VorteX: haste can be added here
379 if (this.weapon_think == w_ready)
381 this.weapon_nextthink = time;
382 // dprint("started firing at ", ftos(time), "\n");
384 if (this.weapon_nextthink < time - actor.weapon_frametime * 1.5
385 || this.weapon_nextthink > time + actor.weapon_frametime * 1.5)
387 this.weapon_nextthink = time;
388 // dprint("reset weapon animation timer at ", ftos(time), "\n");
390 this.weapon_nextthink += t;
391 this.weapon_think = func;
392 // dprint("next ", ftos(this.weapon_nextthink), "\n");
396 FOREACH_CLIENT(true, LAMBDA(
397 if(it == actor || (IS_SPEC(it) && it.enemy == actor))
398 wframe_send(it, this, a, restartanim);
402 if ((fr == WFRAME_FIRE1 || fr == WFRAME_FIRE2) && t)
404 bool primary_melee = boolean(fr == WFRAME_FIRE1 && (actor.(weaponentity).m_weapon.spawnflags & WEP_TYPE_MELEE_PRI));
405 bool secondary_melee = boolean(fr == WFRAME_FIRE2 && (actor.(weaponentity).m_weapon.spawnflags & WEP_TYPE_MELEE_SEC));
406 int act = (primary_melee || secondary_melee)
410 animdecide_setaction(actor, act, restartanim);
412 else if (actor.anim_upper_action == ANIMACTION_SHOOT || actor.anim_upper_action == ANIMACTION_MELEE)
414 actor.anim_upper_action = 0;
418 bool forbidWeaponUse(entity player)
420 if (time < game_starttime && !autocvar_sv_ready_restart_after_countdown) return true;
421 if (round_handler_IsActive() && !round_handler_IsRoundStarted()) return true;
422 if (player.player_blocked) return true;
423 if (gameover) return true;
424 if (STAT(FROZEN, player)) return true;
425 if (player.weapon_blocked) return true;
426 if (MUTATOR_CALLHOOK(ForbidWeaponUse, player)) return true;
430 .bool hook_switchweapon;
432 void W_WeaponFrame(Player actor, .entity weaponentity)
435 TC(PlayerState, PS(actor));
436 entity this = actor.(weaponentity);
437 if (frametime) actor.weapon_frametime = frametime;
439 if (!this || actor.health < 1) return; // Dead player can't use weapons and injure impulse commands
442 if (forbidWeaponUse(actor))
444 if (actor.(weaponentity).state != WS_CLEAR)
446 Weapon wpn = this.m_weapon;
447 w_ready(wpn, actor, weaponentity, PHYS_INPUT_BUTTON_ATCK(actor) | (PHYS_INPUT_BUTTON_ATCK2(actor) << 1));
452 if (this.m_switchweapon == WEP_Null)
454 this.m_weapon = WEP_Null;
455 this.m_switchingweapon = WEP_Null;
456 this.state = WS_CLEAR;
457 this.weaponname = "";
458 // actor.items &= ~IT_AMMO;
462 makevectors(actor.v_angle);
463 vector fo = v_forward; // save them in case the weapon think functions change it
468 if (this.m_weapon != this.m_switchweapon)
473 LOG_WARNF("unhandled weaponentity (%i) state for player (%i): %d", this, actor, this.state);
481 Weapon newwep = this.m_switchweapon;
482 this.m_switchingweapon = newwep;
484 // the two weapon entities will notice this has changed and update their models
485 this.m_weapon = newwep;
486 this.weaponname = newwep.mdl;
487 actor.bulletcounter = 0;
488 actor.ammo_field = newwep.ammo_field;
489 newwep.wr_setup(newwep, actor);
490 this.state = WS_RAISE;
492 // set our clip load to the load of the weapon we switched to, if it's reloadable
493 if ((newwep.spawnflags & WEP_FLAG_RELOADABLE) && newwep.reloading_ammo) // prevent accessing undefined cvars
495 actor.clip_load = actor.(weapon_load[this.m_switchweapon.m_id]);
496 actor.clip_size = newwep.reloading_ammo;
500 actor.clip_load = actor.clip_size = 0;
503 weapon_thinkf(actor, weaponentity, WFRAME_IDLE, newwep.switchdelay_raise, w_ready);
508 // in dropping phase we can switch at any time
509 this.m_switchingweapon = this.m_switchweapon;
515 this.m_switchingweapon = this.m_switchweapon;
516 entity oldwep = this.m_weapon;
518 // set up weapon switch think in the future, and start drop anim
519 if (INDEPENDENT_ATTACK_FINISHED || ATTACK_FINISHED(actor, weaponslot(weaponentity)) <= time + actor.weapon_frametime * 0.5)
521 sound(actor, CH_WEAPON_SINGLE, SND_WEAPON_SWITCH, VOL_BASE, ATTN_NORM);
522 this.state = WS_DROP;
523 weapon_thinkf(actor, weaponentity, WFRAME_DONTCHANGE, oldwep.switchdelay_drop, w_clear);
530 // LordHavoc: network timing test code
531 // if (actor.button0)
532 // print(ftos(frametime), " ", ftos(time), " >= ", ftos(ATTACK_FINISHED(actor, slot)), " >= ", ftos(this.weapon_nextthink), "\n");
534 Weapon w = this.m_weapon;
536 // call the think code which may fire the weapon
537 // and do so multiple times to resolve framerate dependency issues if the
538 // server framerate is very low and the weapon fire rate very high
539 for (int c = 0; c < W_TICSPERFRAME; ++c)
541 if (w != WEP_Null && !(actor.weapons & WepSet_FromWeapon(w)))
543 if (this.m_weapon == this.m_switchweapon) W_SwitchWeapon_Force(actor, w_getbestweapon(actor), weaponentity);
551 bool block_weapon = false;
553 bool key_pressed = PHYS_INPUT_BUTTON_HOOK(actor) && !actor.vehicle;
554 Weapon off = actor.offhand;
555 if (off && !(actor.weapons & WEPSET(HOOK)))
557 if (off.offhand_think) off.offhand_think(off, actor, key_pressed);
561 if (key_pressed && this.m_switchweapon != WEP_HOOK && !actor.hook_switchweapon)
562 W_SwitchWeapon(actor, WEP_HOOK, weaponentity);
563 actor.hook_switchweapon = key_pressed;
565 block_weapon = (this.m_weapon == h && (PHYS_INPUT_BUTTON_ATCK(actor) || key_pressed));
566 h.wr_think(h, actor, weaponentity, block_weapon ? 1 : 0);
576 Weapon e = this.m_weapon;
580 e.wr_think(e, actor, weaponentity, PHYS_INPUT_BUTTON_ATCK(actor) | (PHYS_INPUT_BUTTON_ATCK2(actor) << 1));
584 e.wr_gonethink(e, actor, weaponentity);
588 if (time + actor.weapon_frametime * 0.5 >= this.weapon_nextthink)
590 if (this.weapon_think)
595 Weapon wpn = this.m_weapon;
596 this.weapon_think(wpn, actor, weaponentity,
597 PHYS_INPUT_BUTTON_ATCK(actor) | (PHYS_INPUT_BUTTON_ATCK2(actor) << 1));
601 bprint("\{1}^1ERROR: undefined weapon think function for ", actor.netname, "\n");
607 void W_AttachToShotorg(entity actor, .entity weaponentity, entity flash, vector offset)
610 flash.angles_z = random() * 360;
612 entity view = actor.(weaponentity);
613 entity exterior = actor.exteriorweaponentity;
615 if (gettagindex(view, "shot")) setattachment(flash, view, "shot");
616 else setattachment(flash, view, "tag_shot");
617 setorigin(flash, offset);
619 entity xflash = spawn();
620 copyentity(flash, xflash);
622 flash.viewmodelforclient = actor;
624 if (view.oldorigin.x > 0)
626 setattachment(xflash, exterior, "");
627 setorigin(xflash, view.oldorigin + offset);
631 if (gettagindex(exterior, "shot")) setattachment(xflash, exterior, "shot");
632 else setattachment(xflash, exterior, "tag_shot");
633 setorigin(xflash, offset);
637 void W_DecreaseAmmo(Weapon wep, entity actor, float ammo_use, .entity weaponentity)
639 if (MUTATOR_CALLHOOK(W_DecreaseAmmo, actor)) return;
641 if ((actor.items & IT_UNLIMITED_WEAPON_AMMO) && !wep.reloading_ammo) return;
643 // if this weapon is reloadable, decrease its load. Else decrease the player's ammo
644 if (wep.reloading_ammo)
646 actor.clip_load -= ammo_use;
647 actor.(weapon_load[actor.(weaponentity).m_weapon.m_id]) = actor.clip_load;
649 else if (wep.ammo_field != ammo_none)
651 actor.(wep.ammo_field) -= ammo_use;
652 if (actor.(wep.ammo_field) < 0)
655 "W_DecreaseAmmo(%.2f): '%s' subtracted too much %s from '%s', resulting with '%.2f' left... "
656 "Please notify Samual immediately with a copy of this backtrace!\n",
659 GetAmmoPicture(wep.ammo_field),
661 actor.(wep.ammo_field)
667 // weapon reloading code
669 .float reload_ammo_amount, reload_ammo_min, reload_time;
670 .float reload_complain;
671 .string reload_sound;
673 void W_ReloadedAndReady(Weapon thiswep, entity actor, .entity weaponentity, int fire)
675 // finish the reloading process, and do the ammo transfer
677 actor.clip_load = actor.old_clip_load; // restore the ammo counter, in case we still had ammo in the weapon before reloading
679 // if the gun uses no ammo, max out weapon load, else decrease ammo as we increase weapon load
680 if (!actor.reload_ammo_min || actor.items & IT_UNLIMITED_WEAPON_AMMO || actor.ammo_field == ammo_none)
682 actor.clip_load = actor.reload_ammo_amount;
686 // make sure we don't add more ammo than we have
687 float load = min(actor.reload_ammo_amount - actor.clip_load, actor.(actor.ammo_field));
688 actor.clip_load += load;
689 actor.(actor.ammo_field) -= load;
691 actor.(weapon_load[actor.(weaponentity).m_weapon.m_id]) = actor.clip_load;
693 // do not set ATTACK_FINISHED in reload code any more. This causes annoying delays if eg: You start reloading a weapon,
694 // then quickly switch to another weapon and back. Reloading is canceled, but the reload delay is still there,
695 // so your weapon is disabled for a few seconds without reason
697 // ATTACK_FINISHED(actor, slot) -= actor.reload_time - 1;
699 Weapon wpn = Weapons_from(actor.(weaponentity).m_weapon.m_id);
700 w_ready(wpn, actor, weaponentity, PHYS_INPUT_BUTTON_ATCK(actor) | (PHYS_INPUT_BUTTON_ATCK2(actor) << 1));
703 void W_Reload(entity actor, .entity weaponentity, float sent_ammo_min, Sound sent_sound)
705 TC(Sound, sent_sound);
706 // set global values to work with
707 Weapon e = actor.(weaponentity).m_weapon;
709 if (MUTATOR_CALLHOOK(W_Reload, actor)) return;
711 actor.reload_ammo_min = sent_ammo_min;
712 actor.reload_ammo_amount = e.reloading_ammo;
713 actor.reload_time = e.reloading_time;
714 if (actor.reload_sound) strunzone(actor.reload_sound);
715 actor.reload_sound = strzone(Sound_fixpath(sent_sound));
717 // don't reload weapons that don't have the RELOADABLE flag
718 if (!(e.spawnflags & WEP_FLAG_RELOADABLE))
721 "Warning: Attempted to reload a weapon that does not have the WEP_FLAG_RELOADABLE flag. Fix your code!\n");
725 // return if reloading is disabled for this weapon
726 if (!actor.reload_ammo_amount) return;
728 // our weapon is fully loaded, no need to reload
729 if (actor.clip_load >= actor.reload_ammo_amount) return;
731 // no ammo, so nothing to load
732 if (actor.ammo_field != ammo_none)
734 if (!actor.(actor.ammo_field) && actor.reload_ammo_min)
736 if (!(actor.items & IT_UNLIMITED_WEAPON_AMMO))
738 if (IS_REAL_CLIENT(actor) && actor.reload_complain < time)
740 play2(actor, SND(UNAVAILABLE));
741 sprint(actor, strcat("You don't have enough ammo to reload the ^2", actor.(weaponentity).m_weapon.m_name, "\n"));
742 actor.reload_complain = time + 1;
744 // switch away if the amount of ammo is not enough to keep using this weapon
745 Weapon w = actor.(weaponentity).m_weapon;
746 if (!(w.wr_checkammo1(w, actor) + w.wr_checkammo2(w, actor)))
748 actor.clip_load = -1; // reload later
749 W_SwitchToOtherWeapon(actor, weaponentity);
756 entity this = actor.(weaponentity);
759 if (this.wframe == WFRAME_RELOAD) return;
761 // allow switching away while reloading, but this will cause a new reload!
762 this.state = WS_READY;
765 // now begin the reloading process
767 _sound(actor, CH_WEAPON_SINGLE, actor.reload_sound, VOL_BASE, ATTEN_NORM);
769 // do not set ATTACK_FINISHED in reload code any more. This causes annoying delays if eg: You start reloading a weapon,
770 // then quickly switch to another weapon and back. Reloading is canceled, but the reload delay is still there,
771 // so your weapon is disabled for a few seconds without reason
773 // ATTACK_FINISHED(actor, slot) = max(time, ATTACK_FINISHED(actor, slot)) + actor.reload_time + 1;
775 weapon_thinkf(actor, weaponentity, WFRAME_RELOAD, actor.reload_time, W_ReloadedAndReady);
777 if (actor.clip_load < 0) actor.clip_load = 0;
778 actor.old_clip_load = actor.clip_load;
779 actor.clip_load = actor.(weapon_load[actor.(weaponentity).m_weapon.m_id]) = -1;
782 void W_DropEvent(.void(Weapon, entity actor) event, entity player, float weapon_type, entity weapon_item)
784 Weapon w = Weapons_from(weapon_type);
785 weapon_dropevent_item = weapon_item;