GridMate::DataSetBase Class Reference

#include <DataSet.h>

Inherited by GridMate::DataSet< AZ::u32 >, GridMate::DataSet< bool >, GridMate::DataSet< GridMate::ReplicaStatus::ReplicaOptions, GridMate::ReplicaStatus::ReplicaOptions::Marshaler >, GridMate::DataSet< RemotePeerMode >, and GridMate::DataSet< DataType, MarshalerType, ThrottlerType >.

Public Types
using	DispatchCallback = AZStd::function< void(const TimeContext &tc)>

Public Member Functions
void	SetMaxIdleTime (float dt)
float	GetMaxIdleTime () const
bool	CanSet () const
bool	IsDefaultValue () const
void	MarkAsDefaultValue ()
void	MarkAsNonDefaultValue ()
unsigned int	GetLastUpdateTime () const
ReplicaChunkBase *	GetReplicaChunkBase () const
AZ::u64	GetRevision () const
void	SetDispatchOverride (DispatchCallback callback)
	Delta compressed DataSets use an intermediary to catch dispatches of changed DataSets in their logic. More...
const DispatchCallback &	GetDispatchOverride () const
	Delta compressed fields override a dispatch. More...

Protected Member Functions
	DataSetBase (const char *debugName)
virtual PrepareDataResult	PrepareData (EndianType endianType, AZ::u32 marshalFlags)=0
virtual void	Unmarshal (UnmarshalContext &mc)=0
virtual void	ResetDirty ()=0
virtual void	SetDirty ()
virtual void	DispatchChangedEvent (const TimeContext &tc)
ReadBuffer	GetMarshalData () const

Protected Attributes
float	m_maxIdleTicks
WriteBufferDynamic	m_streamCache
ReplicaChunkBase *	m_replicaChunk
	raw pointer, assuming datasets do not exists without replica chunk
unsigned int	m_lastUpdateTime
bool	m_isDefaultValue
AZ::u64	m_revision
	Latest revision number; 0 means unset.
DispatchCallback	m_override

Detailed Description

DataSetBase Base type for all replica datasets

Member Function Documentation

GetDispatchOverride()

const DispatchCallback& GridMate::DataSetBase::GetDispatchOverride ( ) const

inline

Delta compressed fields override a dispatch.

Returns

not-null if this DataSet is used for Delta Compression

GetLastUpdateTime()

unsigned int GridMate::DataSetBase::GetLastUpdateTime ( ) const

inline

Returns the last updated network time of the DataSet.

SetDispatchOverride()

void GridMate::DataSetBase::SetDispatchOverride ( DispatchCallback  callback )

inline

Delta compressed DataSets use an intermediary to catch dispatches of changed DataSets in their logic.

Parameters

callback

to a custom object when a DataSet changes

---

The documentation for this class was generated from the following file:

• Code/Framework/GridMate/GridMate/Replica/DataSet.h