MapBase/source-sdk-2013-mapbase
1
0
Fork 0
mirror of https://github.com/mapbase-source/source-sdk-2013.git synced 2024-12-25 14:25:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Initial game instructor save/restore prototype (not yet functional)

Browse Source
This commit is contained in:
Blixibon 2021-03-04 11:36:48 -06:00
parent fd600b53aa
commit a1cb3611a3
4 changed files with 317 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
sp/src/game/client/c_baselesson.h
View File

@ -117,6 +117,10 @@ public:
const char *GetGroup() { return m_szLessonGroup.String(); }
void SetEnabled( bool bEnabled ) { m_bDisabled = !bEnabled; }
#ifdef MAPBASE
DECLARE_DATADESC();
#endif
protected:
void MarkSucceeded( void );
void CloseOpportunity( const char *pchReason );
@ -191,6 +195,9 @@ class CTextLesson : public CBaseLesson
{
public:
DECLARE_LESSON( CTextLesson, CBaseLesson );
#ifdef MAPBASE
DECLARE_DATADESC();
#endif
void Init( void ); // NOT virtual, each constructor calls their own
virtual void Start( void );
@ -209,6 +216,9 @@ class CIconLesson : public CTextLesson
{
public:
DECLARE_LESSON( CIconLesson, CTextLesson );
#ifdef MAPBASE
DECLARE_DATADESC();
#endif
void Init( void ); // NOT virtual, each constructor calls their own
virtual void Start( void );
@ -376,6 +386,9 @@ class CScriptedIconLesson : public CIconLesson
{
public:
DECLARE_LESSON( CScriptedIconLesson, CIconLesson )
#ifdef MAPBASE
DECLARE_DATADESC();
#endif
virtual ~CScriptedIconLesson( void );

287
sp/src/game/client/c_gameinstructor.cpp
View File

@ -13,6 +13,9 @@
#include "ixboxsystem.h"
#include "tier0/icommandline.h"
#include "iclientmode.h"
#ifdef MAPBASE
#include "isaverestore.h"
#endif
// memdbgon must be the last include file in a .cpp file!!!
#include "tier0/memdbgon.h"
@ -1291,6 +1294,290 @@ void C_GameInstructor::InitLessonPrerequisites()
m_Lessons[ i ]->InitPrerequisites();
}
#ifdef MAPBASE
//=========================================================
// Save/Restore
//=========================================================
class CInstructorSymbolDataOps : public CDefSaveRestoreOps
{
public:
CInstructorSymbolDataOps() {}
virtual void Save( const SaveRestoreFieldInfo_t &fieldInfo, ISave *pSave )
{
CGameInstructorSymbol *sym = ((CGameInstructorSymbol *)fieldInfo.pField);
pSave->WriteString( sym->String() );
}
virtual void Restore( const SaveRestoreFieldInfo_t &fieldInfo, IRestore *pRestore )
{
CGameInstructorSymbol *sym = ((CGameInstructorSymbol *)fieldInfo.pField);
char tmp[1024];
pRestore->ReadString( tmp, sizeof(tmp), 0 );
*sym = tmp;
}
virtual void MakeEmpty( const SaveRestoreFieldInfo_t &fieldInfo )
{
CGameInstructorSymbol *sym = ((CGameInstructorSymbol *)fieldInfo.pField);
*sym = CGameInstructorSymbol();
}
virtual bool IsEmpty( const SaveRestoreFieldInfo_t &fieldInfo )
{
CGameInstructorSymbol *sym = ((CGameInstructorSymbol *)fieldInfo.pField);
return (*sym) == CGameInstructorSymbol() ? true : false;
}
};
static CInstructorSymbolDataOps g_InstructorSymbolDataOps;
BEGIN_DATADESC_NO_BASE( CBaseLesson )
DEFINE_FIELD( m_iInstanceType, FIELD_INTEGER ),
DEFINE_FIELD( m_iPriority, FIELD_INTEGER ),
DEFINE_CUSTOM_FIELD( m_stringReplaceKey, &g_InstructorSymbolDataOps ),
DEFINE_FIELD( m_iFixedInstancesMax, FIELD_INTEGER ),
DEFINE_FIELD( m_bReplaceOnlyWhenStopped, FIELD_BOOLEAN ),
DEFINE_FIELD( m_iTeam, FIELD_INTEGER ),
DEFINE_FIELD( m_bOnlyKeyboard, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bOnlyGamepad, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bWasDisplayed, FIELD_BOOLEAN ),
DEFINE_FIELD( m_fLockDuration, FIELD_INTEGER ),
DEFINE_FIELD( m_fTimeout, FIELD_INTEGER ),
DEFINE_FIELD( m_fInitTime, FIELD_FLOAT ),
DEFINE_FIELD( m_fStartTime, FIELD_FLOAT ),
DEFINE_FIELD( m_fLockTime, FIELD_FLOAT ),
DEFINE_FIELD( m_fUpdateInterval, FIELD_FLOAT ),
DEFINE_FIELD( m_iInstanceType, FIELD_INTEGER ),
DEFINE_FIELD( m_bHasPlayedSound, FIELD_BOOLEAN ),
DEFINE_CUSTOM_FIELD( m_szStartSound, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szLessonGroup, &g_InstructorSymbolDataOps ),
DEFINE_FIELD( m_bCanOpenWhenDead, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bBumpWithTimeoutWhenLearned, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bCanTimeoutWhileInactive, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bDisabled, FIELD_BOOLEAN ),
END_DATADESC()
BEGIN_DATADESC( CScriptedIconLesson )
// Macro fields
DEFINE_FIELD( m_hEntity1, FIELD_EHANDLE ),
DEFINE_FIELD( m_hEntity2, FIELD_EHANDLE ),
DEFINE_CUSTOM_FIELD( m_szString1, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szString2, &g_InstructorSymbolDataOps ),
DEFINE_FIELD( m_iInteger1, FIELD_INTEGER ),
DEFINE_FIELD( m_iInteger2, FIELD_INTEGER ),
DEFINE_FIELD( m_fFloat1, FIELD_FLOAT ),
DEFINE_FIELD( m_fFloat2, FIELD_FLOAT ),
END_DATADESC()
BEGIN_DATADESC( CTextLesson )
DEFINE_CUSTOM_FIELD( m_szDisplayText, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szDisplayParamText, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szBinding, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szGamepadBinding, &g_InstructorSymbolDataOps ),
END_DATADESC()
BEGIN_DATADESC( CIconLesson )
DEFINE_FIELD( m_hLocatorTarget, FIELD_INTEGER ),
//DEFINE_FIELD( m_fCurrentDistance, FIELD_FLOAT ),
DEFINE_FIELD( m_fOnScreenStartTime, FIELD_FLOAT ),
//DEFINE_FIELD( m_fUpdateDistanceTime, FIELD_FLOAT ),
// Macro fields
DEFINE_FIELD( m_hIconTarget, FIELD_EHANDLE ),
DEFINE_CUSTOM_FIELD( m_szVguiTargetName, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szVguiTargetLookup, &g_InstructorSymbolDataOps ),
DEFINE_FIELD( m_nVguiTargetEdge, FIELD_INTEGER ),
DEFINE_FIELD( m_flUpOffset, FIELD_FLOAT ),
DEFINE_FIELD( m_flRelativeUpOffset, FIELD_FLOAT ),
DEFINE_FIELD( m_fFixedPositionX, FIELD_FLOAT ),
DEFINE_FIELD( m_fFixedPositionY, FIELD_FLOAT ),
DEFINE_FIELD( m_iFlags, FIELD_INTEGER ),
DEFINE_FIELD( m_fRange, FIELD_FLOAT ),
DEFINE_FIELD( m_fCurrentDistance, FIELD_FLOAT ),
DEFINE_FIELD( m_fOnScreenStartTime, FIELD_FLOAT ),
DEFINE_FIELD( m_fUpdateDistanceTime, FIELD_FLOAT ),
DEFINE_CUSTOM_FIELD( m_szOnscreenIcon, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szOffscreenIcon, &g_InstructorSymbolDataOps ),
DEFINE_CUSTOM_FIELD( m_szCaptionColor, &g_InstructorSymbolDataOps ),
DEFINE_FIELD( m_bFixedPosition, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bNoIconTarget, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bAllowNodrawTarget, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bVisible, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bShowWhenOccluded, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bNoOffscreen, FIELD_BOOLEAN ),
DEFINE_FIELD( m_bForceCaption, FIELD_BOOLEAN ),
DEFINE_FIELD( m_iIconTargetPos, FIELD_INTEGER ),
DEFINE_CUSTOM_FIELD( m_szHudHint, &g_InstructorSymbolDataOps ),
END_DATADESC()
void C_GameInstructor::WriteOpportunityState( ISave *pSave )
{
int iNumOpportunities = m_OpenOpportunities.Count();
pSave->WriteInt( &iNumOpportunities );
for ( int i = iNumOpportunities - 1; i >= 0; --i )
{
CBaseLesson *pLesson = m_OpenOpportunities[ i ];
CBaseLesson *pRootLesson = pLesson->GetRoot();
// Write the lesson name
pSave->WriteString( pLesson->GetName() );
// Write the lesson data
pSave->WriteAll( pLesson, pLesson->GetDataDescMap() );
if (pRootLesson)
{
// Write the root lesson name
pSave->WriteString( pRootLesson->GetName() );
}
else
{
// No root lesson...?
pSave->WriteString( "" );
}
ConColorMsg( CBaseLesson::m_rgbaVerboseOpen, "\t%s\n", pLesson->GetName() );
}
}
void C_GameInstructor::ReadOpportunityState( IRestore *pRestore )
{
int iNumOpportunities = pRestore->ReadInt();
for ( int i = iNumOpportunities; i >= 0; --i )
{
char szLessonName[ 256 ];
pRestore->ReadString( szLessonName, sizeof(szLessonName), 0 );
CBaseLesson *pLesson = GetLesson_Internal( szLessonName );
if (pLesson)
{
// Read the lesson data
pRestore->ReadAll( pLesson, pLesson->GetDataDescMap() );
// Read root lesson
pRestore->ReadString( szLessonName, sizeof(szLessonName), 0 );
if (szLessonName[0] != '\0')
{
CBaseLesson *pRootLesson = GetLesson_Internal( szLessonName );
if (pRootLesson)
pLesson->SetRoot( pRootLesson );
}
m_OpenOpportunities.AddToTail( pLesson );
pLesson->Start();
ConColorMsg( CBaseLesson::m_rgbaVerboseOpen, "\t%s\n", pLesson->GetName() );
}
else
{
Warning( "Can't find restored lesson %s\n", szLessonName );
}
}
}
void WriteOpportunityState( ISave *pSave );
void ReadOpportunityState( IRestore *pRestore );
static short GAME_INSTRUCTOR_SAVE_RESTORE_VERSION = 1;
//-----------------------------------------------------------------------------
class CGameInstructorSaveRestoreBlockHandler : public CDefSaveRestoreBlockHandler
{
public:
CGameInstructorSaveRestoreBlockHandler()
{
}
const char *GetBlockName()
{
return "GameInstructor";
}
//---------------------------------
void Save( ISave *pSave )
{
pSave->StartBlock();
g_GameInstructor.WriteOpportunityState( pSave );
pSave->EndBlock();
}
//---------------------------------
void WriteSaveHeaders( ISave *pSave )
{
pSave->WriteShort( &GAME_INSTRUCTOR_SAVE_RESTORE_VERSION );
}
//---------------------------------
void ReadRestoreHeaders( IRestore *pRestore )
{
// No reason why any future version shouldn't try to retain backward compatability. The default here is to not do so.
short version;
pRestore->ReadShort( &version );
m_fDoLoad = ( version == GAME_INSTRUCTOR_SAVE_RESTORE_VERSION );
}
//---------------------------------
void Restore( IRestore *pRestore, bool createPlayers )
{
if ( !m_fDoLoad )
{
return;
}
pRestore->StartBlock();
g_GameInstructor.ReadOpportunityState( pRestore );
pRestore->EndBlock();
}
private:
bool m_fDoLoad;
};
//-----------------------------------------------------------------------------
CGameInstructorSaveRestoreBlockHandler g_GameInstructorSaveRestoreBlockHandler;
//-------------------------------------
ISaveRestoreBlockHandler *GetGameInstructorSaveRestoreBlockHandler()
{
return &g_GameInstructorSaveRestoreBlockHandler;
}
#endif
//=========================================================
// Commands
//=========================================================

10
sp/src/game/client/c_gameinstructor.h
View File

@ -72,6 +72,11 @@ public:
// Mapbase needs this to be public for map-specific file system
void ReadLessonsFromFile( const char *pchFileName );
#ifdef MAPBASE
void WriteOpportunityState( ISave *pSave );
void ReadOpportunityState( IRestore *pRestore );
#endif
private:
void FindErrors( void );
@ -114,5 +119,10 @@ C_GameInstructor &GetGameInstructor();
void GameInstructor_Init();
void GameInstructor_Shutdown();
#ifdef MAPBASE
class ISaveRestoreBlockHandler;
ISaveRestoreBlockHandler *GetGameInstructorSaveRestoreBlockHandler();
#endif
#endif // _C_GAMEINSTRUCTOR_H_

7
sp/src/game/client/cdll_client_int.cpp
View File

@ -147,6 +147,10 @@
#include "fbxsystem/fbxsystem.h"
#endif
#ifdef MAPBASE
#include "c_gameinstructor.h"
#endif
#ifdef MAPBASE_VSCRIPT
#include "vscript_client.h"
#endif
@ -1108,6 +1112,9 @@ int CHLClient::Init( CreateInterfaceFn appSystemFactory, CreateInterfaceFn physi
g_pGameSaveRestoreBlockSet->AddBlockHandler( GetEntitySaveRestoreBlockHandler() );
g_pGameSaveRestoreBlockSet->AddBlockHandler( GetPhysSaveRestoreBlockHandler() );
g_pGameSaveRestoreBlockSet->AddBlockHandler( GetViewEffectsRestoreBlockHandler() );
#ifdef MAPBASE
g_pGameSaveRestoreBlockSet->AddBlockHandler( GetGameInstructorSaveRestoreBlockHandler() );
#endif
#ifdef MAPBASE_VSCRIPT
g_pGameSaveRestoreBlockSet->AddBlockHandler( GetVScriptSaveRestoreBlockHandler() );
#endif