PixelWorldReplay.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include "common/Result.h"
#include "common/Snapshot.h"
#include "common/Time.h"
#include "pixelworld/PixelWorld.h"
 
#include <cstdint>
#include <optional>
#include <span>
#include <vector>
 
namespace eve::pixelworld_replay {
 
struct PixelReplayEntry {
    eve::SimulationTick tick = eve::SimulationTick::zero();
    eve::pixelworld::PixelEditCommand command;
};
 
struct PixelChunkDigest {
    int x = 0;
    int y = 0;
    std::uint64_t digest = 0;
    friend bool operator==(const PixelChunkDigest&, const PixelChunkDigest&) = default;
};
 
struct PixelReplayCheckpoint {
    eve::SimulationTick tick = eve::SimulationTick::zero();
    std::uint64_t revision = 0;
    std::uint64_t worldDigest = 0;
    std::vector<PixelChunkDigest> chunks;
};
 
enum class PixelReplayMatch : std::uint8_t { Matched, Diverged };
 
struct PixelReplayDivergence {
    eve::SimulationTick tick = eve::SimulationTick::zero();
    std::uint64_t expectedRevision = 0;
    std::uint64_t actualRevision = 0;
    std::optional<PixelChunkDigest> expectedChunk;
    std::optional<PixelChunkDigest> actualChunk;
};
 
struct PixelReplayReceipt {
    PixelReplayMatch match = PixelReplayMatch::Matched;
    eve::SimulationTick reachedTick = eve::SimulationTick::zero();
    std::uint64_t commandsApplied = 0;
    std::optional<PixelReplayDivergence> firstDivergence;
};
 
class EVENGINE_API_PLATFORM PixelReplayLog {
public:
    [[nodiscard]] eve::Result<void> append(PixelReplayEntry entry);
 
    [[nodiscard]] eve::Result<void> captureCheckpoint(const eve::pixelworld::PixelWorld& world);
 
    [[nodiscard]] eve::Result<PixelReplayReceipt> replay(
        eve::pixelworld::PixelWorld& target, eve::SimulationTick throughTick) const;
 
    [[nodiscard]] eve::Result<eve::SnapshotEnvelope> snapshot(
        eve::PersistentId instanceId, const eve::SnapshotHashProvider& hashProvider) const;
 
    [[nodiscard]] eve::Result<void> restoreSnapshot(
        const eve::SnapshotEnvelope& snapshot, const eve::SnapshotHashProvider& hashProvider);
 
    [[nodiscard]] std::span<const PixelReplayEntry> entries() const noexcept { return entries_; }
    [[nodiscard]] std::span<const PixelReplayCheckpoint> checkpoints() const noexcept { return checkpoints_; }
 
private:
    std::vector<PixelReplayEntry> entries_;
    std::vector<PixelReplayCheckpoint> checkpoints_;
};
 
}  // namespace eve::pixelworld_replay