Emergency 20 Dokumentation  4.2.0
em5::multiplayer::DataCacheBase Class Referenceabstract

EMERGENCY 5 multiplayer data cache base class. More...

#include <DataCacheBase.h>

Inheritance diagram for em5::multiplayer::DataCacheBase:
em5::multiplayer::DataCacheComponentExistenceTrackingBase< BuildingOverlayComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< EventIdComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< GhostComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< InventoryComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::ActionComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneLinkComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneToBoneLinkComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::HiddenComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::GameLogicComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::LinkComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::MeshAnimationComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< StatusOverlayComponent > em5::multiplayer::DataCacheComponentExistenceTrackingBase< UsableByEngineerComponent > em5::multiplayer::BarrierTapeData em5::multiplayer::BoatData em5::multiplayer::BuildingData em5::multiplayer::BuryData em5::multiplayer::DamageData em5::multiplayer::DataCacheComponentExistenceTrackingBase< TrackedComponentType > em5::multiplayer::DlkLadderData em5::multiplayer::DoorData em5::multiplayer::FireData em5::multiplayer::HealthData em5::multiplayer::HelicopterData em5::multiplayer::MeshData em5::multiplayer::MovableData em5::multiplayer::NavigationData em5::multiplayer::ParticleData em5::multiplayer::PersonData em5::multiplayer::PersonMagnetData em5::multiplayer::RescueBusData em5::multiplayer::SupportLegData em5::multiplayer::SwingData em5::multiplayer::TimeOfDayData em5::multiplayer::TransformData em5::multiplayer::TreeData em5::multiplayer::VehicleCraneData em5::multiplayer::VehicleData em5::multiplayer::WaterCannonData em5::multiplayer::WaterjetData em5::multiplayer::WeatherData

Public Member Functions

 DataCacheBase (const qsf::Entity &entity)
 Constructor. More...
 
virtual ~DataCacheBase ()
 Destructor. More...
 
virtual bool includeForPrepare (const int32 currentTickCount, bool entityIsVisible)
 Returns if the data cache item should be generally included into the current update cycle. More...
 
virtual bool prepareForUpdate (const qsf::Entity &targetEntity, const qsf::Clock &clock)
 Prepares for an update. More...
 
virtual void updateData (qsf::game::BitStream &bitStream, bool force=false)=0
 Updates the cache and writes any changed data to the given bit stream. More...
 
virtual void setData (const qsf::game::BitStream &bitStream, const int32 receivedHostTickCount)=0
 Reads the data from the bit stream. More...
 
virtual void interpolate (qsf::Entity &targetEntity, const qsf::Clock &clock, const int32 receivedHostTickCount)=0
 Does any interpolation steps needed to apply the cached data to the entity. More...
 

Protected Attributes

uint64 mEntityId
 

Detailed Description

EMERGENCY 5 multiplayer data cache base class.

Constructor & Destructor Documentation

em5::multiplayer::DataCacheBase::DataCacheBase ( const qsf::Entity entity)

Constructor.

em5::multiplayer::DataCacheBase::~DataCacheBase ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual bool em5::multiplayer::DataCacheBase::includeForPrepare ( const int32  currentTickCount,
bool  entityIsVisible 
)
virtual
virtual void em5::multiplayer::DataCacheBase::interpolate ( qsf::Entity targetEntity,
const qsf::Clock clock,
const int32  receivedHostTickCount 
)
pure virtual

Does any interpolation steps needed to apply the cached data to the entity.

