tileset_artifact_writer.hpp

Go to the documentation of this file.

#pragma once
 
#include <any>
 
#include "porytiles/domain/models/tileset.hpp"
#include "porytiles/domain/repos/artifact_key.hpp"
#include "porytiles/utilities/result/chainable_result.hpp"
 
namespace porytiles {
 
class TilesetArtifactWriter {
  public:
    virtual ~TilesetArtifactWriter() = default;
 
    [[nodiscard]] virtual ChainableResult<void> begin_transaction() = 0;
 
    [[nodiscard]] virtual ChainableResult<void> commit() = 0;
 
    [[nodiscard]] virtual ChainableResult<void> rollback() = 0;
 
    /*
     * Porymap artifacts
     */
    [[nodiscard]] virtual ChainableResult<void>
    write_metatiles_bin(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void>
    write_metatile_attributes_bin(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void> write_tiles_png(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void>
    write_porymap_pal_n(const ArtifactKey &dest_key, const Tileset &src, std::size_t index) = 0;
 
    [[nodiscard]] virtual ChainableResult<void> write_porymap_anim_frame(
        const ArtifactKey &dest_key,
        const Tileset &src,
        const std::string &anim_name,
        const std::string &frame_name) = 0;
 
    [[nodiscard]] virtual ChainableResult<void>
    write_porymap_anim_params(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    /*
     * Porytiles artifacts
     */
    [[nodiscard]] virtual ChainableResult<void> write_bottom_png(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void> write_middle_png(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void> write_top_png(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void>
    write_attributes_csv(const ArtifactKey &dest_key, const Tileset &src) = 0;
 
    [[nodiscard]] virtual ChainableResult<void>
    write_porytiles_pal_n(const ArtifactKey &dest_key, const Tileset &src, std::size_t index) = 0;
 
    [[nodiscard]] virtual ChainableResult<void> write_porytiles_anim_frame(
        const ArtifactKey &dest_key,
        const Tileset &src,
        const std::string &anim_name,
        const std::string &frame_name) = 0;
 
    [[nodiscard]] virtual ChainableResult<void>
    write_porytiles_anim_params(const ArtifactKey &dest_key, const Tileset &src) = 0;
};
 
} // namespace porytiles