LuaEvent > lua:: named functions. +lua_event.cpp

Source/CMakeLists.txt

@@ -100,6 +100,7 @@ set(libdevilutionx_SRCS
   levels/trigs.cpp
 
   lua/autocomplete.cpp
+  lua/lua_event.cpp
   lua/lua_global.cpp
   lua/modules/audio.cpp
   lua/modules/hellfire.cpp

Source/diablo.cpp

@@ -72,6 +72,7 @@
 #include "levels/trigs.h"
 #include "lighting.h"
 #include "loadsave.h"
+#include "lua/lua_event.hpp"
 #include "lua/lua_global.hpp"
 #include "menu.h"
 #include "minitext.h"
@@ -876,7 +877,7 @@ void RunGameLoop(interface_mode uMsg)
 	nthread_ignore_mutex(false);
 
 	discord_manager::StartGame();
-	LuaEvent("GameStart");
+	lua::GameStart();
 #ifdef GPERF_HEAP_FIRST_GAME_ITERATION
 	unsigned run_game_iteration = 0;
 #endif

Source/engine/render/scrollrt.cpp

@@ -48,7 +48,7 @@
 #include "levels/gendung.h"
 #include "levels/tile_properties.hpp"
 #include "lighting.h"
-#include "lua/lua_global.hpp"
+#include "lua/lua_event.hpp"
 #include "minitext.h"
 #include "missiles.h"
 #include "nthread.h"
@@ -1898,7 +1898,7 @@ void DrawAndBlit()
 
 	DrawFPS(out);
 
-	LuaEvent("GameDrawComplete");
+	lua::GameDrawComplete();
 
 	DrawMain(hgt, drawInfoBox, drawHealth, drawMana, drawBelt, drawControlButtons);
 

Source/lua/lua_event.cpp

@@ -0,0 +1,86 @@
+#include "lua/lua_event.hpp"
+
+#include <optional>
+#include <string_view>
+#include <utility>
+
+#include <sol/sol.hpp>
+
+#include "lua/lua_global.hpp"
+#include "monster.h"
+#include "player.h"
+#include "utils/log.hpp"
+
+namespace devilution {
+
+namespace lua {
+
+template <typename... Args>
+void CallLuaEvent(std::string_view name, Args &&...args)
+{
+	sol::table *events = GetLuaEvents();
+	if (events == nullptr) {
+		return;
+	}
+
+	const auto trigger = events->traverse_get<std::optional<sol::object>>(name, "trigger");
+	if (!trigger.has_value() || !trigger->is<sol::protected_function>()) {
+		LogError("events.{}.trigger is not a function", name);
+		return;
+	}
+	const sol::protected_function fn = trigger->as<sol::protected_function>();
+	SafeCallResult(fn(std::forward<Args>(args)...), /*optional=*/true);
+}
+
+void MonsterDataLoaded()
+{
+	CallLuaEvent("MonsterDataLoaded");
+}
+void UniqueMonsterDataLoaded()
+{
+	CallLuaEvent("UniqueMonsterDataLoaded");
+}
+void ItemDataLoaded()
+{
+	CallLuaEvent("ItemDataLoaded");
+}
+void UniqueItemDataLoaded()
+{
+	CallLuaEvent("UniqueItemDataLoaded");
+}
+
+void StoreOpened(std::string_view name)
+{
+	CallLuaEvent("StoreOpened", name);
+}
+
+void OnMonsterTakeDamage(const Monster *monster, int damage, int damageType)
+{
+	CallLuaEvent("OnMonsterTakeDamage", monster, damage, damageType);
+}
+
+void OnPlayerGainExperience(const Player *player, uint32_t exp)
+{
+	CallLuaEvent("OnPlayerGainExperience", player, exp);
+}
+void OnPlayerTakeDamage(const Player *player, int damage, int damageType)
+{
+	CallLuaEvent("OnPlayerTakeDamage", player, damage, damageType);
+}
+
+void LoadModsComplete()
+{
+	CallLuaEvent("LoadModsComplete");
+}
+void GameDrawComplete()
+{
+	CallLuaEvent("GameDrawComplete");
+}
+void GameStart()
+{
+	CallLuaEvent("GameStart");
+}
+
+} // namespace lua
+
+} // namespace devilution

Source/lua/lua_event.hpp

@@ -1,14 +1,31 @@
 #pragma once
 
+#include <cstdint>
 #include <string_view>
 
 namespace devilution {
 
-/**
+struct Player;
- * @brief Triggers a Lua event by name.
+struct Monster;
- * This is a minimal header for code that only needs to trigger events.
+
- */
+namespace lua {
-void LuaEvent(std::string_view name);
+
-void LuaEvent(std::string_view name, std::string_view arg);
+void MonsterDataLoaded();
+void UniqueMonsterDataLoaded();
+void ItemDataLoaded();
+void UniqueItemDataLoaded();
+
+void StoreOpened(std::string_view name);
+
+void OnMonsterTakeDamage(const Monster *monster, int damage, int damageType);
+
+void OnPlayerGainExperience(const Player *player, uint32_t exp);
+void OnPlayerTakeDamage(const Player *player, int damage, int damageType);
+
+void LoadModsComplete();
+void GameDrawComplete();
+void GameStart();
+
+} // namespace lua
 
 } // namespace devilution

Source/lua/lua_global.cpp

@@ -12,6 +12,7 @@
 #include "appfat.h"
 #include "effects.h"
 #include "engine/assets.hpp"
+#include "lua/lua_event.hpp"
 #include "lua/modules/audio.hpp"
 #include "lua/modules/floatingnumbers.hpp"
 #include "lua/modules/hellfire.hpp"
@@ -254,7 +255,7 @@ void LuaReloadActiveMods()
 	LoadObjectData();
 	LoadQuestData();
 
-	LuaEvent("LoadModsComplete");
+	lua::LoadModsComplete();
 }
 
 void LuaInitialize()
