source-engine/game/client/hl2/hud_credits.cpp
2022-03-01 23:00:42 +03:00

736 lines
17 KiB
C++

//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose:
//
//=============================================================================//
#include "cbase.h"
#include "hudelement.h"
#include "hud_numericdisplay.h"
#include <vgui_controls/Panel.h>
#include "hud.h"
#include "hud_suitpower.h"
#include "hud_macros.h"
#include "iclientmode.h"
#include <vgui_controls/AnimationController.h>
#include <vgui/ISurface.h>
#include <vgui/ILocalize.h>
#include "KeyValues.h"
#include "filesystem.h"
// memdbgon must be the last include file in a .cpp file!!!
#include "tier0/memdbgon.h"
struct creditname_t
{
char szCreditName[256];
char szFontName[256];
float flYPos;
float flXPos;
bool bActive;
float flTime;
float flTimeAdd;
float flTimeStart;
int iSlot;
};
#define CREDITS_FILE "scripts/credits.txt"
enum
{
LOGO_FADEIN = 0,
LOGO_FADEHOLD,
LOGO_FADEOUT,
LOGO_FADEOFF,
};
#define CREDITS_LOGO 1
#define CREDITS_INTRO 2
#define CREDITS_OUTRO 3
bool g_bRollingCredits = false;
int g_iCreditsPixelHeight = 0;
//-----------------------------------------------------------------------------
// Purpose: Shows the flashlight icon
//-----------------------------------------------------------------------------
class CHudCredits : public CHudElement, public vgui::Panel
{
DECLARE_CLASS_SIMPLE( CHudCredits, vgui::Panel );
public:
CHudCredits( const char *pElementName );
virtual void Init( void );
virtual void LevelShutdown( void );
int GetStringPixelWidth ( wchar_t *pString, vgui::HFont hFont );
void MsgFunc_CreditsMsg( bf_read &msg );
void MsgFunc_LogoTimeMsg( bf_read &msg );
virtual bool ShouldDraw( void )
{
g_bRollingCredits = IsActive();
if ( g_bRollingCredits && m_iCreditsType == CREDITS_INTRO )
g_bRollingCredits = false;
return IsActive();
}
protected:
virtual void Paint();
virtual void ApplySchemeSettings( vgui::IScheme *pScheme );
private:
void Clear();
void ReadNames( KeyValues *pKeyValue );
void ReadParams( KeyValues *pKeyValue );
void PrepareCredits( const char *pKeyName );
void DrawOutroCreditsName( void );
void DrawIntroCreditsName( void );
void DrawLogo( void );
void PrepareLogo( float flTime );
void PrepareOutroCredits( void );
void PrepareIntroCredits( void );
float FadeBlend( float fadein, float fadeout, float hold, float localTime );
void PrepareLine( vgui::HFont hFont, char const *pchLine );
CPanelAnimationVar( vgui::HFont, m_hTextFont, "TextFont", "Default" );
CPanelAnimationVar( Color, m_TextColor, "TextColor", "FgColor" );
CUtlVector<creditname_t> m_CreditsList;
float m_flScrollTime;
float m_flSeparation;
float m_flFadeTime;
bool m_bLastOneInPlace;
int m_Alpha;
int m_iCreditsType;
int m_iLogoState;
float m_flFadeInTime;
float m_flFadeHoldTime;
float m_flFadeOutTime;
float m_flNextStartTime;
float m_flPauseBetweenWaves;
float m_flLogoTimeMod;
float m_flLogoTime;
float m_flLogoDesiredLength;
float m_flX;
float m_flY;
char m_szLogo[256];
char m_szLogo2[256];
Color m_cColor;
};
void CHudCredits::PrepareCredits( const char *pKeyName )
{
Clear();
KeyValues *pKV= new KeyValues( "CreditsFile" );
if ( !pKV->LoadFromFile( filesystem, CREDITS_FILE, "MOD" ) )
{
pKV->deleteThis();
Assert( !"env_credits couldn't be initialized!" );
return;
}
KeyValues *pKVSubkey;
if ( pKeyName )
{
pKVSubkey = pKV->FindKey( pKeyName );
ReadNames( pKVSubkey );
}
pKVSubkey = pKV->FindKey( "CreditsParams" );
ReadParams( pKVSubkey );
pKV->deleteThis();
}
using namespace vgui;
DECLARE_HUDELEMENT( CHudCredits );
DECLARE_HUD_MESSAGE( CHudCredits, CreditsMsg );
DECLARE_HUD_MESSAGE( CHudCredits, LogoTimeMsg );
//-----------------------------------------------------------------------------
// Purpose: Constructor
//-----------------------------------------------------------------------------
CHudCredits::CHudCredits( const char *pElementName ) : CHudElement( pElementName ), BaseClass( NULL, "HudCredits" )
{
vgui::Panel *pParent = g_pClientMode->GetViewport();
SetParent( pParent );
}
void CHudCredits::LevelShutdown()
{
Clear();
}
void CHudCredits::Clear( void )
{
SetActive( false );
m_CreditsList.RemoveAll();
m_bLastOneInPlace = false;
m_Alpha = m_TextColor[3];
m_iLogoState = LOGO_FADEOFF;
}
//-----------------------------------------------------------------------------
// Purpose:
//-----------------------------------------------------------------------------
void CHudCredits::Init()
{
HOOK_HUD_MESSAGE( CHudCredits, CreditsMsg );
HOOK_HUD_MESSAGE( CHudCredits, LogoTimeMsg );
SetActive( false );
}
void CHudCredits::ReadNames( KeyValues *pKeyValue )
{
if ( pKeyValue == NULL )
{
Assert( !"CHudCredits couldn't be initialized!" );
return;
}
// Now try and parse out each act busy anim
KeyValues *pKVNames = pKeyValue->GetFirstSubKey();
while ( pKVNames )
{
creditname_t Credits;
Q_strcpy( Credits.szCreditName, pKVNames->GetName());
Q_strcpy( Credits.szFontName, pKeyValue->GetString( Credits.szCreditName, "Default" ) );
m_CreditsList.AddToTail( Credits );
pKVNames = pKVNames->GetNextKey();
}
}
void CHudCredits::ReadParams( KeyValues *pKeyValue )
{
if ( pKeyValue == NULL )
{
Assert( !"CHudCredits couldn't be initialized!" );
return;
}
m_flScrollTime = pKeyValue->GetFloat( "scrolltime", 57 );
m_flSeparation = pKeyValue->GetFloat( "separation", 5 );
m_flFadeInTime = pKeyValue->GetFloat( "fadeintime", 1 );
m_flFadeHoldTime = pKeyValue->GetFloat( "fadeholdtime", 3 );
m_flFadeOutTime = pKeyValue->GetFloat( "fadeouttime", 2 );
m_flNextStartTime = pKeyValue->GetFloat( "nextfadetime", 2 );
m_flPauseBetweenWaves = pKeyValue->GetFloat( "pausebetweenwaves", 2 );
m_flLogoTimeMod = pKeyValue->GetFloat( "logotime", 2 );
m_flX = pKeyValue->GetFloat( "posx", 2 );
m_flY = pKeyValue->GetFloat( "posy", 2 );
m_cColor = pKeyValue->GetColor( "color" );
Q_strncpy( m_szLogo, pKeyValue->GetString( "logo", "HALF-LIFE'" ), sizeof( m_szLogo ) );
Q_strncpy( m_szLogo2, pKeyValue->GetString( "logo2", "" ), sizeof( m_szLogo2 ) );
}
int CHudCredits::GetStringPixelWidth( wchar_t *pString, vgui::HFont hFont )
{
int iLength = 0;
for ( wchar_t *wch = pString; *wch != 0; wch++ )
{
iLength += surface()->GetCharacterWidth( hFont, *wch );
}
return iLength;
}
void CHudCredits::DrawOutroCreditsName( void )
{
if ( m_CreditsList.Count() == 0 )
return;
// fill the screen
int iWidth, iTall;
GetHudSize(iWidth, iTall);
SetSize( iWidth, iTall );
for ( int i = 0; i < m_CreditsList.Count(); i++ )
{
creditname_t *pCredit = &m_CreditsList[i];
if ( pCredit == NULL )
continue;
vgui::HScheme scheme = vgui::scheme()->GetScheme( "ClientScheme" );
vgui::HFont m_hTFont = vgui::scheme()->GetIScheme(scheme)->GetFont( pCredit->szFontName, true );
int iFontTall = surface()->GetFontTall ( m_hTFont );
if ( pCredit->flYPos < -iFontTall || pCredit->flYPos > iTall )
{
pCredit->bActive = false;
}
else
{
pCredit->bActive = true;
}
Color cColor = m_TextColor;
//HACKHACK
//Last one stays on screen and fades out
if ( i == m_CreditsList.Count()-1 )
{
if ( m_bLastOneInPlace == false )
{
pCredit->flYPos -= gpGlobals->frametime * ( (float)g_iCreditsPixelHeight / m_flScrollTime );
if ( (int)pCredit->flYPos + ( iFontTall / 2 ) <= iTall / 2 )
{
m_bLastOneInPlace = true;
// 360 certification requires that we not hold a static image too long.
m_flFadeTime = gpGlobals->curtime + ( IsConsole() ? 2.0f : 10.0f );
}
}
else
{
if ( m_flFadeTime <= gpGlobals->curtime )
{
if ( m_Alpha > 0 )
{
m_Alpha -= gpGlobals->frametime * ( m_flScrollTime * 2 );
if ( m_Alpha <= 0 )
{
pCredit->bActive = false;
engine->ClientCmd( "creditsdone" );
}
}
}
cColor[3] = MAX( 0, m_Alpha );
}
}
else
{
pCredit->flYPos -= gpGlobals->frametime * ( (float)g_iCreditsPixelHeight / m_flScrollTime );
}
if ( pCredit->bActive == false )
continue;
surface()->DrawSetTextFont( m_hTFont );
surface()->DrawSetTextColor( cColor[0], cColor[1], cColor[2], cColor[3] );
wchar_t unicode[256];
if ( pCredit->szCreditName[0] == '#' )
{
g_pVGuiLocalize->ConstructString( unicode, sizeof(unicode), g_pVGuiLocalize->Find(pCredit->szCreditName), 0 );
}
else
{
g_pVGuiLocalize->ConvertANSIToUnicode( pCredit->szCreditName, unicode, sizeof( unicode ) );
}
int iStringWidth = GetStringPixelWidth( unicode, m_hTFont );
surface()->DrawSetTextPos( ( iWidth / 2 ) - ( iStringWidth / 2 ), pCredit->flYPos );
surface()->DrawUnicodeString( unicode );
}
}
void CHudCredits::DrawLogo( void )
{
if( m_iLogoState == LOGO_FADEOFF )
{
SetActive( false );
return;
}
switch( m_iLogoState )
{
case LOGO_FADEIN:
{
float flDeltaTime = ( m_flFadeTime - gpGlobals->curtime );
m_Alpha = MAX( 0, RemapValClamped( flDeltaTime, 5.0f, 0, -128, 255 ) );
if ( flDeltaTime <= 0.0f )
{
m_iLogoState = LOGO_FADEHOLD;
m_flFadeTime = gpGlobals->curtime + m_flLogoDesiredLength;
}
break;
}
case LOGO_FADEHOLD:
{
if ( m_flFadeTime <= gpGlobals->curtime )
{
m_iLogoState = LOGO_FADEOUT;
m_flFadeTime = gpGlobals->curtime + 2.0f;
}
break;
}
case LOGO_FADEOUT:
{
float flDeltaTime = ( m_flFadeTime - gpGlobals->curtime );
m_Alpha = RemapValClamped( flDeltaTime, 0.0f, 2.0f, 0, 255 );
if ( flDeltaTime <= 0.0f )
{
m_iLogoState = LOGO_FADEOFF;
SetActive( false );
}
break;
}
}
// fill the screen
int iWidth, iTall;
GetHudSize(iWidth, iTall);
SetSize( iWidth, iTall );
char szLogoFont[64];
if ( IsXbox() )
{
Q_snprintf( szLogoFont, sizeof( szLogoFont ), "WeaponIcons_Small" );
}
else if ( hl2_episodic.GetBool() )
{
Q_snprintf( szLogoFont, sizeof( szLogoFont ), "ClientTitleFont" );
}
else
{
Q_snprintf( szLogoFont, sizeof( szLogoFont ), "WeaponIcons" );
}
vgui::HScheme scheme = vgui::scheme()->GetScheme( "ClientScheme" );
vgui::HFont m_hTFont = vgui::scheme()->GetIScheme(scheme)->GetFont( szLogoFont );
int iFontTall = surface()->GetFontTall ( m_hTFont );
Color cColor = m_TextColor;
cColor[3] = m_Alpha;
surface()->DrawSetTextFont( m_hTFont );
surface()->DrawSetTextColor( cColor[0], cColor[1], cColor[2], cColor[3] );
wchar_t unicode[256];
g_pVGuiLocalize->ConvertANSIToUnicode( m_szLogo, unicode, sizeof( unicode ) );
int iStringWidth = GetStringPixelWidth( unicode, m_hTFont );
surface()->DrawSetTextPos( ( iWidth / 2 ) - ( iStringWidth / 2 ), ( iTall / 2 ) - ( iFontTall / 2 ) );
surface()->DrawUnicodeString( unicode );
if ( Q_strlen( m_szLogo2 ) > 0 )
{
g_pVGuiLocalize->ConvertANSIToUnicode( m_szLogo2, unicode, sizeof( unicode ) );
iStringWidth = GetStringPixelWidth( unicode, m_hTFont );
surface()->DrawSetTextPos( ( iWidth / 2 ) - ( iStringWidth / 2 ), ( iTall / 2 ) + ( iFontTall / 2 ));
surface()->DrawUnicodeString( unicode );
}
}
//-----------------------------------------------------------------------------
// Purpose:
//-----------------------------------------------------------------------------
float CHudCredits::FadeBlend( float fadein, float fadeout, float hold, float localTime )
{
float fadeTime = fadein + hold;
float fadeBlend;
if ( localTime < 0 )
return 0;
if ( localTime < fadein )
{
fadeBlend = 1 - ((fadein - localTime) / fadein);
}
else if ( localTime > fadeTime )
{
if ( fadeout > 0 )
fadeBlend = 1 - ((localTime - fadeTime) / fadeout);
else
fadeBlend = 0;
}
else
fadeBlend = 1;
if ( fadeBlend < 0 )
fadeBlend = 0;
return fadeBlend;
}
void CHudCredits::DrawIntroCreditsName( void )
{
if ( m_CreditsList.Count() == 0 )
return;
// fill the screen
int iWidth, iTall;
GetHudSize(iWidth, iTall);
SetSize( iWidth, iTall );
for ( int i = 0; i < m_CreditsList.Count(); i++ )
{
creditname_t *pCredit = &m_CreditsList[i];
if ( pCredit == NULL )
continue;
if ( pCredit->bActive == false )
continue;
vgui::HScheme scheme = vgui::scheme()->GetScheme( "ClientScheme" );
vgui::HFont m_hTFont = vgui::scheme()->GetIScheme(scheme)->GetFont( pCredit->szFontName );
float localTime = gpGlobals->curtime - pCredit->flTimeStart;
surface()->DrawSetTextFont( m_hTFont );
surface()->DrawSetTextColor( m_cColor[0], m_cColor[1], m_cColor[2], FadeBlend( m_flFadeInTime, m_flFadeOutTime, m_flFadeHoldTime + pCredit->flTimeAdd, localTime ) * m_cColor[3] );
wchar_t unicode[256];
g_pVGuiLocalize->ConvertANSIToUnicode( pCredit->szCreditName, unicode, sizeof( unicode ) );
surface()->DrawSetTextPos( XRES( pCredit->flXPos ), YRES( pCredit->flYPos ) );
surface()->DrawUnicodeString( unicode );
if ( m_flLogoTime > gpGlobals->curtime )
continue;
if ( pCredit->flTime - m_flNextStartTime <= gpGlobals->curtime )
{
if ( m_CreditsList.IsValidIndex( i + 3 ) )
{
creditname_t *pNextCredits = &m_CreditsList[i + 3];
if ( pNextCredits && pNextCredits->flTime == 0.0f )
{
pNextCredits->bActive = true;
if ( i < 3 )
{
pNextCredits->flTimeAdd = ( i + 1.0f );
pNextCredits->flTime = gpGlobals->curtime + m_flFadeInTime + m_flFadeOutTime + m_flFadeHoldTime + pNextCredits->flTimeAdd;
}
else
{
pNextCredits->flTimeAdd = m_flPauseBetweenWaves;
pNextCredits->flTime = gpGlobals->curtime + m_flFadeInTime + m_flFadeOutTime + m_flFadeHoldTime + pNextCredits->flTimeAdd;
}
pNextCredits->flTimeStart = gpGlobals->curtime;
pNextCredits->iSlot = pCredit->iSlot;
}
}
}
if ( pCredit->flTime <= gpGlobals->curtime )
{
pCredit->bActive = false;
if ( i == m_CreditsList.Count()-1 )
{
Clear();
}
}
}
}
void CHudCredits::ApplySchemeSettings( IScheme *pScheme )
{
BaseClass::ApplySchemeSettings( pScheme );
SetVisible( ShouldDraw() );
SetBgColor( Color(0, 0, 0, 0) );
}
void CHudCredits::Paint()
{
if ( m_iCreditsType == CREDITS_LOGO )
{
DrawLogo();
}
else if ( m_iCreditsType == CREDITS_INTRO )
{
DrawIntroCreditsName();
}
else if ( m_iCreditsType == CREDITS_OUTRO )
{
DrawOutroCreditsName();
}
}
void CHudCredits::PrepareLogo( float flTime )
{
// Only showing the logo. Just load the CreditsParams section.
PrepareCredits( NULL );
m_Alpha = 0;
m_flLogoDesiredLength = flTime;
m_flFadeTime = gpGlobals->curtime + 5.0f;
m_iLogoState = LOGO_FADEIN;
SetActive( true );
}
void CHudCredits::PrepareLine( vgui::HFont hFont, char const *pchLine )
{
Assert( pchLine );
wchar_t unicode[256];
if ( pchLine[0] == '#' )
{
g_pVGuiLocalize->ConstructString( unicode, sizeof(unicode), g_pVGuiLocalize->Find(pchLine), 0 );
}
else
{
g_pVGuiLocalize->ConvertANSIToUnicode( pchLine, unicode, sizeof( unicode ) );
}
surface()->PrecacheFontCharacters( hFont, unicode );
}
void CHudCredits::PrepareOutroCredits( void )
{
PrepareCredits( "OutroCreditsNames" );
if ( m_CreditsList.Count() == 0 )
return;
// fill the screen
int iWidth, iTall;
GetHudSize(iWidth, iTall);
SetSize( iWidth, iTall );
int iHeight = iTall;
for ( int i = 0; i < m_CreditsList.Count(); i++ )
{
creditname_t *pCredit = &m_CreditsList[i];
if ( pCredit == NULL )
continue;
vgui::HScheme scheme = vgui::scheme()->GetScheme( "ClientScheme" );
vgui::HFont m_hTFont = vgui::scheme()->GetIScheme(scheme)->GetFont( pCredit->szFontName, true );
pCredit->flYPos = iHeight;
pCredit->bActive = false;
iHeight += surface()->GetFontTall ( m_hTFont ) + m_flSeparation;
PrepareLine( m_hTFont, pCredit->szCreditName );
}
SetActive( true );
g_iCreditsPixelHeight = iHeight;
}
void CHudCredits::PrepareIntroCredits( void )
{
PrepareCredits( "IntroCreditsNames" );
int iSlot = 0;
for ( int i = 0; i < m_CreditsList.Count(); i++ )
{
creditname_t *pCredit = &m_CreditsList[i];
if ( pCredit == NULL )
continue;
vgui::HScheme scheme = vgui::scheme()->GetScheme( "ClientScheme" );
vgui::HFont m_hTFont = vgui::scheme()->GetIScheme(scheme)->GetFont( pCredit->szFontName );
pCredit->flYPos = m_flY + ( iSlot * surface()->GetFontTall ( m_hTFont ) );
pCredit->flXPos = m_flX;
if ( i < 3 )
{
pCredit->bActive = true;
pCredit->iSlot = iSlot;
pCredit->flTime = gpGlobals->curtime + m_flFadeInTime + m_flFadeOutTime + m_flFadeHoldTime;
pCredit->flTimeStart = gpGlobals->curtime;
m_flLogoTime = pCredit->flTime + m_flLogoTimeMod;
}
else
{
pCredit->bActive = false;
pCredit->flTime = 0.0f;
}
iSlot = ( iSlot + 1 ) % 3;
PrepareLine( m_hTFont, pCredit->szCreditName );
}
SetActive( true );
}
void CHudCredits::MsgFunc_CreditsMsg( bf_read &msg )
{
m_iCreditsType = msg.ReadByte();
switch ( m_iCreditsType )
{
case CREDITS_LOGO:
{
PrepareLogo( 5.0f );
break;
}
case CREDITS_INTRO:
{
PrepareIntroCredits();
break;
}
case CREDITS_OUTRO:
{
PrepareOutroCredits();
break;
}
}
}
void CHudCredits::MsgFunc_LogoTimeMsg( bf_read &msg )
{
m_iCreditsType = CREDITS_LOGO;
PrepareLogo( msg.ReadFloat() );
}