CharacterOptions.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once

 
#include <array>
#include <cstddef>
#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include "Core/Rpg/Ability.h"
#include "Core/Rpg/RpgEnums.h"
 
namespace core {

struct NamedTrait {
    std::string name;
    std::string text;
};

struct ProvisionalStatus {
    bool provisional = false;
    std::string reason;
    std::string removalCriterion;
};

struct Species {
    std::string id;
    std::string name;
    std::string source;
    CreatureSize size = CreatureSize::Medium;
    float speed = 0.0F;
    std::array<int, 6> abilityScoreIncrease{};
    std::string parentSpecies;
    std::vector<std::string> languages;
    std::vector<NamedTrait> traits;
    std::vector<std::string> requiredMechanisms;

    [[nodiscard]] int increase(Ability which) const {
        return abilityScoreIncrease[static_cast<std::size_t>(which)];
    }
};

struct Background {
    std::string id;
    std::string name;
    std::string source;
    std::vector<std::string> skillProficiencies;
    int languageCount = 0;
    std::optional<NamedTrait> feature;
    std::string text;
};

struct ClassLevel {
    int level = 0;
    int proficiencyBonus = 0;
    std::vector<std::string> features;
};

struct PlayableClass {
    std::string id;
    std::string name;
    std::string source;
    int hitDie = 0;
    std::vector<Ability> primaryAbility;
    std::vector<Ability> savingThrowProficiencies;
    std::vector<ClassLevel> progression;
    ProvisionalStatus status;

    [[nodiscard]] const ClassLevel* atLevel(int level) const;
};

struct CharacterOptions {
    std::vector<Species> species;
    std::vector<Background> backgrounds;
    std::vector<PlayableClass> classes;
    std::vector<std::string> errors;
 
    [[nodiscard]] const Species* findSpecies(std::string_view id) const;
    [[nodiscard]] const Background* findBackground(std::string_view id) const;
    [[nodiscard]] const PlayableClass* findClass(std::string_view id) const;

    [[nodiscard]] std::vector<std::string> requiredMechanisms() const;

    [[nodiscard]] std::vector<std::string> provisionalClassIds() const;
};

[[nodiscard]] int abilityScoreWith(const Species& species, Ability which, int baseScore,
                                   int maximumScore);

[[nodiscard]] CharacterOptions loadCharacterOptions(const std::filesystem::path& speciesDir,
                                                    const std::filesystem::path& backgroundsDir,
                                                    const std::filesystem::path& classesDir);
 
}  // namespace core