Documentation

This commit is contained in:
Pcornat 2026-02-27 22:10:35 +01:00
commit 79d575da10
Signed by: Pcornat
GPG key ID: E0326CC678A00BDD

View file

@ -55,8 +55,22 @@ namespace character {
static void from_json(const json &j, container &billy); static void from_json(const json &j, container &billy);
/*!
* \brief It inserts the object inside the sheet.
*
* This method changes values inside the sheet according to the book's rules.
* \param sheet sheet to insert object into
* \param objType the object to insert
* \return true: object inserted, false otherwise
*/
[[nodiscard]] bool insert_object(CharacterSheet &sheet, const billyEnums objType) noexcept; [[nodiscard]] bool insert_object(CharacterSheet &sheet, const billyEnums objType) noexcept;
/*!
* \brief
* \param sheet sheet to erase object from
* \param objToErase the object to erase
* \return true: object erased, false otherwise
*/
[[nodiscard]] bool erase_object(CharacterSheet &sheet, const billyEnums objToErase) noexcept; [[nodiscard]] bool erase_object(CharacterSheet &sheet, const billyEnums objToErase) noexcept;
[[nodiscard]] static bool is_full(const CharacterSheet &sheet) noexcept; [[nodiscard]] static bool is_full(const CharacterSheet &sheet) noexcept;
@ -72,6 +86,12 @@ namespace character {
std::minus<std::uint32_t> minus; std::minus<std::uint32_t> minus;
/*!
* \brief
* \param arg object used to change values
* \param sheet sheet to change
* \param operation Operation to apply to change values
*/
static void change_carac(const billyObjects &arg, static void change_carac(const billyObjects &arg,
CharacterSheet &sheet, CharacterSheet &sheet,
const std::function<uint32_t(uint32_t, uint32_t)> &operation) noexcept; const std::function<uint32_t(uint32_t, uint32_t)> &operation) noexcept;