Merge pull request #377 from Blixibon/mapbase/feature/protagonist-system

HL2 player character switching system

Author: Blixibon

sp/src/game/client/client_mapbase.vpc

@@ -49,6 +49,8 @@ $Project
 			$File	"$SRCDIR\game\shared\mapbase\matchers.h"
 			$File	"$SRCDIR\game\shared\mapbase\mapbase_playeranimstate.cpp"
 			$File	"$SRCDIR\game\shared\mapbase\mapbase_playeranimstate.h"
+			$File	"$SRCDIR\game\shared\mapbase\protagonist_system.cpp"
+			$File	"$SRCDIR\game\shared\mapbase\protagonist_system.h"
 			$File	"$SRCDIR\game\shared\mapbase\vscript_funcs_shared.cpp" [$MAPBASE_VSCRIPT]
 			$File	"$SRCDIR\game\shared\mapbase\vscript_funcs_shared.h" [$MAPBASE_VSCRIPT]
 			$File	"$SRCDIR\game\shared\mapbase\vscript_singletons.cpp" [$MAPBASE_VSCRIPT]

sp/src/game/client/hl2/c_basehlplayer.cpp

@@ -31,6 +31,9 @@ ConVar cl_npc_speedmod_outtime( "cl_npc_speedmod_outtime", "1.5", FCVAR_CLIENTDL
 IMPLEMENT_CLIENTCLASS_DT(C_BaseHLPlayer, DT_HL2_Player, CHL2_Player)
 	RecvPropDataTable( RECVINFO_DT(m_HL2Local),0, &REFERENCE_RECV_TABLE(DT_HL2Local) ),
 	RecvPropBool( RECVINFO( m_fIsSprinting ) ),
+#ifdef MAPBASE
+	RecvPropInt( RECVINFO( m_nProtagonistIndex ) ),
+#endif
 #ifdef SP_ANIM_STATE
 	RecvPropFloat( RECVINFO( m_flAnimRenderYaw ) ),
 	RecvPropFloat( RECVINFO( m_flAnimRenderZ ) ),
@@ -79,6 +82,8 @@ C_BaseHLPlayer::C_BaseHLPlayer()
 #ifdef MAPBASE
 	ConVarRef scissor("r_flashlightscissor");
 	scissor.SetValue("0");
+
+	m_nProtagonistIndex = -1;
 #endif
 }
 

sp/src/game/client/hl2/c_basehlplayer.h

@@ -63,6 +63,10 @@ class C_BaseHLPlayer : public C_BasePlayer
 
 	bool				IsWeaponLowered( void ) { return m_HL2Local.m_bWeaponLowered; }
 
+#ifdef MAPBASE
+	int				GetProtagonistIndex() const { return m_nProtagonistIndex; }
+#endif
+
 #ifdef SP_ANIM_STATE
 	virtual const Vector&	GetRenderOrigin();
 	virtual const QAngle&	GetRenderAngles( void );
@@ -89,6 +93,10 @@ class C_BaseHLPlayer : public C_BasePlayer
 	bool				m_bPlayUseDenySound;		// Signaled by PlayerUse, but can be unset by HL2 ladder code...
 	float				m_flSpeedMod;
 	float				m_flExitSpeedMod;
+
+#ifdef MAPBASE
+	int					m_nProtagonistIndex;
+#endif
 
 #ifdef MAPBASE_MP
 	CSinglePlayerAnimState *m_pPlayerAnimState;

sp/src/game/server/hl2/hl2_player.cpp

@@ -58,6 +58,7 @@
 #ifdef MAPBASE
 #include "triggers.h"
 #include "mapbase/variant_tools.h"
+#include "mapbase/protagonist_system.h"
 #endif
 
 // memdbgon must be the last include file in a .cpp file!!!
@@ -593,6 +594,8 @@ BEGIN_DATADESC( CHL2_Player )
 	DEFINE_INPUTFUNC( FIELD_VOID, "DisableGeigerCounter", InputDisableGeigerCounter ),
 	DEFINE_INPUTFUNC( FIELD_VOID, "ShowSquadHUD", InputShowSquadHUD ),
 	DEFINE_INPUTFUNC( FIELD_VOID, "HideSquadHUD", InputHideSquadHUD ),
+
+	DEFINE_INPUTFUNC( FIELD_STRING, "SetProtagonist", InputSetProtagonist ),
 #endif
 
 	DEFINE_SOUNDPATCH( m_sndLeeches ),
@@ -607,6 +610,10 @@ BEGIN_DATADESC( CHL2_Player )
 
 	DEFINE_FIELD( m_flTimeNextLadderHint, FIELD_TIME ),
 
