Files
ClassicAPI/src/quest/Data.cpp
T
Brues d9102bae3b Relicense source headers from LGPL to GPL v3
The repo was internally inconsistent: the LICENSE file is GPL v3 but every
src/ header carried the LGPL v3 notice and the README said "LGPL v3 or
later". LGPL was also the wrong fit — this is an injected mod plus a
bundled addon, not a library other code links against, so LGPL's linking
exception buys nothing.

It's also required: src/voicechat/Tts.cpp is ported from awesome_wotlk's
VoiceChat.cpp, which is GPL v3, and a derivative of GPL code cannot be
relicensed under more permissive terms. Dependencies stay compatible —
MinHook (BSD-2) and the nampower-mirrored packet shapes (BSD) are
GPL-compatible, and SAPI is covered by the system-library exception.

Swept "GNU Lesser General Public License" -> "GNU General Public License"
across all 257 src/ headers and changed the README license line to match
the GPL v3 LICENSE file. Comment-only; no build impact.
2026-06-29 16:38:16 -05:00

85 lines
3.6 KiB
C++

// This file is part of ClassicAPI.
//
// ClassicAPI is free software: you can redistribute it and/or modify it under the terms
// of the GNU General Public License as published by the Free Software Foundation, either
// version 3 of the License, or (at your option) any later version.
//
// ClassicAPI is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE. See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with
// ClassicAPI. If not, see <https://www.gnu.org/licenses/>.
#include "Game.h"
#include "event/Custom.h"
#include "quest/Cache.h"
#include <cstdint>
namespace Quest::Data {
static constexpr const char *kQuestDataLoadResult = "QUEST_DATA_LOAD_RESULT";
static const Event::Custom::AutoReserve _reserveQuestDataLoadResult{kQuestDataLoadResult};
// Same `__stdcall(userData, success)` shape as `Item::Data::ItemLoadCallback`.
// The engine's invocation pattern at 0x00562EEB et al. is:
// mov ecx, [entry+0x18] ; userData (= arg4 we passed to _GetRecord)
// push 1 ; success (1/0)
// push ecx ; userData
// call [entry+0x08] ; this callback
// `ret 8` cleans both args. We encode the questID into `userData` at
// request time so the callback knows which quest completed.
static void __stdcall QuestLoadCallback(void *userData, int success) {
const auto questID =
static_cast<int>(reinterpret_cast<uintptr_t>(userData));
Event::Custom::FireIdSuccess(Event::Custom::Lookup(kQuestDataLoadResult),
questID, success != 0);
}
static void RequestAndMaybeNotify(uint32_t questID) {
const bool wasCached = (Quest::Cache::Peek(questID) != nullptr);
void *userData = reinterpret_cast<void *>(static_cast<uintptr_t>(questID));
Quest::Cache::Lookup(questID, reinterpret_cast<void *>(&QuestLoadCallback), userData);
// Cache-hit-already-loaded path: engine returns the record without
// invoking our callback. Fire the event ourselves so addons get the
// notification regardless of cache state, matching modern semantics.
if (wasCached) {
Event::Custom::FireIdSuccess(Event::Custom::Lookup(kQuestDataLoadResult),
static_cast<int>(questID), true);
}
}
static int __fastcall Script_RequestLoadQuestByID(void *L) {
if (!Game::Lua::IsNumber(L, 1)) {
Game::Lua::Error(L, "Usage: C_QuestLog.RequestLoadQuestByID(questID)");
return 0;
}
const int questID = static_cast<int>(Game::Lua::ToNumber(L, 1));
if (questID <= 0)
return 0;
RequestAndMaybeNotify(static_cast<uint32_t>(questID));
return 0;
}
static int __fastcall Script_IsQuestDataCachedByID(void *L) {
const int questID =
Game::Lua::IsNumber(L, 1) ? static_cast<int>(Game::Lua::ToNumber(L, 1)) : 0;
const bool cached =
(questID > 0) && (Quest::Cache::Peek(static_cast<uint32_t>(questID)) != nullptr);
Game::Lua::PushBool(L, cached);
return 1;
}
static void RegisterLuaFunctions() {
Game::Lua::RegisterTableFunction("C_QuestLog", "RequestLoadQuestByID",
&Script_RequestLoadQuestByID);
Game::Lua::RegisterTableFunction("C_QuestLog", "IsQuestDataCachedByID",
&Script_IsQuestDataCachedByID);
// Event name reserved at file scope via `AutoReserve`.
}
static const Game::ModuleAutoRegister _autoreg{&RegisterLuaFunctions};
} // namespace Quest::Data