mirror of
https://github.com/brues-code/ClassicAPI.git
synced 2026-11-16 08:00:42 +00:00
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.
64 lines
2.4 KiB
C++
64 lines
2.4 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 "Offsets.h"
|
|
#include "spell/Arg.h"
|
|
#include "spell/Lookup.h"
|
|
|
|
#include <cstdint>
|
|
|
|
namespace Spell::Description {
|
|
|
|
using FormatSpellDescription_t = void(__fastcall *)(const void *spellRecord, char *outBuf,
|
|
int bufLen, int contextFlag, int reserved3,
|
|
int useToolTipText, int reserved5,
|
|
int reserved6);
|
|
|
|
static int __fastcall Script_GetSpellDescription(void *L) {
|
|
const int spellID = Spell::Arg::ResolveSpellID(L, 1);
|
|
const uint8_t *record = Spell::Lookup::RecordForID(spellID);
|
|
if (record == nullptr)
|
|
return 0; // nil for invalid / out-of-range spell IDs
|
|
|
|
// 1024 bytes is what every engine caller uses (`push 0x400`). Spell
|
|
// descriptions in vanilla don't exceed this in any locale; the helper
|
|
// null-terminates and stops writing on overflow, so the upper bound is
|
|
// self-enforced.
|
|
char buffer[0x400];
|
|
buffer[0] = '\0';
|
|
|
|
auto fn = reinterpret_cast<FormatSpellDescription_t>(
|
|
Offsets::FUN_FORMAT_SPELL_DESCRIPTION);
|
|
fn(record, buffer, sizeof(buffer),
|
|
/*contextFlag*/ 0,
|
|
/*reserved3*/ 0,
|
|
/*useToolTipText*/ 0, // 0 = read description (+0x228), non-zero = ToolTip (+0x24C)
|
|
/*reserved5*/ 1,
|
|
/*reserved6*/ 0);
|
|
|
|
if (buffer[0] == '\0')
|
|
return 0; // empty / no description in current locale → nil
|
|
Game::Lua::PushString(L, buffer);
|
|
return 1;
|
|
}
|
|
|
|
static void RegisterLuaFunctions() {
|
|
Game::Lua::RegisterTableFunction("C_Spell", "GetSpellDescription",
|
|
&Script_GetSpellDescription);
|
|
}
|
|
|
|
static const Game::ModuleAutoRegister _autoreg{&RegisterLuaFunctions};
|
|
|
|
} // namespace Spell::Description
|