Added prototype for a new type of commentary node which displays text instead of playing audio

sp/src/game/client/c_point_commentary_node.cpp

@@ -18,6 +18,9 @@
 #include "convar.h"
 #include "hud_closecaption.h"
 #include "in_buttons.h"
+#ifdef MAPBASE
+#include "vgui_controls/Label.h"
+#endif
 
 // memdbgon must be the last include file in a .cpp file!!!
 #include "tier0/memdbgon.h"
@@ -37,6 +40,11 @@ bool IsInCommentaryMode( void )
 
 static bool g_bTracingVsCommentaryNodes = false;
 
+#ifdef MAPBASE
+ConVar commentary_text_force( "commentary_text_force", "0", FCVAR_NONE, "Forces all commentary nodes to use the text type." );
+ConVar commentary_text_endtime( "commentary_text_endtime", "120" );
+#endif
+
 //-----------------------------------------------------------------------------
 // Purpose: 
 //-----------------------------------------------------------------------------
@@ -52,6 +60,9 @@ public:
 	virtual void ApplySchemeSettings( vgui::IScheme *pScheme );
 
 	void StartCommentary( C_PointCommentaryNode *pNode, char *pszSpeakers, int iNode, int iNodeMax, float flStartTime, float flEndTime );
+#ifdef MAPBASE
+	void StartTextCommentary( C_PointCommentaryNode *pNode, const char *pszText, char *pszSpeakers, int iNode, int iNodeMax, float flStartTime, float flEndTime );
+#endif
 	void StopCommentary( void );
 	bool IsTheActiveNode( C_PointCommentaryNode *pNode ) { return (pNode == m_hActiveNode); }
 
@@ -68,6 +79,11 @@ private:
 	wchar_t	m_szCount[MAX_COUNT_STRING];
 	CMaterialReference m_matIcon;
 	bool	m_bHiding;
+#ifdef MAPBASE
+	bool	m_bTextCommentary; // NOTE: If any more types are needed, use an enum
+	wchar_t	*m_pszText;
+	vgui::Label *m_pLabel;
+#endif
 
 	// Painting
 	CPanelAnimationVarAliasType( int, m_iBarX, "bar_xpos", "8", "proportional_int" );
@@ -84,8 +100,27 @@ private:
 	CPanelAnimationVarAliasType( int, m_iIconTall, "icon_height", "8", "proportional_int" );
 	CPanelAnimationVarAliasType( int, m_nIconTextureId, "icon_texture", "vgui/hud/icon_commentary", "textureid" );
 
+#ifdef MAPBASE
+	CPanelAnimationVarAliasType( int, m_iTypeAudioX, "type_audio_xpos", "190", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeAudioY, "type_audio_ypos", "350", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeAudioW, "type_audio_wide", "380", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeAudioT, "type_audio_tall", "40", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeTextX, "type_text_xpos", "180", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeTextY, "type_text_ypos", "150", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeTextW, "type_text_wide", "400", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeTextT, "type_text_tall", "200", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeTextCountXFR, "type_text_count_xpos_from_right", "10", "proportional_int" );
+	CPanelAnimationVarAliasType( int, m_iTypeTextCountY, "type_text_count_ypos", "184", "proportional_int" );
+	CPanelAnimationVar( Color, m_TextBackgroundColor, "type_text_bg", "0 0 0 192" );
+	CPanelAnimationVar( Color, m_TextColor, "type_text_fg", "255 230 180 255" );
+#endif
+
 	CPanelAnimationVar( bool, m_bUseScriptBGColor, "use_script_bgcolor", "0" );
+#ifdef MAPBASE
+	CPanelAnimationVar( Color, m_BackgroundColor, "BackgroundColor", "Panel.BgColor" );
+#else
 	CPanelAnimationVar( Color, m_BackgroundColor, "BackgroundColor", "0 0 0 0" );
+#endif
 	CPanelAnimationVar( Color, m_BGOverrideColor, "BackgroundOverrideColor", "Panel.BgColor" );
 };
 
