Dice.h

Go to the documentation of this file.

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

 
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include "Core/Math/DeterministicRandom.h"
 
namespace core {

struct Dice {
    int count = 0;
    int faces = 0;
    int modifier = 0;

    [[nodiscard]] constexpr int minimum() const noexcept {
        return count + modifier;
    }

    [[nodiscard]] constexpr int maximum() const noexcept {
        return count * faces + modifier;
    }
 
    [[nodiscard]] bool operator==(const Dice&) const = default;
};

struct DiceRoll {
    Dice dice;
    std::vector<int> faces;
    int total = 0;

    [[nodiscard]] std::string describe() const;
};

[[nodiscard]] std::optional<Dice> parseDice(std::string_view notation);

[[nodiscard]] std::string formatDice(const Dice& dice);

[[nodiscard]] DiceRoll rollDice(const Dice& dice, DeterministicRandom& random);
 
}  // namespace core