MenuCursor.hpp

Go to the documentation of this file.

#pragma once
 
#include <VoltMod/Menu/MenuModel.hpp>
#include <functional>
 
namespace VoltMod
{
 
/** Rows available to cursor navigation. */
struct CursorRows
{
    /** Number of rows. */
    int Count = 0;
 
    /** True when the cursor may stop on @p index. Unset means every row takes it. */
    std::function<bool(int index)> Selectable;
};
 
namespace MenuCursor
{
/** @p index moved by @p step, wrapping over @p rows and skipping what it may not land on. */
int Step(const CursorRows& rows, int index, int step);
 
/** First selectable row. */
int First(const CursorRows& rows);
 
/** Moves @p index by @p delta pages while preserving its page offset. */
int JumpPage(const CursorRows& rows, int index, int rowsPerPage, int delta);
}  // namespace MenuCursor
 
}  // namespace VoltMod