@@ -102,6 +137,11 @@ public:
 	virtual void OnPreDataChanged( DataUpdateType_t type );
 	virtual void OnDataChanged( DataUpdateType_t type );
 
+	void StartAudioCommentary( const char *pszCommentaryFile, C_BasePlayer *pPlayer );
+#ifdef MAPBASE
+	void StartTextCommentary( const char *pszCommentaryFile, C_BasePlayer *pPlayer );
+#endif
+
 	void OnRestore( void )
 	{
 		BaseClass::OnRestore();
@@ -181,6 +221,9 @@ public:
 	CSoundPatch *m_sndCommentary;
 	EHANDLE		m_hViewPosition;
 	bool		m_bRestartAfterRestore;
+#ifdef MAPBASE
+	bool		m_bTextCommentary;
+#endif
 };
 
 IMPLEMENT_CLIENTCLASS_DT(C_PointCommentaryNode, DT_PointCommentaryNode, CPointCommentaryNode)
@@ -192,6 +235,9 @@ IMPLEMENT_CLIENTCLASS_DT(C_PointCommentaryNode, DT_PointCommentaryNode, CPointCo
 	RecvPropInt( RECVINFO( m_iNodeNumber ) ),
 	RecvPropInt( RECVINFO( m_iNodeNumberMax ) ),
 	RecvPropEHandle( RECVINFO(m_hViewPosition) ),
+#ifdef MAPBASE
+	RecvPropBool( RECVINFO( m_bTextCommentary ) ),
+#endif
 END_RECV_TABLE()
 
 BEGIN_DATADESC( C_PointCommentaryNode )
@@ -245,58 +291,12 @@ void C_PointCommentaryNode::OnDataChanged( DataUpdateType_t updateType )
 			return;
 		}
 
-		EmitSound_t es;
+#ifdef MAPBASE
-		es.m_nChannel = CHAN_STATIC;
+		if (m_bTextCommentary || commentary_text_force.GetBool())
-		es.m_pSoundName = pszCommentaryFile;
+			StartTextCommentary( pszCommentaryFile, pPlayer );
- 		es.m_SoundLevel = SNDLVL_GUNFIRE;
-		es.m_nFlags = SND_SHOULDPAUSE;
-
-		CBaseEntity *pSoundEntity;
-		if ( m_hViewPosition )
-		{
-			pSoundEntity = m_hViewPosition;
-		}
-		else if ( render->GetViewEntity() )
-		{
-			pSoundEntity = cl_entitylist->GetEnt( render->GetViewEntity() );
-			es.m_SoundLevel = SNDLVL_NONE;
-		}
 		else
-		{
+#endif
-			pSoundEntity = pPlayer;
+			StartAudioCommentary( pszCommentaryFile, pPlayer );
-		}
-		CSingleUserRecipientFilter filter( pPlayer );
-		m_sndCommentary = (CSoundEnvelopeController::GetController()).SoundCreate( filter, pSoundEntity->entindex(), es );
-		if ( m_sndCommentary )
-		{
-			(CSoundEnvelopeController::GetController()).SoundSetCloseCaptionDuration( m_sndCommentary, -1 );
-			(CSoundEnvelopeController::GetController()).Play( m_sndCommentary, 1.0f, 100, m_flStartTime );
-		}
-
-		// Get the duration so we know when it finishes
-		float flDuration = enginesound->GetSoundDuration( STRING( CSoundEnvelopeController::GetController().SoundGetName( m_sndCommentary ) ) ) ;
-
-		CHudCloseCaption *pHudCloseCaption = (CHudCloseCaption *)GET_HUDELEMENT( CHudCloseCaption );
-		if ( pHudCloseCaption )
-		{
-			// This is where we play the commentary close caption (and lock the other captions out).
-			// Also, if close captions are off we force a caption in non-English
-			if ( closecaption.GetBool() || ( !closecaption.GetBool() && !english.GetBool() ) )
-			{
-				// Clear the close caption element in preparation
-				pHudCloseCaption->Reset();
-
-				// Process the commentary caption
-				pHudCloseCaption->ProcessCaptionDirect( pszCommentaryFile, flDuration );
-
-				// Find the close caption hud element & lock it
-				pHudCloseCaption->Lock();
-			}
-		}
-
-		// Tell the HUD element
-		CHudCommentary *pHudCommentary = (CHudCommentary *)GET_HUDELEMENT( CHudCommentary );
-		pHudCommentary->StartCommentary( this, m_iszSpeakers, m_iNodeNumber, m_iNodeNumberMax, m_flStartTime, m_flStartTime + flDuration );
 	}
 	else if ( m_bWasActive )
 	{
@@ -312,6 +312,83 @@ void C_PointCommentaryNode::OnDataChanged( DataUpdateType_t updateType )
 	m_bRestartAfterRestore = false;
 }
 