Implemented in em5::multiplayer::VehicleData, em5::multiplayer::DlkLadderData, em5::multiplayer::RescueBusData, em5::multiplayer::SupportLegData, em5::multiplayer::ActionData, em5::multiplayer::BoatData, em5::multiplayer::BuildingData, em5::multiplayer::HelicopterData, em5::multiplayer::PersonData, em5::multiplayer::TreeData, em5::multiplayer::BuryData, em5::multiplayer::DoorData, em5::multiplayer::SwingData, em5::multiplayer::FireData, em5::multiplayer::VehicleCraneData, em5::multiplayer::DamageData, em5::multiplayer::HealthData, em5::multiplayer::MovableData, em5::multiplayer::ParticleData, em5::multiplayer::WaterCannonData, em5::multiplayer::WaterjetData, em5::multiplayer::BoneLinkData, em5::multiplayer::BoneToBoneLinkData, em5::multiplayer::TransformData, em5::multiplayer::MeshData, em5::multiplayer::GhostData, em5::multiplayer::TimeOfDayData, em5::multiplayer::UsableByEngineerData, em5::multiplayer::WeatherData, em5::multiplayer::HiddenData, em5::multiplayer::BarrierTapeData, em5::multiplayer::NavigationData, em5::multiplayer::PersonMagnetData, em5::multiplayer::GameLogicData, em5::multiplayer::InventoryData, em5::multiplayer::LinkData, em5::multiplayer::DataCacheComponentExistenceTrackingBase< TrackedComponentType >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneToBoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::LinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< BuildingOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::ActionComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::HiddenComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< StatusOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::GameLogicComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< EventIdComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< GhostComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::MeshAnimationComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< InventoryComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< UsableByEngineerComponent >, em5::multiplayer::MeshAnimationData, em5::multiplayer::BuildingOverlayData, em5::multiplayer::EventIdData, and em5::multiplayer::StatusOverlayData.

virtual bool em5::multiplayer::DataCacheBase::prepareForUpdate ( const qsf::Entity targetEntity,
const qsf::Clock clock 
)
inlinevirtual

Prepares for an update.

Returns
Returns true if data has change since last update

Reimplemented in em5::multiplayer::VehicleData, em5::multiplayer::DlkLadderData, em5::multiplayer::RescueBusData, em5::multiplayer::SupportLegData, em5::multiplayer::ActionData, em5::multiplayer::BoatData, em5::multiplayer::BuildingData, em5::multiplayer::HelicopterData, em5::multiplayer::PersonData, em5::multiplayer::TreeData, em5::multiplayer::BuryData, em5::multiplayer::DoorData, em5::multiplayer::SwingData, em5::multiplayer::FireData, em5::multiplayer::VehicleCraneData, em5::multiplayer::DamageData, em5::multiplayer::HealthData, em5::multiplayer::MovableData, em5::multiplayer::ParticleData, em5::multiplayer::WaterCannonData, em5::multiplayer::WaterjetData, em5::multiplayer::BoneLinkData, em5::multiplayer::BoneToBoneLinkData, em5::multiplayer::TransformData, em5::multiplayer::MeshData, em5::multiplayer::GhostData, em5::multiplayer::TimeOfDayData, em5::multiplayer::UsableByEngineerData, em5::multiplayer::WeatherData, em5::multiplayer::HiddenData, em5::multiplayer::BarrierTapeData, em5::multiplayer::NavigationData, em5::multiplayer::PersonMagnetData, em5::multiplayer::GameLogicData, em5::multiplayer::InventoryData, em5::multiplayer::LinkData, em5::multiplayer::DataCacheComponentExistenceTrackingBase< TrackedComponentType >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneToBoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::LinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< BuildingOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::ActionComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::HiddenComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< StatusOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::GameLogicComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< EventIdComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< GhostComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::MeshAnimationComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< InventoryComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< UsableByEngineerComponent >, em5::multiplayer::MeshAnimationData, em5::multiplayer::BuildingOverlayData, em5::multiplayer::EventIdData, and em5::multiplayer::StatusOverlayData.

virtual void em5::multiplayer::DataCacheBase::setData ( const qsf::game::BitStream bitStream,
const int32  receivedHostTickCount 
)
pure virtual

Reads the data from the bit stream.

