Difference between revisions of "Lowering your weapon on sprint"

From Valve Developer Community
Jump to: navigation, search
m
(unnamed parameters don't require the "1=" :p)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This article will deal with lowering your weapon while sprinting and disable the ability to shoot at the same time.
+
This article provides a basic implementation of weapon lowering while sprinting, and preventing weapon fire while doing so.
This was based on a [http://forums.steampowered.com/forums/showthread.php?t=829259&highlight=lowering topic on the Steam Forums] (no longer available)
 
  
{{note|1=This has only been tested with the latest HL2MP OB engine code.}}
+
{{note|This will not work if your viewmodel doesn't have ACT_VM_IDLE_LOWERED animation declared somewhere in the .qc file.}}
{{note|1=This will not work if your weapon doesn't have the ACT_VM_IDLE_LOWERED animation in its .qc file (The Viewmodel). To fix this install Studio Compiler and decompile your Viewmodel and decompile one of your other models which has this animation, then add that animation into your decompiled .qc file. To find out how to add the animation just copy the animation from the working viewmodel .qc file.}}
+
 
{{note|1=If your weapon_yourweaponname.cpp is overriding ItemPostFrame then you have to place BaseClass::ProcessAnimationEvents(); in the ItemPostFrame of that class but only if you aren't calling BaseClass::ItemPostFrame();. For example in the weapon_shotgun.cpp it has an override of ItemPostFrame which means that the lowering weapon code will not be called for this weapon unless you add a call to it! '''Remember to put the Basecombatweapon_Shared.h declarations under public or protected so that you can make use of these variables in classes which inherit basecombatweapon_shared, like the weapon_shotgun.cpp's ItemPostFrame. If you don't do this you will get undeclared identifier errors'''}}
+
 
{{note|1=Download the Studio Compiler here [http://www.chaosincarnate.net/cannonfodder/download.php?id=StudioCompilerSetup.V0.4A.exe] (only necessary if your weapon doesn't have the ACT_VM_IDLE_LOWERED animation!)}}
+
{{note|If your weapon_yourweaponname.cpp is overriding ItemPostFrame then you have to place BaseClass::ProcessAnimationEvents(); in the ItemPostFrame of that class but only if you aren't calling BaseClass::ItemPostFrame();. For example in the weapon_shotgun.cpp it has an override of ItemPostFrame which means that the lowering weapon code will not be called for this weapon unless you add a call to it! '''Remember to put the Basecombatweapon_Shared.h declarations under public or protected so that you can make use of these variables in classes which inherit basecombatweapon_shared, like the weapon_shotgun.cpp's ItemPostFrame. If you don't do this you will get undeclared identifier errors'''}}
  
 
== The Code ==
 
== The Code ==
 
+
{{note|This has been tested with HL2MP, 2013 and Alien Swarm SDKS.}}
{{note|1=In this Tutorial you will do this by coding only, so open up your basecombatweapon_shared.cpp and basecombatweapon_shared.h}}
 
  
 
===BASECOMBATWEAPON_SHARED.CPP===
 
===BASECOMBATWEAPON_SHARED.CPP===
Line 74: Line 72:
  
 
Add these declarations under public at line 211 below '''bool IsViewModelSequenceFinished( void ); // Returns if the viewmodel's current animation is finished''':
 
Add these declarations under public at line 211 below '''bool IsViewModelSequenceFinished( void ); // Returns if the viewmodel's current animation is finished''':
{{note|1=We make ProcessAnimationEvents virtual so that we can override it in classes which inherit this class.}}
+
{{note|We make ProcessAnimationEvents virtual so that we can override it in classes which inherit this class.}}
  
 
<source lang=cpp>
 
<source lang=cpp>
Line 86: Line 84:
  
 
Now your weapon should be lowered when you hit the sprint button and you will not be able to shoot until you release the button!
 
Now your weapon should be lowered when you hit the sprint button and you will not be able to shoot until you release the button!
 +
[[File:Sprint.gif|none|Finished Product]]
  
[[Category:Weapons programming]] {{DISPLAYTITLE:Lowering your weapon on sprint}}
+
[[Category:Weapons programming]]
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]

Latest revision as of 04:25, 26 September 2018

This article provides a basic implementation of weapon lowering while sprinting, and preventing weapon fire while doing so.

Note.png Note: This will not work if your viewmodel doesn't have ACT_VM_IDLE_LOWERED animation declared somewhere in the .qc file.


Note.png Note: If your weapon_yourweaponname.cpp is overriding ItemPostFrame then you have to place BaseClass::ProcessAnimationEvents(); in the ItemPostFrame of that class but only if you aren't calling BaseClass::ItemPostFrame();. For example in the weapon_shotgun.cpp it has an override of ItemPostFrame which means that the lowering weapon code will not be called for this weapon unless you add a call to it! Remember to put the Basecombatweapon_Shared.h declarations under public or protected so that you can make use of these variables in classes which inherit basecombatweapon_shared, like the weapon_shotgun.cpp's ItemPostFrame. If you don't do this you will get undeclared identifier errors

The Code

Note.png Note: This has been tested with HL2MP, 2013 and Alien Swarm SDKS.

BASECOMBATWEAPON_SHARED.CPP

Hit CTRL+F and search for this code:

void CBaseCombatWeapon::ItemPostFrame( void )

Then copy and paste this above it:

void CBaseCombatWeapon::ProcessAnimationEvents(void)
{
	CBasePlayer *pOwner = ToBasePlayer( GetOwner() );
	if (!pOwner)
		return;

	if ( !m_bWeaponIsLowered && (pOwner->m_nButtons & IN_SPEED ) )
	{
		m_bWeaponIsLowered = true;
		SendWeaponAnim( ACT_VM_IDLE_LOWERED );
		m_flNextPrimaryAttack = gpGlobals->curtime + GetViewModelSequenceDuration();
	        m_flNextSecondaryAttack = m_flNextPrimaryAttack;
	}
	else if ( m_bWeaponIsLowered && !(pOwner->m_nButtons & IN_SPEED ) )
	{
		m_bWeaponIsLowered = false;
		SendWeaponAnim( ACT_VM_IDLE );
		m_flNextPrimaryAttack = gpGlobals->curtime + GetViewModelSequenceDuration();
 	        m_flNextSecondaryAttack = m_flNextPrimaryAttack;
	}

	if ( m_bWeaponIsLowered )
	{
		if ( gpGlobals->curtime > m_flNextPrimaryAttack )
		{
			SendWeaponAnim( ACT_VM_IDLE_LOWERED );
			m_flNextPrimaryAttack = gpGlobals->curtime + GetViewModelSequenceDuration();
			m_flNextSecondaryAttack = m_flNextPrimaryAttack;
		}
	}
}

Now to make sure our code gets called we add ProcessAnimationEvents(); here:

void CBaseCombatWeapon::ItemPostFrame( void )
{
      //Add this underneath the pOwner accessor check.
      ProcessAnimationEvents();
}

BASECOMBATWEAPON_SHARED.H

Add these declarations under public at line 211 below bool IsViewModelSequenceFinished( void ); // Returns if the viewmodel's current animation is finished:

Note.png Note: We make ProcessAnimationEvents virtual so that we can override it in classes which inherit this class.
	virtual void            ProcessAnimationEvents(void);
	bool                    m_bWeaponIsLowered;

Finish

Now your weapon should be lowered when you hit the sprint button and you will not be able to shoot until you release the button!

Finished Product