@@ -314,45 +315,9 @@ void LuaShutdown()
 	CurrentLuaState = std::nullopt;
 }
 
-template <typename... Args>
+sol::table *GetLuaEvents()
-void CallLuaEvent(std::string_view name, Args &&...args)
 {
-	if (!CurrentLuaState.has_value()) {
+	return CurrentLuaState ? &CurrentLuaState->events : nullptr;
-		return;
-	}
-
-	const auto trigger = CurrentLuaState->events.traverse_get<std::optional<sol::object>>(name, "trigger");
-	if (!trigger.has_value() || !trigger->is<sol::protected_function>()) {
-		LogError("events.{}.trigger is not a function", name);
-		return;
-	}
-	const sol::protected_function fn = trigger->as<sol::protected_function>();
-	SafeCallResult(fn(std::forward<Args>(args)...), /*optional=*/true);
-}
-
-void LuaEvent(std::string_view name)
-{
-	CallLuaEvent(name);
-}
-
-void LuaEvent(std::string_view name, std::string_view arg)
-{
-	CallLuaEvent(name, arg);
-}
-
-void LuaEvent(std::string_view name, const Player *player, int arg1, int arg2)
-{
-	CallLuaEvent(name, player, arg1, arg2);
-}
-
-void LuaEvent(std::string_view name, const Monster *monster, int arg1, int arg2)
-{
-	CallLuaEvent(name, monster, arg1, arg2);
-}
-
-void LuaEvent(std::string_view name, const Player *player, uint32_t arg1)
-{
-	CallLuaEvent(name, player, arg1);
 }
 
 sol::state &GetLuaState()

Source/lua/lua_global.hpp

