PixelWorldControl.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include "pixelworld/PixelWorld.h"
 
#include <cstdint>
#include <span>
#include <vector>
 
namespace eve::pixelworld {
 
struct PixelWorldSummary {
    PixelWorldLink link;
    std::uint64_t seed = 0;
    std::uint64_t revision = 0;
    std::uint64_t tick = 0;
    std::uint64_t lastEditSequence = 0;
    std::uint32_t chunks = 0;
    std::uint32_t activeChunks = 0;
    bool paused = false;
};
 
struct PixelWorldStepReceipt {
    std::uint64_t world = 0;
    std::uint32_t steps = 0;
    std::uint64_t firstTick = 0;
    std::uint64_t lastTick = 0;
    std::uint64_t elapsedMicroseconds = 0;
    StepStats finalStep;
};
 
struct PixelWorldPerformanceSample {
    std::uint64_t tick = 0;
    std::uint64_t elapsedMicroseconds = 0;
    StepStats stats;
};
 
class EVENGINE_API_FOUNDATION PixelWorldControlService {
public:
    [[nodiscard]] std::vector<PixelWorldSummary> worlds() const;
    [[nodiscard]] eve::Result<PixelWorldSummary> world(std::uint64_t worldId) const;
    [[nodiscard]] eve::Result<void> setPaused(std::uint64_t worldId, bool paused);
    [[nodiscard]] eve::Result<PixelWorldStepReceipt> step(std::uint64_t worldId,
                                                         std::uint32_t count = 1);
    [[nodiscard]] eve::Result<PixelEditReceipt> applyEdit(std::uint64_t worldId,
                                                          const PixelEditCommand& command);
    [[nodiscard]] eve::Result<PixelCatalogReloadReceipt> reloadMaterialCatalog(
        std::uint64_t worldId, std::string_view catalogJson,
        std::uint64_t expectedFingerprint);
    [[nodiscard]] eve::Result<std::vector<PixelChunkDiagnostic>> chunkDiagnostics(
        std::uint64_t worldId, PixelChunkRegion region) const;
    [[nodiscard]] eve::Result<std::vector<PixelWorldPerformanceSample>> performanceSamples(
        std::uint64_t worldId, std::uint32_t limit = 120) const;
    [[nodiscard]] eve::Result<std::vector<std::byte>> captureSnapshot(std::uint64_t worldId) const;
    [[nodiscard]] eve::Result<void> restoreSnapshot(std::uint64_t worldId,
                                                    std::span<const std::byte> bytes);
 
private:
    friend class PixelWorld;
    void registerWorld(PixelWorld& world);
    void unregisterWorld(const PixelWorld& world) noexcept;
    void rebindWorld(const PixelWorld* previous, PixelWorld& replacement) noexcept;
    void recordStep(std::uint64_t worldId, const StepStats& stats,
                    std::uint64_t elapsedMicroseconds);
    [[nodiscard]] PixelWorld* find(std::uint64_t worldId) const noexcept;
 
    struct Impl;
    Impl& impl() const;
};
 
EVENGINE_API_FOUNDATION PixelWorldControlService& pixelWorldControlService();
 
}  // namespace eve::pixelworld