GameplayControl.h

浏览该文件的文档.

#pragma once
 
#include "common/Identity.h"
#include "common/Result.h"
#include "common/SubjectRef.h"
#include "common/Time.h"
#include "common/Value.h"
 
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
namespace eve {
 
enum class GameplayAccess : std::uint8_t { PlayerEquivalent, TestDriver, DeveloperCheat };
 
struct GameplaySession {
    std::string             id;
    GameplayAccess          access = GameplayAccess::PlayerEquivalent;
    std::vector<SubjectRef> controlledSubjects;
};
 
struct GameplayActionDescriptor {
    LogicalId id;
    Value     parameterSchema;
};
 
struct GameplayObservation {
    LogicalId       domain;
    SubjectRef      instance;
    SimulationTick tick = SimulationTick::zero();
    std::uint64_t   revision = 0;
    Value           state;
};
 
struct GameplayCommand {
    std::string     id;
    LogicalId       action;
    SubjectRef      subject;
    SimulationTick observedTick = SimulationTick::zero();
    std::uint64_t   expectedRevision = 0;
    Value           parameters;
};
 
struct GameplayCommandReceipt {
    std::string     commandId;
    std::string     executionId;
    SimulationTick acceptedTick = SimulationTick::zero();
    std::uint64_t   resultingRevision = 0;
    Value           details;
};
 
struct GameplayEvent {
    std::uint64_t   sequence = 0;
    SimulationTick tick = SimulationTick::zero();
    std::string     type;
    SubjectRef      subject;
    std::string     causationCommandId;
    std::string     correlationId;
    Value           payload;
};
 
class IGameplayControlProvider {
public:
    static constexpr const char* capabilityName = "IGameplayControlProvider";
    virtual ~IGameplayControlProvider() = default;
 
    [[nodiscard]] virtual std::string_view gameplayDomain() const noexcept = 0;
    [[nodiscard]] virtual Result<GameplayObservation> observeGameplay(const GameplaySession& session,
                                                                       SubjectRef instance) const = 0;
    [[nodiscard]] virtual Result<std::vector<GameplayActionDescriptor>> availableGameplayActions(
        const GameplaySession& session, SubjectRef instance, SubjectRef subject) const = 0;
    [[nodiscard]] virtual Result<GameplayCommandReceipt> submitGameplay(const GameplaySession& session,
                                                                         SubjectRef instance,
                                                                         const GameplayCommand& command) = 0;
    [[nodiscard]] virtual Result<GameplayObservation> advanceGameplay(const GameplaySession& session,
                                                                       SubjectRef instance,
                                                                       const SimulationStep& step) = 0;
    [[nodiscard]] virtual Result<std::vector<GameplayEvent>> gameplayEvents(const GameplaySession& session,
                                                                             SubjectRef instance,
                                                                             std::uint64_t afterSequence) const = 0;
};
 
}  // namespace eve