+//-----------------------------------------------------------------------------
+// Purpose: 
+//-----------------------------------------------------------------------------
+void C_PointCommentaryNode::StartAudioCommentary( const char *pszCommentaryFile, C_BasePlayer *pPlayer )
+{
+	EmitSound_t es;
+	es.m_nChannel = CHAN_STATIC;
+	es.m_pSoundName = pszCommentaryFile;
+ 	es.m_SoundLevel = SNDLVL_GUNFIRE;
+	es.m_nFlags = SND_SHOULDPAUSE;
+
+	CBaseEntity *pSoundEntity;
+	if ( m_hViewPosition )
+	{
+		pSoundEntity = m_hViewPosition;
+	}
+	else if ( render->GetViewEntity() )
+	{
+		pSoundEntity = cl_entitylist->GetEnt( render->GetViewEntity() );
+		es.m_SoundLevel = SNDLVL_NONE;
+	}
+	else
+	{
+		pSoundEntity = pPlayer;
+	}
+	CSingleUserRecipientFilter filter( pPlayer );
+	m_sndCommentary = (CSoundEnvelopeController::GetController()).SoundCreate( filter, pSoundEntity->entindex(), es );
+	if ( m_sndCommentary )
+	{
+		(CSoundEnvelopeController::GetController()).SoundSetCloseCaptionDuration( m_sndCommentary, -1 );
+		(CSoundEnvelopeController::GetController()).Play( m_sndCommentary, 1.0f, 100, m_flStartTime );
+	}
+
+	// Get the duration so we know when it finishes
+	float flDuration = enginesound->GetSoundDuration( STRING( CSoundEnvelopeController::GetController().SoundGetName( m_sndCommentary ) ) ) ;
+
+	CHudCloseCaption *pHudCloseCaption = (CHudCloseCaption *)GET_HUDELEMENT( CHudCloseCaption );
+	if ( pHudCloseCaption )
+	{
+		// This is where we play the commentary close caption (and lock the other captions out).
+		// Also, if close captions are off we force a caption in non-English
+		if ( closecaption.GetBool() || ( !closecaption.GetBool() && !english.GetBool() ) )
+		{
+			// Clear the close caption element in preparation
+			pHudCloseCaption->Reset();
+
+			// Process the commentary caption
+			pHudCloseCaption->ProcessCaptionDirect( pszCommentaryFile, flDuration );
+
+			// Find the close caption hud element & lock it
+			pHudCloseCaption->Lock();
+		}
+	}
+
+	// Tell the HUD element
+	CHudCommentary *pHudCommentary = (CHudCommentary *)GET_HUDELEMENT( CHudCommentary );
+	pHudCommentary->StartCommentary( this, m_iszSpeakers, m_iNodeNumber, m_iNodeNumberMax, m_flStartTime, m_flStartTime + flDuration );
+}
+
+#ifdef MAPBASE
+//-----------------------------------------------------------------------------
+// Purpose: 
+//-----------------------------------------------------------------------------
+void C_PointCommentaryNode::StartTextCommentary( const char *pszCommentaryFile, C_BasePlayer *pPlayer )
+{
+	// Get the duration so we know when it finishes
+	//float flDuration = enginesound->GetSoundDuration( STRING( CSoundEnvelopeController::GetController().SoundGetName( m_sndCommentary ) ) ) ;
+
+	// TODO: Determine from text length
+	float flDuration = commentary_text_endtime.GetFloat();
+
+	// Tell the HUD element
+	CHudCommentary *pHudCommentary = (CHudCommentary *)GET_HUDELEMENT( CHudCommentary );
+	pHudCommentary->StartTextCommentary( this, pszCommentaryFile, m_iszSpeakers, m_iNodeNumber, m_iNodeNumberMax, m_flStartTime, m_flStartTime + flDuration );
+}
+#endif
+
 //-----------------------------------------------------------------------------
 // Purpose: Shut down the commentary
 //-----------------------------------------------------------------------------
