RpgScreens.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <cstddef>
#include <span>

 
namespace hmi {

enum class RpgScreenId {
    CharacterSheet,  
    Inventory,       
    QuestJournal,    
    WorldMap,        
    Dialogue,        
    Merchant,        
    GuildBoard,      
    CombatHud,       
    TeamSheet,
};

inline constexpr std::size_t RPG_SCREEN_COUNT = 9;

enum class RpgSuperposition {
    PausesGame,
    WhileWalking,
};

enum class RpgBlockKind {
    Fields,     
    Grid,       
    List,       
    Prose,      
    Portrait,   
    Track,      
    ActionBar,  
};

struct RpgField {
    const char* labelKey = "";
    const char* valueId = "";
};

struct RpgContentBlock {
    const char* titleKey = "";  
    RpgBlockKind kind = RpgBlockKind::Fields;
    int columns = 0;  
    int rows = 0;
    std::span<const RpgField> fields{};
    std::span<const char* const> valueIds{};
};

struct RpgScreenLayout {
    std::span<const RpgContentBlock> leftColumn{};
    std::span<const RpgContentBlock> rightColumn{};
};

struct RpgScreenDescriptor {
    RpgScreenId id = RpgScreenId::CharacterSheet;
    const char* objectName = "";
    const char* titleKey = "";  
    RpgSuperposition superposition = RpgSuperposition::PausesGame;
    RpgScreenLayout layout{};
};

[[nodiscard]] std::span<const RpgScreenDescriptor> rpgScreens() noexcept;

[[nodiscard]] const RpgScreenDescriptor& rpgScreenDescriptor(RpgScreenId screen) noexcept;

[[nodiscard]] RpgScreenId nextRpgScreen(RpgScreenId screen) noexcept;

[[nodiscard]] RpgScreenId previousRpgScreen(RpgScreenId screen) noexcept;

[[nodiscard]] bool pausesGame(RpgScreenId screen) noexcept;
 
}  // namespace hmi