tileset_artifact.hpp

Go to the documentation of this file.

#pragma once
 
#include <optional>
#include <string>
 
namespace porytiles2 {
 
class TilesetArtifact {
  public:
    enum class Type {
        bottom_png,              
        middle_png,              
        top_png,                 
        attributes_csv,          
        porytiles_anim_frame,    
        pal_override_n,          
        metatiles_bin,           
        metatile_attributes_bin, 
        tiles_png,               
        porymap_anim_frame,      
        pal_n,                   
        config,                  
        local_config             
        // pal_hint_n,            // TODO: pal hints could be like Porytiles1's palette primers?
    };
 
    explicit TilesetArtifact(const Type type) : type_{type}, name_{std::nullopt}, index_{std::nullopt} {}
 
    explicit TilesetArtifact(const Type type, std::string name)
        : type_{type}, name_{std::move(name)}, index_{std::nullopt}
    {
    }
 
    explicit TilesetArtifact(const Type type, unsigned int index) : type_{type}, name_{std::nullopt}, index_{index} {}
 
    explicit TilesetArtifact(const Type type, std::string name, int index)
        : type_{type}, name_{std::move(name)}, index_{index}
    {
    }
 
    [[nodiscard]] Type type() const
    {
        return type_;
    }
 
    [[nodiscard]] std::optional<std::string> name() const
    {
        return name_;
    }
 
    [[nodiscard]] std::optional<unsigned int> index() const
    {
        return index_;
    }
 
  private:
    Type type_;
    /*
     * TODO: this isn't the best design, compiler can no longer catch programmer errors. If programmer forgets to
     * provide a name/index, Porytiles has to panic which is not great. Ideally we'd like the compiler to help the
     * programmer here.
     */
    std::optional<std::string> name_;
    std::optional<unsigned int> index_;
};
 
} // namespace porytiles2