csgo-2018-source/engine/packed_entity.h

168 lines
4.4 KiB
C
Raw Normal View History

2021-07-25 12:11:47 +08:00
//========= Copyright <20> 1996-2005, Valve Corporation, All rights reserved. ============//
//
// Purpose:
//
// $Workfile: $
// $Date: $
// $NoKeywords: $
//=============================================================================//
#if !defined( PACKED_ENTITY_H )
#define PACKED_ENTITY_H
#ifdef _WIN32
#pragma once
#endif
#include <const.h>
#include <basetypes.h>
#include <mempool.h>
#include <utlvector.h>
#include <tier0/dbg.h>
#include "common.h"
#include "ents_shared.h"
// This is extra spew to the files cltrace.txt + svtrace.txt
// #define DEBUG_NETWORKING 1
#if defined( DEBUG_NETWORKING )
#include "convar.h"
void SpewToFile( char const* pFmt, ... );
extern ConVar sv_packettrace;
#define TRACE_PACKET( text ) if ( sv_packettrace.GetInt() ) { SpewToFile text ; };
#else
#define TRACE_PACKET( text )
#endif
#define FLAG_IS_COMPRESSED (1<<31)
class CSendProxyRecipients;
class SendTable;
class RecvTable;
class ServerClass;
class ClientClass;
class CChangeFrameList;
typedef intp SerializedEntityHandle_t;
// Replaces entity_state_t.
// This is what we send to clients.
class PackedEntity
{
public:
PackedEntity();
~PackedEntity();
void SetNumBits( int nBits );
int GetNumBits() const;
int GetNumBytes() const;
// Access the data in the entity.
const SerializedEntityHandle_t GetPackedData() const;
void ReleasePackedData();
// Copy the data into the PackedEntity's data and make sure the # bytes allocated is
// an integer multiple of 4.
void CopyPackedData( SerializedEntityHandle_t handle );
// Like copy, but just takes ownership of handle. Assumes that parent caller is done with entity and will NOT
// call ReleaseSerializedEntity
void SetPackedData( SerializedEntityHandle_t handle );
// These are like Get/Set, except SnagChangeFrameList clears out the
// PackedEntity's pointer since the usage model in sv_main is to keep
// the same CChangeFrameList in the most recent PackedEntity for the
// lifetime of an edict.
//
// When the PackedEntity is deleted, it deletes its current CChangeFrameList if it exists.
void SetChangeFrameList( CChangeFrameList *pList );
CChangeFrameList* GetChangeFrameList();
const CChangeFrameList* GetChangeFrameList() const;
CChangeFrameList* SnagChangeFrameList();
// Access the recipients array.
const CSendProxyRecipients* GetRecipients() const;
int GetNumRecipients() const;
void SetRecipients( const CUtlMemory<CSendProxyRecipients> &recipients );
bool CompareRecipients( const CUtlMemory<CSendProxyRecipients> &recipients ) const;
void SetSnapshotCreationTick( int nTick );
int GetSnapshotCreationTick() const;
void SetShouldCheckCreationTick( bool bState );
bool ShouldCheckCreationTick() const;
void SetServerAndClientClass( ServerClass *pServerClass, ClientClass *pClientClass );
public:
ServerClass *m_pServerClass; // Valid on the server
ClientClass *m_pClientClass; // Valid on the client
int m_nEntityIndex; // Entity index.
CInterlockedInt m_ReferenceCount; // reference count;
private:
CUtlVector<CSendProxyRecipients> m_Recipients;
SerializedEntityHandle_t m_SerializedEntity;
CChangeFrameList *m_pChangeFrameList; // Only the most current
// This is the tick this PackedEntity was created on
unsigned int m_nSnapshotCreationTick : 31;
unsigned int m_nShouldCheckCreationTick : 1;
};
inline const SerializedEntityHandle_t PackedEntity::GetPackedData() const
{
return m_SerializedEntity;
}
inline void PackedEntity::SetChangeFrameList( CChangeFrameList *pList )
{
Assert( !m_pChangeFrameList );
m_pChangeFrameList = pList;
}
inline CChangeFrameList* PackedEntity::GetChangeFrameList()
{
return m_pChangeFrameList;
}
inline const CChangeFrameList* PackedEntity::GetChangeFrameList() const
{
return m_pChangeFrameList;
}
inline CChangeFrameList* PackedEntity::SnagChangeFrameList()
{
CChangeFrameList *pRet = m_pChangeFrameList;
m_pChangeFrameList = NULL;
return pRet;
}
inline void PackedEntity::SetSnapshotCreationTick( int nTick )
{
m_nSnapshotCreationTick = (unsigned int)nTick;
}
inline int PackedEntity::GetSnapshotCreationTick() const
{
return (int)m_nSnapshotCreationTick;
}
inline void PackedEntity::SetShouldCheckCreationTick( bool bState )
{
m_nShouldCheckCreationTick = bState ? 1 : 0;
}
inline bool PackedEntity::ShouldCheckCreationTick() const
{
return m_nShouldCheckCreationTick == 1 ? true : false;
}
#endif // PACKED_ENTITY_H