Implemented in em5::multiplayer::VehicleData, em5::multiplayer::DlkLadderData, em5::multiplayer::RescueBusData, em5::multiplayer::SupportLegData, em5::multiplayer::ActionData, em5::multiplayer::BoatData, em5::multiplayer::BuildingData, em5::multiplayer::HelicopterData, em5::multiplayer::PersonData, em5::multiplayer::TreeData, em5::multiplayer::BuryData, em5::multiplayer::DoorData, em5::multiplayer::SwingData, em5::multiplayer::FireData, em5::multiplayer::VehicleCraneData, em5::multiplayer::DamageData, em5::multiplayer::HealthData, em5::multiplayer::MovableData, em5::multiplayer::ParticleData, em5::multiplayer::WaterCannonData, em5::multiplayer::WaterjetData, em5::multiplayer::BoneLinkData, em5::multiplayer::BoneToBoneLinkData, em5::multiplayer::TransformData, em5::multiplayer::MeshData, em5::multiplayer::GhostData, em5::multiplayer::TimeOfDayData, em5::multiplayer::UsableByEngineerData, em5::multiplayer::WeatherData, em5::multiplayer::HiddenData, em5::multiplayer::BarrierTapeData, em5::multiplayer::NavigationData, em5::multiplayer::PersonMagnetData, em5::multiplayer::GameLogicData, em5::multiplayer::InventoryData, em5::multiplayer::LinkData, em5::multiplayer::DataCacheComponentExistenceTrackingBase< TrackedComponentType >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneToBoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::LinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< BuildingOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::ActionComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::HiddenComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< StatusOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::GameLogicComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< EventIdComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< GhostComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::MeshAnimationComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< InventoryComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< UsableByEngineerComponent >, em5::multiplayer::MeshAnimationData, em5::multiplayer::BuildingOverlayData, em5::multiplayer::EventIdData, and em5::multiplayer::StatusOverlayData.

virtual void em5::multiplayer::DataCacheBase::updateData ( qsf::game::BitStream bitStream,
bool  force = false 
)
pure virtual

Updates the cache and writes any changed data to the given bit stream.

Implemented in em5::multiplayer::VehicleData, em5::multiplayer::DlkLadderData, em5::multiplayer::RescueBusData, em5::multiplayer::SupportLegData, em5::multiplayer::ActionData, em5::multiplayer::BoatData, em5::multiplayer::BuildingData, em5::multiplayer::HelicopterData, em5::multiplayer::PersonData, em5::multiplayer::TreeData, em5::multiplayer::BuryData, em5::multiplayer::DoorData, em5::multiplayer::SwingData, em5::multiplayer::FireData, em5::multiplayer::VehicleCraneData, em5::multiplayer::DamageData, em5::multiplayer::HealthData, em5::multiplayer::MovableData, em5::multiplayer::ParticleData, em5::multiplayer::WaterCannonData, em5::multiplayer::WaterjetData, em5::multiplayer::BoneLinkData, em5::multiplayer::BoneToBoneLinkData, em5::multiplayer::TransformData, em5::multiplayer::MeshData, em5::multiplayer::GhostData, em5::multiplayer::TimeOfDayData, em5::multiplayer::UsableByEngineerData, em5::multiplayer::WeatherData, em5::multiplayer::HiddenData, em5::multiplayer::BarrierTapeData, em5::multiplayer::NavigationData, em5::multiplayer::PersonMagnetData, em5::multiplayer::GameLogicData, em5::multiplayer::InventoryData, em5::multiplayer::LinkData, em5::multiplayer::DataCacheComponentExistenceTrackingBase< TrackedComponentType >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::BoneToBoneLinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::LinkComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< BuildingOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::ActionComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::game::HiddenComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< StatusOverlayComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::GameLogicComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< EventIdComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< GhostComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< qsf::MeshAnimationComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< InventoryComponent >, em5::multiplayer::DataCacheComponentExistenceTrackingBase< UsableByEngineerComponent >, em5::multiplayer::MeshAnimationData, em5::multiplayer::BuildingOverlayData, em5::multiplayer::EventIdData, and em5::multiplayer::StatusOverlayData.

Member Data Documentation

uint64 em5::multiplayer::DataCacheBase::mEntityId
protected

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