Lua bindings to get/set MMM unlocks

Author: sruon

scripts/specs/core/CBaseEntity.lua

@@ -908,6 +908,28 @@ end
 function CBaseEntity:setHomePoint()
 end
 
+---@param voucherId integer
+---@return nil
+function CBaseEntity:learnMazeVoucher(voucherId)
+end
+
+---@nodiscard
+---@param voucherId integer
+---@return boolean
+function CBaseEntity:hasMazeVoucher(voucherId)
+end
+
+---@param runeId integer
+---@return nil
+function CBaseEntity:learnMazeRune(runeId)
+end
+
+---@nodiscard
+---@param runeId integer
+---@return boolean
+function CBaseEntity:hasMazeRune(runeId)
+end
+
 ---@param charName string
 ---@return nil
 function CBaseEntity:resetPlayer(charName)

src/map/lua/lua_baseentity.cpp

@@ -3924,6 +3924,82 @@ void CLuaBaseEntity::setHomePoint()
                      PChar->id);
 }
 
+/************************************************************************
+ *  Function: learnMazeVoucher(uint8)
+ *  Purpose : Marks a Moblin Maze Mongers voucher as learned, persists it,
+ *            and refreshes the client's voucher/rune list.
+ *  Example : player:learnMazeVoucher(xi.maze.voucher.SANITIZATION_TEAM_ALPHA)
+ ************************************************************************/
+
+void CLuaBaseEntity::learnMazeVoucher(uint8 voucherId)
+{
+    auto* PChar = dynamic_cast<CCharEntity*>(m_PBaseEntity);
+    if (!PChar)
+    {
+        ShowWarningFmt("CLuaBaseEntity::learnMazeVoucher called on non-PC entity ({}).", m_PBaseEntity->getName());
+        return;
+    }
+
+    PChar->maze().learnVoucher(voucherId);
+    charutils::SaveMazeUnlocks(PChar);
+}
+
+/************************************************************************
+ *  Function: hasMazeVoucher(uint8)
+ *  Purpose : Returns true if the player has learned the given voucher.
+ *  Example : player:hasMazeVoucher(xi.maze.voucher.SANITIZATION_TEAM_ALPHA)
+ ************************************************************************/
+
+auto CLuaBaseEntity::hasMazeVoucher(uint8 voucherId) -> bool
+{
+    auto* PChar = dynamic_cast<CCharEntity*>(m_PBaseEntity);
+    if (!PChar)
+    {
+        ShowWarningFmt("CLuaBaseEntity::hasMazeVoucher called on non-PC entity ({}).", m_PBaseEntity->getName());
+        return false;
+    }
+
+    return PChar->maze().hasVoucher(voucherId);
+}
+
+/************************************************************************
+ *  Function: learnMazeRune(uint8)
+ *  Purpose : Marks a Moblin Maze Mongers rune as learned, persists it,
+ *            and refreshes the client's voucher/rune list.
+ *  Example : player:learnMazeRune(xi.maze.rune.GUIDANCE_CONTRACT)
+ ************************************************************************/
+
+void CLuaBaseEntity::learnMazeRune(uint16 runeId)
+{
+    auto* PChar = dynamic_cast<CCharEntity*>(m_PBaseEntity);
+    if (!PChar)
+    {
+        ShowWarningFmt("CLuaBaseEntity::learnMazeRune called on non-PC entity ({}).", m_PBaseEntity->getName());
+        return;
+    }
+
+    PChar->maze().learnRune(runeId);
+    charutils::SaveMazeUnlocks(PChar);
+}
+
+/************************************************************************
+ *  Function: hasMazeRune(uint16)
+ *  Purpose : Returns true if the player has learned the given rune.
+ *  Example : player:hasMazeRune(xi.maze.rune.GUIDANCE_CONTRACT)
+ ************************************************************************/
+
+auto CLuaBaseEntity::hasMazeRune(uint16 runeId) -> bool
+{
+    auto* PChar = dynamic_cast<CCharEntity*>(m_PBaseEntity);
+    if (!PChar)
+    {
+        ShowWarningFmt("CLuaBaseEntity::hasMazeRune called on non-PC entity ({}).", m_PBaseEntity->getName());
+        return false;
+    }
+
+    return PChar->maze().hasRune(runeId);
+}
+
 /************************************************************************
  *  Function: resetPlayer()
  *  Purpose : Delete player's account session and send them to Lower Jeuno
@@ -19808,6 +19884,10 @@ void CLuaBaseEntity::Register()
     SOL_REGISTER("setTeleportMenu", CLuaBaseEntity::setTeleportMenu);
     SOL_REGISTER("getTeleportMenu", CLuaBaseEntity::getTeleportMenu);
     SOL_REGISTER("setHomePoint", CLuaBaseEntity::setHomePoint);
+    SOL_REGISTER("learnMazeVoucher", CLuaBaseEntity::learnMazeVoucher);
+    SOL_REGISTER("hasMazeVoucher", CLuaBaseEntity::hasMazeVoucher);
+    SOL_REGISTER("learnMazeRune", CLuaBaseEntity::learnMazeRune);
+    SOL_REGISTER("hasMazeRune", CLuaBaseEntity::hasMazeRune);
     SOL_REGISTER("resetPlayer", CLuaBaseEntity::resetPlayer);
 
     SOL_REGISTER("gotoEntity", CLuaBaseEntity::gotoEntity);

src/map/lua/lua_baseentity.h

@@ -236,6 +236,11 @@ class CLuaBaseEntity
     auto   getTeleportMenu(uint8 type) -> sol::table;
     void   setHomePoint();
 
+    void learnMazeVoucher(uint8 voucherId);
+    auto hasMazeVoucher(uint8 voucherId) -> bool;
+    void learnMazeRune(uint16 runeId);
+    auto hasMazeRune(uint16 runeId) -> bool;
+
     void resetPlayer(const char* charName);
 
     void gotoEntity(uint32 targetID, const sol::object& option);

src/map/utils/charutils.cpp

@@ -54,6 +54,7 @@
 #include "packets/s2c/0x061_clistatus.h"
 #include "packets/s2c/0x062_clistatus2.h"
 #include "packets/s2c/0x0ac_command_data.h"
+#include "packets/s2c/0x0ad_dungeon.h"
 #include "packets/s2c/0x0e0_group_comlink.h"
 #include "packets/s2c/0x119_abil_recast.h"
 
@@ -6716,6 +6717,18 @@ void SaveTeleport(CCharEntity* PChar, TELEPORT_TYPE type)
     }
 }
 
+void SaveMazeUnlocks(CCharEntity* PChar)
+{
+    TracyZoneScoped;
+
+    db::preparedStmt("UPDATE char_unlocks SET maze_vouchers = ?, maze_runes = ? WHERE charid = ? LIMIT 1",
+                     PChar->maze().vouchers,
+                     PChar->maze().runes,
+                     PChar->id);
+
+    PChar->pushPacket<GP_SERV_COMMAND_DUNGEON>(PChar);
+}
+
 void SaveLastLogout(const CCharEntity* PChar)
 {
     TracyZoneScoped;

src/map/utils/charutils.h

@@ -218,6 +218,7 @@ void SaveCampaignAllegiance(const CCharEntity* PChar);          // save the char
 void SaveCharMoghancement(const CCharEntity* PChar);            // save the character's current moghancement
 void SaveCharSkills(const CCharEntity* PChar, uint8 skillID);   // save the character's skills
 void SaveTeleport(CCharEntity* PChar, TELEPORT_TYPE type);      // save the character's teleports (homepoints, outposts, maws, etc)
+void SaveMazeUnlocks(CCharEntity* PChar);                       // save the character's learned Moblin Maze Mongers vouchers and runes
 void SaveDeathTime(CCharEntity* PChar);                         // save when this character last died
 void SavePlayTime(CCharEntity* PChar);                          // save this character's total play time
 void SaveLastLogout(const CCharEntity* PChar);                  // save the last logout time of this character