ArtifactPublish.h

浏览该文件的文档.

#pragma once
 
#include "common/Result.h"
#include "common/Snapshot.h"
#include "procgen/GeneratedArtifact.h"
 
#include <memory>
 
namespace eve::procgen {
 
// The low-level contracts live in common so scene/map/graphics/physics can
// implement them without a reverse include of procgen. These aliases preserve
// the established procgen-facing source API.
using PreparedArtifactPublish  = eve::artifact::PreparedPublication;
using ISceneArtifactAdapter    = eve::artifact::ISceneArtifactAdapter;
using IMapArtifactAdapter      = eve::artifact::IMapArtifactAdapter;
using IGraphicsArtifactAdapter = eve::artifact::IGraphicsArtifactAdapter;
using IPhysicsArtifactAdapter  = eve::artifact::IPhysicsArtifactAdapter;
using ArtifactPublishOptions   = eve::artifact::PublishOptions;
 
struct ArtifactPublishReceipt {
    ArtifactId id;
    bool       scenePublished    = false;
    bool       graphicsPublished = false;
    bool       physicsPublished  = false;
    bool       mapPublished      = false;
};
 
struct ArtifactSnapshotContext {
    eve::PersistentId         instanceId;
    eve::Revision             revision;
    eve::SimulationTick       tick;
    eve::SnapshotHashProvider hashProvider;
};
 
class EVENGINE_API_DOMAINS ArtifactPublisher {
public:
    explicit ArtifactPublisher(ArtifactStore& store) noexcept : store_(store) {}
 
    [[nodiscard]] eve::Result<ArtifactPublishReceipt> publish(GeneratedArtifact      artifact,
                                                              ArtifactPublishOptions options);
 
    [[nodiscard]] eve::Result<eve::SnapshotEnvelope> snapshot(const ArtifactSnapshotContext& context) const;
 
    [[nodiscard]] eve::Result<void> restore(const eve::SnapshotEnvelope&     snapshot,
                                            const eve::SnapshotHashProvider& hashProvider);
 
private:
    ArtifactStore& store_;
};
 
}  // namespace eve::procgen