GameplayTag.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include "common/Result.h"
#include "common/StrongUint64.h"
#include "common/Value.h"
 
#include <map>
#include <string>
#include <string_view>
#include <vector>
 
namespace eve::tags {
 
struct GameplayTagIdTag;
using GameplayTagId = eve::detail::StrongUint64<GameplayTagIdTag>;
 
enum class GameplayTagMatch { Exact, IncludeDescendants };
 
struct GameplayTagDefinition {
    GameplayTagId id;
    std::string   name;
    std::string   description;
 
    bool operator==(const GameplayTagDefinition&) const = default;
};
 
[[nodiscard]] EVENGINE_API_FOUNDATION bool isValidGameplayTagName(std::string_view name) noexcept;
[[nodiscard]] GameplayTagId gameplayTagId(std::string_view name) noexcept;
[[nodiscard]] EVENGINE_API_FOUNDATION bool gameplayTagMatches(std::string_view candidate, std::string_view query,
                                                              GameplayTagMatch match) noexcept;
 
class EVENGINE_API_FOUNDATION GameplayTagRegistry {
public:
    [[nodiscard]] Result<GameplayTagId> registerTag(std::string name, std::string description = {});
    [[nodiscard]] Result<GameplayTagDefinition> find(std::string_view name) const;
    [[nodiscard]] bool contains(std::string_view name) const;
    [[nodiscard]] std::vector<GameplayTagDefinition> definitions() const;
    [[nodiscard]] std::vector<GameplayTagDefinition> search(std::string_view text, std::string_view root = {}) const;
    [[nodiscard]] Result<Value> toValue() const;
    [[nodiscard]] static Result<GameplayTagRegistry> fromValue(const Value& value);
 
private:
    std::map<std::string, GameplayTagDefinition, std::less<>> definitionsByName_;
    std::map<GameplayTagId, std::string>                      nameById_;
};
 
}  // namespace eve::tags