@@ -374,6 +451,10 @@ CHudCommentary::CHudCommentary( const char *name ) : vgui::Panel( NULL, "HudComm
 
 	m_hActiveNode = NULL;
 	m_bShouldPaint = true;
+
+#ifdef MAPBASE
+	m_pLabel = new vgui::Label( this, "HudCommentaryTextLabel", "" );
+#endif
 }
 
 void CHudCommentary::ApplySchemeSettings( vgui::IScheme *pScheme )
@@ -384,6 +465,11 @@ void CHudCommentary::ApplySchemeSettings( vgui::IScheme *pScheme )
 	{
 		SetBgColor( m_BGOverrideColor );
 	}
+
+#ifdef MAPBASE
+	m_pLabel->SetPaintBackgroundType( 2 );
+	m_pLabel->SetSize( 0, GetTall() );
+#endif
 }
 
 //-----------------------------------------------------------------------------
@@ -426,19 +512,12 @@ void CHudCommentary::Paint()
 	int x, y, wide, tall;
 	GetBounds( x, y, wide, tall );
 
- 	int xOffset = m_iBarX;
+	int xOffset = m_iBarX;
 	int yOffset = m_iBarY;
 
 	// Find our fade based on our time shown
 	Color clr = Color( 255, 170, 0, GetAlpha() );
 
-	// Draw the progress bar
-	vgui::surface()->DrawSetColor( clr );
-	vgui::surface()->DrawOutlinedRect( xOffset, yOffset, xOffset+m_iBarWide, yOffset+m_iBarTall );
-	vgui::surface()->DrawSetColor( clr );
-	vgui::surface()->DrawFilledRect( xOffset+2, yOffset+2, xOffset+(int)(flPercentage*m_iBarWide)-2, yOffset+m_iBarTall-2 );
-
-	// Draw the speaker names
 	// Get our scheme and font information
 	vgui::HScheme scheme = vgui::scheme()->GetScheme( "ClientScheme" );
 	vgui::HFont hFont = vgui::scheme()->GetIScheme(scheme)->GetFont( "CommentaryDefault" );
@@ -446,6 +525,34 @@ void CHudCommentary::Paint()
 	{
 		hFont = vgui::scheme()->GetIScheme(scheme)->GetFont( "Default" );
 	}