@@ -8,20 +8,14 @@
 
 namespace devilution {
 
-struct Player;
-struct Monster;
-
 void LuaInitialize();
 void LuaReloadActiveMods();
 void LuaShutdown();
-void LuaEvent(std::string_view name);
+
-void LuaEvent(std::string_view name, std::string_view arg);
-void LuaEvent(std::string_view name, const Player *player, int arg1, int arg2);
-void LuaEvent(std::string_view name, const Monster *monster, int arg1, int arg2);
-void LuaEvent(std::string_view name, const Player *player, uint32_t arg1);
 sol::state &GetLuaState();
 sol::environment CreateLuaSandbox();
 sol::object SafeCallResult(sol::protected_function_result result, bool optional);
+sol::table *GetLuaEvents();
 
 /** Adds a handler to be called when mods status changes after the initial startup. */
 void AddModsChangedHandler(tl::function_ref<void()> callback);

Source/monster.cpp

@@ -70,7 +70,7 @@
 #include "levels/tile_properties.hpp"
 #include "levels/trigs.h"
 #include "lighting.h"
-#include "lua/lua_global.hpp"
+#include "lua/lua_event.hpp"
 #include "minitext.h"
 #include "missiles.h"
 #include "movie.h"
@@ -3868,7 +3868,7 @@ void AddDoppelganger(Monster &monster)
 
 void ApplyMonsterDamage(DamageType damageType, Monster &monster, int damage)
 {
-	LuaEvent("OnMonsterTakeDamage", &monster, damage, static_cast<int>(damageType));
+	lua::OnMonsterTakeDamage(&monster, damage, static_cast<int>(damageType));
 
 	monster.hitPoints -= damage;
 

Source/player.cpp

@@ -41,7 +41,7 @@
 #include "levels/trigs.h"
 #include "lighting.h"
 #include "loadsave.h"
-#include "lua/lua_global.hpp"
+#include "lua/lua_event.hpp"
 #include "minitext.h"
 #include "missiles.h"
 #include "monster.h"
@@ -2442,7 +2442,7 @@ void Player::_addExperience(uint32_t experience, int levelDelta)
 		clampedExp = std::min<uint32_t>({ clampedExp, /* level 1-5: */ getNextExperienceThreshold() / 20U, /* level 6-50: */ 200U * getCharacterLevel() });
 	}
 
-	LuaEvent("OnPlayerGainExperience", this, clampedExp);
+	lua::OnPlayerGainExperience(this, clampedExp);
 
 	const uint32_t maxExperience = GetNextExperienceThresholdForLevel(getMaxCharacterLevel());
 
@@ -2824,7 +2824,7 @@ void ApplyPlrDamage(DamageType damageType, Player &player, int dam, int minHP /*
 {
 	int totalDamage = (dam << 6) + frac;
 	if (&player == MyPlayer && !player.hasNoLife()) {
-		LuaEvent("OnPlayerTakeDamage", &player, totalDamage, static_cast<int>(damageType));
+		lua::OnPlayerTakeDamage(&player, totalDamage, static_cast<int>(damageType));
 	}
 	if (totalDamage > 0 && player.pManaShield && HasNoneOf(player._pIFlags, ItemSpecialEffect::NoMana)) {
 		const uint8_t manaShieldLevel = player._pSplLvl[static_cast<int8_t>(SpellID::ManaShield)];

Source/stores.cpp

@@ -2204,28 +2204,28 @@ void StartStore(TalkID s)
 	// Fire StoreOpened Lua event for main store entries
 	switch (s) {
 	case TalkID::Smith:
-		LuaEvent("StoreOpened", "griswold");
+		lua::StoreOpened("griswold");
 		break;
 	case TalkID::Witch:
-		LuaEvent("StoreOpened", "adria");
+		lua::StoreOpened("adria");
 		break;
 	case TalkID::Boy:
-		LuaEvent("StoreOpened", "wirt");
+		lua::StoreOpened("wirt");
 		break;
 	case TalkID::Healer:
-		LuaEvent("StoreOpened", "pepin");
+		lua::StoreOpened("pepin");
 		break;
 	case TalkID::Storyteller:
-		LuaEvent("StoreOpened", "cain");
+		lua::StoreOpened("cain");
 		break;
 	case TalkID::Tavern:
-		LuaEvent("StoreOpened", "ogden");
+		lua::StoreOpened("ogden");
 		break;
 	case TalkID::Drunk:
-		LuaEvent("StoreOpened", "farnham");
+		lua::StoreOpened("farnham");
 		break;
 	case TalkID::Barmaid:
-		LuaEvent("StoreOpened", "gillian");
+		lua::StoreOpened("gillian");
 		break;
 	default:
 		break;

Source/tables/itemdat.cpp

@@ -14,7 +14,7 @@
 #include "data/file.hpp"
 #include "data/iterators.hpp"
 #include "data/record_reader.hpp"
-#include "lua/lua_global.hpp"
+#include "lua/lua_event.hpp"
 #include "tables/spelldat.h"
 #include "utils/str_cat.hpp"
 
@@ -619,7 +619,7 @@ void LoadItemDat()
 	ItemMappingIdsToIndices.clear();
 	LoadItemDatFromFile(dataFile, filename, 0);
 
-	LuaEvent("ItemDataLoaded");
+	lua::ItemDataLoaded();
 }
 
 void ReadItemPower(RecordReader &reader, std::string_view fieldName, ItemPower &power)
@@ -676,7 +676,7 @@ void LoadUniqueItemDat()
 	UniqueItemMappingIdsToIndices.clear();
 	LoadUniqueItemDatFromFile(dataFile, filename, 0);
 
-	LuaEvent("UniqueItemDataLoaded");
+	lua::UniqueItemDataLoaded();
 }
 
 void LoadItemAffixesDat(std::string_view filename, std::vector<PLStruct> &out)

Source/tables/monstdat.cpp

@@ -24,7 +24,7 @@
 #include "data/iterators.hpp"
 #include "data/record_reader.hpp"
 #include "items.h"
-#include "lua/lua_global.hpp"
+#include "lua/lua_event.hpp"
 #include "monster.h"
 #include "tables/textdat.h"
 #include "utils/language.h"
@@ -413,7 +413,7 @@ void LoadMonstDat()
 	MonstersData.resize(NUM_DEFAULT_MTYPES); // ensure the hardcoded monster type slots are filled
 	LoadMonstDatFromFile(dataFile, filename, false);
 
-	LuaEvent("MonsterDataLoaded");
+	lua::MonsterDataLoaded();
 
 	MonstersData.shrink_to_fit();
 }
@@ -462,7 +462,7 @@ void LoadUniqueMonstDat()
 	UniqueMonstersData.clear();
 	LoadUniqueMonstDatFromFile(dataFile, filename);
 
-	LuaEvent("UniqueMonsterDataLoaded");
+	lua::UniqueMonsterDataLoaded();
 
 	UniqueMonstersData.shrink_to_fit();
 }