butchery_requirements.h

#pragma once
#ifndef CATA_SRC_BUTCHERY_REQUIREMENTS_H
#define CATA_SRC_BUTCHERY_REQUIREMENTS_H

#include <iosfwd>
#include <map>
#include <utility>
#include <vector>

#include "creature.h"
#include "type_id.h"

class JsonObject;
class read_only_visitable;

enum class butcher_type : int;
enum class creature_size : int;

/**
 * Contains several requirements, each with a speed modifier.
 * The goal is to iterate from highest speed modifier to lowest
 * to find the first requirement satisfied to butcher a corpse.
 */
class butchery_requirements
{
    public:
        bool was_loaded = false;
        string_id<butchery_requirements> id;
        std::vector<std::pair<string_id<butchery_requirements>, mod_id>> src;

        // tries to find the requirement with the highest speed bonus. if it fails it returns cata::nullopt
        std::pair<float, requirement_id> get_fastest_requirements(
            const read_only_visitable &crafting_inv, creature_size size, butcher_type butcher ) const;

        static void load_butchery_req( const JsonObject &jo, const std::string &src );
        void load( const JsonObject &jo, const std::string & );
        static const std::vector<butchery_requirements> &get_all();
        static void check_consistency();
        static void reset();
        bool is_valid() const;
    private:
        // int is speed bonus
        std::map<float, std::map<creature_size, std::map<butcher_type, requirement_id>>> requirements;
};

#endif // CATA_SRC_BUTCHERY_REQUIREMENTS_H