+
+#ifdef MAPBASE
+	if (m_bTextCommentary)
+	{
+		vgui::surface()->DrawSetColor( clr );
+		vgui::surface()->DrawOutlinedRect( xOffset, yOffset, xOffset + m_iBarWide, m_iTypeTextT - (yOffset + m_iBarTall) );
+
+		m_pLabel->SetFgColor( m_TextColor );
+		m_pLabel->SetBounds( xOffset + 4, yOffset + 4, m_iBarWide - 4, m_iTypeTextT - (m_iBarTall + 4) );
+		m_pLabel->SetFont( hFont );
+
+		// Draw the speaker names
+		/*vgui::surface()->DrawSetTextFont( hFont );
+		vgui::surface()->DrawSetTextColor( Color( 255, 200, 100, GetAlpha() ) );
+		vgui::surface()->DrawSetTextPos( xOffset+4, yOffset+4 );
+		vgui::surface()->DrawPrintText( m_pszText, wcslen( m_pszText ) );*/
+	}
+	else
+#endif
+	{
+		// Draw the progress bar
+		vgui::surface()->DrawSetColor( clr );
+		vgui::surface()->DrawOutlinedRect( xOffset, yOffset, xOffset+m_iBarWide, yOffset+m_iBarTall );
+		vgui::surface()->DrawSetColor( clr );
+		vgui::surface()->DrawFilledRect( xOffset+2, yOffset+2, xOffset+(int)(flPercentage*m_iBarWide)-2, yOffset+m_iBarTall-2 );
+	}
+
+	// Draw the speaker names
 	vgui::surface()->DrawSetTextFont( hFont );
 	vgui::surface()->DrawSetTextColor( clr ); 
 	vgui::surface()->DrawSetTextPos( m_iSpeakersX, m_iSpeakersY );
@@ -479,8 +586,15 @@ void CHudCommentary::Paint()
 	// Determine our text size, and move that far in from the right hand size (plus the offset)
 	int iCountWide, iCountTall;
 	vgui::surface()->GetTextSize( hFont, m_szCount, iCountWide, iCountTall );
+
+#ifdef MAPBASE
+	if (m_bTextCommentary)
+		vgui::surface()->DrawSetTextPos( wide - m_iTypeTextCountXFR - iCountWide, m_iTypeTextCountY );
+	else
+#endif
 	vgui::surface()->DrawSetTextPos( wide - m_iCountXFR - iCountWide, m_iCountY );
-	vgui::surface()->DrawPrintText( m_szCount, wcslen(m_szCount) );
+
+	vgui::surface()->DrawPrintText( m_szCount, wcslen( m_szCount ) );
 
 	// Draw the icon
  	vgui::surface()->DrawSetColor( Color(255,170,0,GetAlpha()) );
@@ -525,7 +639,17 @@ void CHudCommentary::StartCommentary( C_PointCommentaryNode *pNode, char *pszSpe
 	m_flStartTime = flStartTime;
 	m_flEndTime = flEndTime;
 	m_bHiding = false;
-	g_pVGuiLocalize->ConvertANSIToUnicode( pszSpeakers, m_szSpeakers, sizeof(m_szSpeakers) );
+#ifdef MAPBASE
+	m_bTextCommentary = false;
+#endif
+	g_pVGuiLocalize->ConvertANSIToUnicode( pszSpeakers, m_szSpeakers, sizeof( m_szSpeakers ) );
+
+#ifdef MAPBASE
+	SetBounds( m_iTypeAudioX, m_iTypeAudioY, m_iTypeAudioW, m_iTypeAudioT );
+	SetBgColor( m_bUseScriptBGColor ? m_BGOverrideColor : m_BackgroundColor );
+
+	m_pLabel->SetPaintEnabled( false );
+#endif
 
 	// Don't draw the element itself if closecaptions are on (and captions are always on in non-english mode)
 	ConVarRef pCVar( "closecaption" );
@@ -555,6 +679,65 @@ void CHudCommentary::StartCommentary( C_PointCommentaryNode *pNode, char *pszSpe
 	}
 }
 
