mod_configuration.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2013-22 celeron55, Perttu Ahola <celeron55@gmail.com>
 
#pragma once
 
#include "mods.h"
 
struct SubgameSpec;
 
class ModConfiguration
{
public:
        inline bool isConsistent() const { return m_unsatisfied_mods.empty(); }
 
        inline const std::vector<ModSpec> &getUnsatisfiedMods() const
        {
                return m_unsatisfied_mods;
        }
 
        const std::vector<ModSpec> &getMods() const { return m_sorted_mods; }
 
        std::string getUnsatisfiedModsError() const;
 
        void addModsInPath(const std::string &path, const std::string &virtual_path);
 
        void addMods(const std::vector<ModSpec> &new_mods);
 
        void addGameMods(const SubgameSpec &gamespec);
 
        void addModsFromConfig(const std::string &settings_path,
                        const std::unordered_map<std::string, std::string> &modPaths);
 
        void checkConflictsAndDeps();
 
private:
        std::string m_first_mod; // "" <=> no mod
        std::string m_last_mod; // "" <=> no mod
 
        std::vector<ModSpec> m_sorted_mods;
 
        void resolveDependencies();
 
        // mods with unmet dependencies. Before dependencies are resolved,
        // this is where all mods are stored. Afterwards this contains
        // only the ones with really unsatisfied dependencies.
        std::vector<ModSpec> m_unsatisfied_mods;
 
        // set of mod names for which an unresolved name conflict
        // exists. A name conflict happens when two or more mods
        // at the same level have the same name but different paths.
        // Levels (mods in higher levels override mods in lower levels):
        // 1. game mod in modpack; 2. game mod;
        // 3. world mod in modpack; 4. world mod;
        // 5. addon mod in modpack; 6. addon mod.
        std::unordered_set<std::string> m_name_conflicts;
};