+#ifdef MAPBASE
+	DEFINE_KEYFIELD( m_iszProtagonistName, FIELD_STRING, "ProtagonistName" ),
+#endif
+
 	//DEFINE_FIELD( m_hPlayerProxy, FIELD_EHANDLE ), //Shut up class check!
 
 END_DATADESC()
@@ -625,6 +632,9 @@ BEGIN_ENT_SCRIPTDESC( CHL2_Player, CBasePlayer, "The HL2 player entity." )
 	DEFINE_SCRIPTFUNC( RemoveCustomSuitDevice, "Removes a custom suit device ID. (1-3)" )
 	DEFINE_SCRIPTFUNC( IsCustomSuitDeviceActive, "Checks if a custom suit device is active." )
 
+	DEFINE_SCRIPTFUNC( GetProtagonistName, "Gets the player's protagonist name." )
+	DEFINE_SCRIPTFUNC( SetProtagonist, "Sets the player's protagonist entry." )
+
 #ifdef SP_ANIM_STATE
 	DEFINE_SCRIPTFUNC( AddAnimStateLayer, "Adds a custom sequence index as a misc. layer for the singleplayer anim state, wtih parameters for blending in/out, setting the playback rate, holding the animation at the end, and only playing when the player is still." )
 #endif
@@ -640,6 +650,10 @@ CHL2_Player::CHL2_Player()
 
 	m_flArmorReductionTime = 0.0f;
 	m_iArmorReductionFrom = 0;
+
+#ifdef MAPBASE
+	m_nProtagonistIndex = -1;
+#endif
 }
 
 //
@@ -674,6 +688,9 @@ CSuitPowerDevice SuitDeviceCustom[] =
 IMPLEMENT_SERVERCLASS_ST(CHL2_Player, DT_HL2_Player)
 	SendPropDataTable(SENDINFO_DT(m_HL2Local), &REFERENCE_SEND_TABLE(DT_HL2Local), SendProxy_SendLocalDataTable),
 	SendPropBool( SENDINFO(m_fIsSprinting) ),
+#ifdef MAPBASE
+	SendPropInt( SENDINFO( m_nProtagonistIndex ), 8, SPROP_UNSIGNED ),
+#endif
 #ifdef SP_ANIM_STATE
 	SendPropFloat( SENDINFO(m_flAnimRenderYaw), 0, SPROP_NOSCALE ),
 	SendPropFloat( SENDINFO(m_flAnimRenderZ), 0, SPROP_NOSCALE ),
@@ -1259,6 +1276,11 @@ void CHL2_Player::Activate( void )
 #endif
 
 	GetPlayerProxy();
+
+#ifdef MAPBASE
+	if (m_iszProtagonistName != NULL_STRING)
+		SetProtagonist( STRING( m_iszProtagonistName ) );
+#endif
 }
 
 //------------------------------------------------------------------------------
@@ -1500,6 +1522,8 @@ CStudioHdr *CHL2_Player::OnNewModel()
 extern char g_szDefaultPlayerModel[MAX_PATH];
 extern bool g_bDefaultPlayerLegs;
 extern bool g_bDefaultPlayerDrawExternally;
+
+extern char g_szDefaultProtagonist[MAX_PROTAGONIST_NAME];
 #endif
 
 //-----------------------------------------------------------------------------
@@ -1533,6 +1557,9 @@ void CHL2_Player::Spawn(void)
 
 	SetDrawPlayerLegs( g_bDefaultPlayerLegs );
 	SetDrawPlayerModelExternally( g_bDefaultPlayerDrawExternally );
+
+	if (m_iszProtagonistName == NULL_STRING && *g_szDefaultProtagonist)
+		m_iszProtagonistName = MAKE_STRING( g_szDefaultProtagonist );
 #endif
 
 	//
@@ -4087,6 +4114,10 @@ bool CHL2_Player::Weapon_Switch( CBaseCombatWeapon *pWeapon, int viewmodelindex
 		StopZooming();
 	}
 
+#ifdef MAPBASE
+	RefreshProtagonistWeaponData( pWeapon );
+#endif
+
 	return BaseClass::Weapon_Switch( pWeapon, viewmodelindex );
 }
 
@@ -4482,6 +4513,144 @@ bool CHL2_Player::IsCustomSuitDeviceActive( int iDeviceID )
 
 	return SuitPower_IsDeviceActive( SuitDeviceCustom[iDeviceID] );
 }
