summaryrefslogtreecommitdiff
path: root/game/shared/motd.h
diff options
context:
space:
mode:
authorFluorescentCIAAfricanAmerican <[email protected]>2020-04-22 12:56:21 -0400
committerFluorescentCIAAfricanAmerican <[email protected]>2020-04-22 12:56:21 -0400
commit3bf9df6b2785fa6d951086978a3e66f49427166a (patch)
tree2c0f1f0c63c4832882bc93814ebd2c2b1c6224e5 /game/shared/motd.h
downloadarchived-source-engine-2018-hl2-src-master.tar.xz
archived-source-engine-2018-hl2-src-master.zip
Diffstat (limited to 'game/shared/motd.h')
-rw-r--r--game/shared/motd.h77
1 files changed, 77 insertions, 0 deletions
diff --git a/game/shared/motd.h b/game/shared/motd.h
new file mode 100644
index 0000000..993d572
--- /dev/null
+++ b/game/shared/motd.h
@@ -0,0 +1,77 @@
+//========= Copyright Valve Corporation, All rights reserved. ============//
+//
+// Purpose: motd: Handles a list of message of the day entries
+//
+//=============================================================================
+
+#ifndef MOTD_H
+#define MOTD_H
+#ifdef _WIN32
+#pragma once
+#endif
+
+#include "KeyValues.h"
+#include "language.h"
+
+//-----------------------------------------------------------------------------
+// CMOTDEntryDefinition
+//-----------------------------------------------------------------------------
+class CMOTDEntryDefinition
+{
+public:
+ CMOTDEntryDefinition( void );
+ ~CMOTDEntryDefinition( void ) { }
+
+ bool BInitFromKV( KeyValues *pKVMOTD, CUtlVector<CUtlString> *pVecErrors = NULL );
+
+ const char *GetName( void ) { return m_pKVMOTD ? m_pKVMOTD->GetName() : "Unknown Entry"; }
+ const char *GetTitle( ELanguage eLang );
+ const char *GetText( ELanguage eLang );
+ const char *GetURL( void ) { return m_pKVMOTD ? m_pKVMOTD->GetString("url","") : NULL; }
+ const char *GetImage( void ) { return m_pKVMOTD ? m_pKVMOTD->GetString("image","") : NULL; }
+ const char *GetPostTimeStr( void ) { return m_pKVMOTD ? m_pKVMOTD->GetString("time") : NULL; }
+
+ const int GetHeaderType( void ) { return m_pKVMOTD ? m_pKVMOTD->GetInt("header_type") : 0; }
+ const char *GetHeaderTitle( ELanguage eLang );
+ const char *GetHeaderIcon( void ) { return m_pKVMOTD ? m_pKVMOTD->GetString("header_icon","") : NULL; }
+
+ // Post time is the time displayed on the client screen for this post
+ const RTime32 GetPostTime( void ) const { return m_PostTime; }
+
+ // Change time is the time at which we last changed this post. If we change wording on
+ // a post, we need to know that the change should be sent to clients when they log on afterwards.
+ const RTime32 GetChangedTime( void ) const { return m_ChangedTime; }
+
+ const int GetNameInt ( void ) const { return m_pKVMOTD ? V_atoi( m_pKVMOTD->GetName() ) : -1; }
+
+private:
+ KeyValues *m_pKVMOTD;
+ RTime32 m_PostTime;
+ RTime32 m_ChangedTime;
+};
+
+
+
+//-----------------------------------------------------------------------------
+// CMOTDMgr
+//-----------------------------------------------------------------------------
+class CMOTDManager
+{
+public:
+ // MOTD handling
+ bool BInitMOTDEntries( KeyValues *pKVMOTDEntries, CUtlVector<CUtlString> *pVecErrors );
+ int GetNumMOTDAfter( RTime32 iTime );
+ CMOTDEntryDefinition *GetNextMOTDAfter( RTime32 iTime );
+ int GetNumMOTDs( void ) { return m_vecMOTDEntries.Count(); }
+ CMOTDEntryDefinition *GetMOTDByIndex( int iIndex );
+
+ void PurgeUnusedMOTDEntries( KeyValues *pKVMOTDEntries );
+
+private:
+ // Contains the list of MOTD entries.
+ CUtlVector< CMOTDEntryDefinition > m_vecMOTDEntries;
+
+};
+
+
+#endif // MOTD_H \ No newline at end of file