+#ifdef MAPBASE
+//-----------------------------------------------------------------------------
+// Purpose: 
+//-----------------------------------------------------------------------------
+void CHudCommentary::StartTextCommentary( C_PointCommentaryNode *pNode, const char *pszText, char *pszSpeakers, int iNode, int iNodeMax, float flStartTime, float flEndTime )
+{
+	if ( (flEndTime - flStartTime) <= 0 )
+		return;
+
+	m_hActiveNode = pNode;
+	m_flStartTime = flStartTime;
+	m_flEndTime = flEndTime;
+	m_bHiding = false;
+	m_bTextCommentary = true;
+	g_pVGuiLocalize->ConvertANSIToUnicode( pszSpeakers, m_szSpeakers, sizeof( m_szSpeakers ) );
+
+	SetBounds( m_iTypeTextX, m_iTypeTextY, m_iTypeTextW, m_iTypeTextT );
+	SetBgColor( m_bUseScriptBGColor ? m_BGOverrideColor : m_TextBackgroundColor );
+
+	m_pLabel->SetText( pszText );
+	m_pLabel->SetWrap( true );
+	m_pLabel->SetPaintEnabled( true );
+	m_pLabel->SetPaintBackgroundEnabled( false );
+	m_pLabel->SetPaintBorderEnabled( false );
+	//m_pLabel->SizeToContents();
+	m_pLabel->SetContentAlignment( vgui::Label::a_northwest );
+
+	/*
+	// Find a localization token first.
+	// If one isn't found, use this static buffer.
+	static wchar_t szRawTextBuf[512];
+	m_pszText = g_pVGuiLocalize->Find( pszText );
+	if (!m_pszText)
+	{
+		g_pVGuiLocalize->ConvertANSIToUnicode( pszText, szRawTextBuf, sizeof( szRawTextBuf ) );
+		m_pszText = szRawTextBuf;
+	}
+	*/
+
+	m_bShouldPaint = true;
+	SetPaintBackgroundEnabled( m_bShouldPaint );
+
+	char sz[MAX_COUNT_STRING];
+	Q_snprintf( sz, sizeof(sz), "%d \\ %d", iNode, iNodeMax );
+	g_pVGuiLocalize->ConvertANSIToUnicode( sz, m_szCount, sizeof(m_szCount) );
+
+	// If the commentary just started, play the commentary fade in.
+	if ( fabs(flStartTime - gpGlobals->curtime) < 1.0 )
+	{
+		g_pClientMode->GetViewportAnimationController()->StartAnimationSequence( "ShowCommentary" );
+	}
+	else
+	{
+		// We're reloading a savegame that has an active commentary going in it. Don't fade in.
+		SetAlpha( 255 );
+	}
+}
+#endif
+
 //-----------------------------------------------------------------------------
 // Purpose: 
 //-----------------------------------------------------------------------------

sp/src/game/server/CommentarySystem.cpp

@@ -138,6 +138,10 @@ private:
 	CNetworkVar( string_t, m_iszSpeakers );
 	CNetworkVar( int, m_iNodeNumber );
 	CNetworkVar( int, m_iNodeNumberMax );
+
+#ifdef MAPBASE
+	CNetworkVar( bool, m_bTextCommentary );
+#endif
 };
 
 BEGIN_DATADESC( CPointCommentaryNode )
@@ -166,6 +170,9 @@ BEGIN_DATADESC( CPointCommentaryNode )
 	DEFINE_FIELD( m_bPreventChangesWhileMoving, FIELD_BOOLEAN ),
 	DEFINE_KEYFIELD( m_bDisabled, FIELD_BOOLEAN, "start_disabled" ),
 	DEFINE_KEYFIELD( m_vecTeleportOrigin, FIELD_VECTOR, "teleport_origin" ),
+#ifdef MAPBASE
+	DEFINE_KEYFIELD( m_bTextCommentary, FIELD_BOOLEAN, "type" ), // Open to additional types in the future
+#endif
 
 	// Outputs
 	DEFINE_OUTPUT( m_pOnCommentaryStarted, "OnCommentaryStarted" ),
@@ -192,6 +199,9 @@ IMPLEMENT_SERVERCLASS_ST( CPointCommentaryNode, DT_PointCommentaryNode )
 	SendPropInt( SENDINFO(m_iNodeNumber), 8, SPROP_UNSIGNED ),
 	SendPropInt( SENDINFO(m_iNodeNumberMax), 8, SPROP_UNSIGNED ),
 	SendPropEHandle( SENDINFO(m_hViewPosition) ),
+#ifdef MAPBASE
+	SendPropBool( SENDINFO( m_bTextCommentary ) ),
+#endif
 END_SEND_TABLE()
 
 LINK_ENTITY_TO_CLASS( point_commentary_node, CPointCommentaryNode );