+
+//-----------------------------------------------------------------------------
+// Purpose: Gets our protagonist name, if we have one
+//-----------------------------------------------------------------------------
+const char *CHL2_Player::GetProtagonistName() const
+{
+	return STRING( m_iszProtagonistName );
+}
+
+//-----------------------------------------------------------------------------
+// Purpose: Gets our protagonist index, if we have one
+//-----------------------------------------------------------------------------
+int CHL2_Player::GetProtagonistIndex() const
+{
+	return m_nProtagonistIndex;
+}
+
+//-----------------------------------------------------------------------------
+// Purpose: Sets our protagonist to the specified entry
+//-----------------------------------------------------------------------------
+void CHL2_Player::InputSetProtagonist( inputdata_t &inputdata )
+{
+	SetProtagonist( inputdata.value.String() );
+}
+
+//-----------------------------------------------------------------------------
+// Purpose: Sets our protagonist to the specified entry
+//-----------------------------------------------------------------------------
+void CHL2_Player::SetProtagonist( const char *pszProtagonist )
+{
+	if (!pszProtagonist || !*pszProtagonist)
+	{
+		ResetProtagonist();
+		return;
+	}
+
+	int nIndex = g_ProtagonistSystem.FindProtagonistIndex( pszProtagonist );
+	if (nIndex == -1)
+	{
+		Warning( "\"%s\" is not a valid protagonist\n", pszProtagonist );
+		return;
+	}
+
+	if (m_nProtagonistIndex != -1)
+	{
+		// Flush any pre-existing data
+		ResetProtagonist();
+	}
+	
+	m_nProtagonistIndex = nIndex;
+	m_iszProtagonistName = AllocPooledString( pszProtagonist );
+
+	RefreshProtagonistData();
+}
+
+//-----------------------------------------------------------------------------
+// Purpose: Resets protagonist data
+//-----------------------------------------------------------------------------
+void CHL2_Player::ResetProtagonist()
+{
+	SetModel( g_szDefaultPlayerModel );
+	m_nSkin = 0;
+	m_nBody = 0;
+
+	CBaseViewModel *vm = GetViewModel( 1 );
+	if (vm)
+	{
+		extern char g_szDefaultHandsModel[MAX_PATH];
+		vm->SetWeaponModel( g_szDefaultHandsModel, NULL );
+
+		vm->m_nSkin = 0;
+		vm->m_nBody = 0;
+	}
+
+	// RemoveContext will automatically remove contexts by name, regardless of how values are specified
+	char szContexts[128] = { 0 };
+	g_ProtagonistSystem.GetProtagonist_ResponseContexts( this, szContexts, sizeof( szContexts ) );
+	if (szContexts[0])
+		RemoveContext( szContexts );
+
+	m_iszProtagonistName = NULL_STRING;
+	m_nProtagonistIndex = -1;
+}
+
+//-----------------------------------------------------------------------------
+// Purpose: Refreshes protagonist data
+//-----------------------------------------------------------------------------
+void CHL2_Player::RefreshProtagonistData()
+{
+	if (m_nProtagonistIndex == -1)
+		return;
+
+	g_ProtagonistSystem.PrecacheProtagonist( this, m_nProtagonistIndex );
+
+	const char *pszProtagModel = g_ProtagonistSystem.GetProtagonist_PlayerModel( this );
+	if (pszProtagModel)
+		SetModel( pszProtagModel );
+
+	m_nSkin = g_ProtagonistSystem.GetProtagonist_PlayerModelSkin( this );
+	m_nBody = g_ProtagonistSystem.GetProtagonist_PlayerModelBody( this );
+
+	char szContexts[128] = { 0 };
+	g_ProtagonistSystem.GetProtagonist_ResponseContexts( this, szContexts, sizeof( szContexts ) );
+	if (szContexts[0])
+		AddContext( szContexts );
+
+	RefreshProtagonistWeaponData( GetActiveWeapon() );
+}
+
+//-----------------------------------------------------------------------------
+// Purpose: Refreshes protagonist data
+//-----------------------------------------------------------------------------
+void CHL2_Player::RefreshProtagonistWeaponData( CBaseCombatWeapon *pWeapon )
+{
+	if (m_nProtagonistIndex == -1)
+		return;
+
+	CBaseViewModel *vm = GetViewModel( 1 );
+	if (vm)
+	{
+		const char *pszHandModel = g_ProtagonistSystem.GetProtagonist_HandModel( this, pWeapon );
+		if (pszHandModel)
+		{
+			vm->SetWeaponModel( pszHandModel, NULL );
+
+			vm->m_nSkin = g_ProtagonistSystem.GetProtagonist_HandModelSkin( this, pWeapon );
+			vm->m_nBody = g_ProtagonistSystem.GetProtagonist_HandModelBody( this, pWeapon );
+		}
+		else
+		{
+			extern char g_szDefaultHandsModel[MAX_PATH];
+			vm->SetWeaponModel( g_szDefaultHandsModel, NULL );
+
+			vm->m_nSkin = 0;
+			vm->m_nBody = 0;
+		}
+	}
+}
 #endif
 
 //-----------------------------------------------------------------------------

sp/src/game/server/hl2/hl2_player.h

@@ -358,6 +358,15 @@ class CHL2_Player : public CBasePlayer
 	void AddCustomSuitDevice( int iDeviceID );
 	void RemoveCustomSuitDevice( int iDeviceID );
 	bool IsCustomSuitDeviceActive( int iDeviceID );
+
+	// Protagonist system
+	const char *GetProtagonistName() const;
+	int GetProtagonistIndex() const;
+	void InputSetProtagonist( inputdata_t &inputdata );
+	void SetProtagonist( const char *pszProtagonist );
+	void ResetProtagonist();
+	void RefreshProtagonistData();
+	void RefreshProtagonistWeaponData( CBaseCombatWeapon *pWeapon );
 #endif
 
 	CSoundPatch *m_sndLeeches;
@@ -442,6 +451,12 @@ class CHL2_Player : public CBasePlayer
 
 	friend class CHL2GameMovement;
 
+#ifdef MAPBASE
+	// Protagonist used by protagonist_system.h
+	string_t			m_iszProtagonistName;
+	CNetworkVar( int, m_nProtagonistIndex );
+#endif
+
 #ifdef SP_ANIM_STATE
 	CMapbasePlayerAnimState* m_pPlayerAnimState;
 

sp/src/game/server/player.cpp

@@ -4475,6 +4475,11 @@ void CBasePlayer::SetSuitUpdate(const char *name, int fgroup, int iNoRepeatTime)
 		return;
 	}
 
+#ifdef MAPBASE
+	if ( HasContext("silent_suit", "1") )
+		return;
+#endif
+
 	// if name == NULL, then clear out the queue
 
 	if (!name)

sp/src/game/server/server_mapbase.vpc

@@ -48,6 +48,8 @@ $Project
 			$File	"$SRCDIR\game\shared\mapbase\matchers.h"
 			$File	"$SRCDIR\game\shared\mapbase\mapbase_playeranimstate.cpp"
 			$File	"$SRCDIR\game\shared\mapbase\mapbase_playeranimstate.h"
+			$File	"$SRCDIR\game\shared\mapbase\protagonist_system.cpp"
+			$File	"$SRCDIR\game\shared\mapbase\protagonist_system.h"
 			$File	"$SRCDIR\game\shared\mapbase\vscript_funcs_shared.cpp" [$MAPBASE_VSCRIPT]
 			$File	"$SRCDIR\game\shared\mapbase\vscript_funcs_shared.h" [$MAPBASE_VSCRIPT]
 			$File	"$SRCDIR\game\shared\mapbase\vscript_singletons.cpp" [$MAPBASE_VSCRIPT]

sp/src/game/shared/basecombatweapon_shared.cpp

@@ -507,6 +507,11 @@ bool CBaseCombatWeapon::UsesHands() const
 {
 	return GetWpnData().m_bUsesHands;
 }
+
+int CBaseCombatWeapon::GetHandRig() const
+{
+	return GetWpnData().m_nHandRig;
+}
 #endif
 
 //-----------------------------------------------------------------------------
@@ -3127,6 +3132,9 @@ BEGIN_ENT_SCRIPTDESC( CBaseCombatWeapon, CBaseAnimating, "The base class for all
 	DEFINE_SCRIPTFUNC( GetViewModel, "Get the weapon's view model." )
 	DEFINE_SCRIPTFUNC( GetDroppedModel, "Get the weapon's unique dropped model if it has one." )
 
+	DEFINE_SCRIPTFUNC( UsesHands, "" )
+	DEFINE_SCRIPTFUNC( GetHandRig, "" )
+
 	DEFINE_SCRIPTFUNC( GetWeight, "Get the weapon's weight." )
 	DEFINE_SCRIPTFUNC( GetPrintName, "" )
 

sp/src/game/shared/basecombatweapon_shared.h

@@ -423,12 +423,13 @@ class CBaseCombatWeapon : public BASECOMBATWEAPON_DERIVED_FROM
 	virtual bool			UsesClipsForAmmo2( void ) const;
 	bool					IsMeleeWeapon() const;
 #ifdef MAPBASE
-	float					GetViewmodelFOVOverride() const;
+	virtual float			GetViewmodelFOVOverride() const;
 	float					GetBobScale() const;
 	float					GetSwayScale() const;
 	float					GetSwaySpeedScale() const;
 	virtual const char		*GetDroppedModel( void ) const;
-	bool					UsesHands( void ) const;
+	virtual bool			UsesHands( void ) const;
+	virtual int				GetHandRig( void ) const;
 #endif
 
 	// derive this function if you mod uses encrypted weapon info files