From 26bb220a4595495c141fb888a731b3c333ca91df Mon Sep 17 00:00:00 2001 From: Brues <5278969+brues-code@users.noreply.github.com> Date: Wed, 13 May 2026 23:38:59 -0500 Subject: [PATCH] moved all playercache functions to C_PlayerCache --- README.md | 2 +- docs/API.md | 48 ++++++++++++++++++------------------- src/player/NameCache.cpp | 51 ++++++++++++++++++++-------------------- src/player/NameCache.h | 2 +- 4 files changed, 52 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index c9945bd8..2fa772e9 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Full per-function reference: **[docs/API.md](docs/API.md)**. | Hooks | `hooksecurefunc` | | Input | `IsLeftAltKeyDown`, `IsLeftControlKeyDown`, `IsLeftShiftKeyDown`, `IsModifierKeyDown`, `IsRightAltKeyDown`, `IsRightControlKeyDown`, `IsRightShiftKeyDown` | | Item | `C_Item.DoesItemExist`, `C_Item.DoesItemExistByID`, `C_Item.EquipItemByName`, `C_Item.GetCurrentItemLevel`, `C_Item.GetDetailedItemLevelInfo`, `C_Item.GetItemCount`, `C_Item.GetItemFamily`, `C_Item.GetItemGUID`, `C_Item.GetItemIcon`, `C_Item.GetItemIconByID`, `C_Item.GetItemID`, `C_Item.GetItemInfoInstant`, `C_Item.GetItemInventoryType`, `C_Item.GetItemInventoryTypeByID`, `C_Item.GetItemLink`, `C_Item.GetItemLocation`, `C_Item.GetItemMaxStackSize`, `C_Item.GetItemMaxStackSizeByID`, `C_Item.GetItemName`, `C_Item.GetItemNameByID`, `C_Item.GetItemQuality`, `C_Item.GetItemQualityByID`, `C_Item.GetItemSpell`, `C_Item.IsBound`, `C_Item.IsEquippableItem`, `C_Item.IsEquippedItem`, `C_Item.IsItemDataCached`, `C_Item.IsItemDataCachedByID`, `C_Item.IsLocked`, `C_Item.RequestLoadItemData`, `C_Item.RequestLoadItemDataByID`, `GetAuctionItemID`, `GetAuctionSellItemID`, `GetCraftReagentItemID`, `GetInboxItemID`, `GetInventoryItemDurability`, `GetInventoryItemID`, `GetInventoryItemRepairCost`, `GetItemIcon`, `GetLootRollItemID`, `GetLootSlotItemID`, `GetMerchantItemID`, `GetQuestItemID`, `GetQuestLogItemID`, `GetTradePlayerItemID`, `GetTradeSkillItemID`, `GetTradeSkillReagentItemID`, `GetTradeTargetItemID`, `OffhandHasWeapon` | -| NameCache | `C_PlayerInfo.GUIDIsCreature`, `C_PlayerInfo.GUIDIsGameObject`, `C_PlayerInfo.GUIDIsPet`, `C_PlayerInfo.GUIDIsPlayer`, `C_PlayerInfo.RememberPlayer`, `ClassicAPI.GetNameCacheScanEnabled`, `ClassicAPI.GetPersistentNameCacheEnabled`, `ClassicAPI.SetNameCacheScanEnabled`, `ClassicAPI.SetPersistentNameCacheEnabled`, `GetPlayerInfoByGUID` | +| NameCache | `C_PlayerCache.IsEnabled`, `C_PlayerCache.IsScanEnabled`, `C_PlayerCache.RememberPlayer`, `C_PlayerCache.SetEnabled`, `C_PlayerCache.SetScanEnabled`, `C_PlayerInfo.GUIDIsCreature`, `C_PlayerInfo.GUIDIsGameObject`, `C_PlayerInfo.GUIDIsPet`, `C_PlayerInfo.GUIDIsPlayer`, `GetPlayerInfoByGUID` | | Quest | `C_QuestLog.GetTitleForQuestID`, `C_QuestLog.RequestLoadQuestByID`, `GetQuestIDFromLogIndex` | | Spell | `C_Spell.GetSpellDescription`, `C_Spell.GetSpellInfo`, `C_Spell.GetSpellLink`, `C_Spell.GetSpellName`, `C_Spell.GetSpellTexture`, `C_Spell.IsSpellPassive`, `C_Spell.IsSpellUsable`, `CastAutoRepeatSpell`, `FindSpellBookSlotByID`, `GetCraftSpellID`, `GetSpellInfo`, `GetSpellLink`, `GetSpellSchool`, `IsPassiveSpell`, `IsPlayerSpell`, `IsSpellKnown`, `IsUsableSpell` | | State | `IsAssistingRitual`, `IsFalling`, `IsMounted`, `IsStealthed`, `IsSwimming` | diff --git a/docs/API.md b/docs/API.md index e6b0e127..aa618efa 100644 --- a/docs/API.md +++ b/docs/API.md @@ -119,12 +119,12 @@ build instructions. - [`C_UnitAuras.GetAuraDispelTypeColor(dispelName)`](#c_unitaurasgetauradispeltypecolordispelname) - [NameCache](#namecache) - [`GetPlayerInfoByGUID(guid)`](#getplayerinfobyguidguid) - - [`C_PlayerInfo.RememberPlayer(guid, name, classToken)`](#c_playerinforememberplayerguid-name-classtoken) - [`C_PlayerInfo.GUIDIsPlayer(guid)` / `GUIDIsCreature` / `GUIDIsPet` / `GUIDIsGameObject`](#c_playerinfoguidisplayerguid--guidiscreature--guidispet--guidisgameobject) - - [`ClassicAPI.SetPersistentNameCacheEnabled(enabled)`](#classicapisetpersistentnamecacheenabledenabled) - - [`ClassicAPI.GetPersistentNameCacheEnabled()`](#classicapigetpersistentnamecacheenabled) - - [`ClassicAPI.SetNameCacheScanEnabled(enabled)`](#classicapisetnamecachescanenabledenabled) - - [`ClassicAPI.GetNameCacheScanEnabled()`](#classicapigetnamecachescanenabled) + - [`C_PlayerCache.RememberPlayer(guid, name, classToken)`](#c_playercacherememberplayerguid-name-classtoken) + - [`C_PlayerCache.SetEnabled(enabled)`](#c_playercachesetenabledenabled) + - [`C_PlayerCache.IsEnabled()`](#c_playercacheisenabled) + - [`C_PlayerCache.SetScanEnabled(enabled)`](#c_playercachesetscanenabledenabled) + - [`C_PlayerCache.IsScanEnabled()`](#c_playercacheisscanenabled) - [State](#state) - [`IsMounted()`](#ismounted) - [`IsStealthed()`](#isstealthed) @@ -3019,10 +3019,10 @@ entries the SMSG path would never reach on its own. Two toggles, each independent: -- **`SetPersistentNameCacheEnabled`** — turn on the on-disk cache. +- **`C_PlayerCache.SetEnabled`** — turn on the on-disk cache. Off by default. Without this, the module is read-only against the engine's transient in-memory cache. -- **`SetNameCacheScanEnabled`** — turn on the visible-object +- **`C_PlayerCache.SetScanEnabled`** — turn on the visible-object sweep. Off by default. Requires the on-disk cache to be enabled to have any effect. @@ -3033,7 +3033,7 @@ Three population sources feed the cache when fully enabled: processes is mirrored to disk. Covers chat, group/raid sync, guild updates, visible-object resolution — anything the engine itself issues a name query for. -2. **`C_PlayerInfo.RememberPlayer`** (always available, no-op +2. **`C_PlayerCache.RememberPlayer`** (always available, no-op when the cache is off). Lets addons feed in sources the engine never sees: `/who` results, etc. 3. **Visible-object sweep** (active when both toggles are on). @@ -3090,7 +3090,7 @@ future `C_PlayerInfo.RequestLoadPlayerByID` would do that explicitly and fire a load-result event. **Persistent fallback**: when -[`ClassicAPI.SetPersistentNameCacheEnabled(true)`](#classicapisetpersistentnamecacheenabledenabled) +[`C_PlayerCache.SetEnabled(true)`](#c_playercachesetenabledenabled) has been opted into, a per-realm on-disk cache extends coverage across sessions. On engine cache miss, `GetPlayerInfoByGUID` falls back to the persistent cache and returns `name`, `class`, `race`, @@ -3104,7 +3104,7 @@ instance lives at `0x00C0E228`; entry layout (name, realm, race, sex, class) was reverse-engineered from the `SMSG_NAME_QUERY_RESPONSE` write path at `0x0055F310`. -### `C_PlayerInfo.RememberPlayer(guid, name, classToken)` +### `C_PlayerCache.RememberPlayer(guid, name, classToken)` Adds a `(guid → name, classID, raceID, sex)` entry to the persistent name cache. For the engine-driven coverage (chat / group / guild / @@ -3116,7 +3116,7 @@ NameCache doesn't see directly: `/who` results, mouseover, target snapshots, etc. ``` -C_PlayerInfo.RememberPlayer(guid, name, classToken [, raceToken [, sex]]) +C_PlayerCache.RememberPlayer(guid, name, classToken [, raceToken [, sex]]) ``` Returns `true` on success, `false` if the persistent cache isn't @@ -3199,7 +3199,7 @@ Accepts either the 16-digit `"0xHHHHHHHHLLLLLLLL"` form or the Malformed input returns `false` rather than raising — matching modern's tolerance for stale GUIDs from addon-side caches. -### `ClassicAPI.SetPersistentNameCacheEnabled(enabled)` +### `C_PlayerCache.SetEnabled(enabled)` Opts into (or out of) the persistent name cache. `enabled` is a boolean (numeric `0`/`1` also accepted). Persists to @@ -3211,37 +3211,37 @@ When enabled: - Every `SMSG_NAME_QUERY_RESPONSE` the engine processes is also written to `WTF\Account\\\ClassicAPI_NameCache.txt`. -- Lua-side `C_PlayerInfo.RememberPlayer` calls become effective +- Lua-side `C_PlayerCache.RememberPlayer` calls become effective (they're no-ops when the cache is disabled). - `GetPlayerInfoByGUID` gains the cross-session fallback path documented above. -- [`SetNameCacheScanEnabled`](#classicapisetnamecachescanenabledenabled) +- [`SetScanEnabled`](#c_playercachesetscanenabledenabled) becomes effective if also turned on. When disabled, the on-disk file is left in place (re-enabling later restores the prior contents); future writes are simply suppressed. ```lua -ClassicAPI.SetPersistentNameCacheEnabled(true) +C_PlayerCache.SetEnabled(true) ``` Returns nothing. -### `ClassicAPI.GetPersistentNameCacheEnabled()` +### `C_PlayerCache.IsEnabled()` Returns the current state of the persistent name cache as a boolean. `false` until -[`SetPersistentNameCacheEnabled`](#classicapisetpersistentnamecacheenabledenabled) +[`SetEnabled`](#c_playercachesetenabledenabled) has been called (or its prior call survived in the on-disk settings file). ```lua -if ClassicAPI.GetPersistentNameCacheEnabled() then +if C_PlayerCache.IsEnabled() then -- persistent fallback is active for GetPlayerInfoByGUID end ``` -### `ClassicAPI.SetNameCacheScanEnabled(enabled)` +### `C_PlayerCache.SetScanEnabled(enabled)` Opts into the **visible-object sweep**: an opportunistic walk of the engine's live visible-object list that feeds every player in @@ -3255,8 +3255,8 @@ no extra hooks installed. `NameCacheScanEnabled=1`/`0`. ```lua -ClassicAPI.SetPersistentNameCacheEnabled(true) -- prerequisite -ClassicAPI.SetNameCacheScanEnabled(true) +C_PlayerCache.SetEnabled(true) -- prerequisite +C_PlayerCache.SetScanEnabled(true) -- Now: standing in Stormwind for a minute pre-populates the cache -- with every visible player's name and class. ``` @@ -3280,7 +3280,7 @@ comes from the CGObject vftable's `GetName` slot; class is the byte at `[m_objectFields + 0x79]` (UNIT_FIELD_BYTES_0 byte 1, same field `Script_UnitClass` reads). -### `ClassicAPI.GetNameCacheScanEnabled()` +### `C_PlayerCache.IsScanEnabled()` Returns the current visible-object scan setting as a boolean. Independent of the cache toggle — this only reflects the scan- @@ -3288,8 +3288,8 @@ specific setting, not whether the scan is *effectively* running (which also requires the cache to be on). ```lua -if ClassicAPI.GetNameCacheScanEnabled() - and ClassicAPI.GetPersistentNameCacheEnabled() then +if C_PlayerCache.IsScanEnabled() + and C_PlayerCache.IsEnabled() then -- visible-object sweeps are running every ~10s end ``` diff --git a/src/player/NameCache.cpp b/src/player/NameCache.cpp index eff49369..cb4e0896 100644 --- a/src/player/NameCache.cpp +++ b/src/player/NameCache.cpp @@ -34,11 +34,11 @@ // — every SMSG_NAME_QUERY_RESPONSE the engine processes flows // through here. Covers chat, group/raid sync, guild roster // updates, visible-object resolution. -// 2. `C_PlayerInfo.RememberPlayer(guid, name, classToken)` from +// 2. `C_PlayerCache.RememberPlayer(guid, name, classToken)` from // Lua — lets addons feed in sources the engine cache doesn't // touch directly (e.g. /who results parsed via GetWhoInfo, // mouseover, target). -// 3. **Visible-object sweep** (opt-in via `NameCacheScanEnabled`): +// 3. **Visible-object sweep** (opt-in via `C_PlayerCache.SetScanEnabled`): // walks the engine's live visible-object list every ~10s on // the existing `Frame::RegisterEvent` hook. Picks up every // player in render range whether or not the engine has issued @@ -592,7 +592,7 @@ uint32_t ResolveRaceToken(const char *token) { return 0; } -// `C_PlayerInfo.RememberPlayer(guid, name, classToken [, raceToken +// `C_PlayerCache.RememberPlayer(guid, name, classToken [, raceToken // [, sex]])` — stores the entry in the persistent cache. Class and // race tokens are uppercase engine tokens (`"WARRIOR"`, `"NIGHTELF"`, // etc.); sex is `0` (male) or `1` (female), matching the wire-format @@ -600,7 +600,7 @@ uint32_t ResolveRaceToken(const char *token) { // passing only the first three preserves the old 3-arg signature. // Returns `true` on success, `false` if the cache is disabled or the // required args are malformed. -int __fastcall Script_C_PlayerInfo_RememberPlayer(void *L) { +int __fastcall Script_C_PlayerCache_RememberPlayer(void *L) { if (!IsEnabled()) { Game::Lua::PushBoolean(L, 0); return 1; @@ -608,7 +608,7 @@ int __fastcall Script_C_PlayerInfo_RememberPlayer(void *L) { if (!Game::Lua::IsString(L, 1) || !Game::Lua::IsString(L, 2) || !Game::Lua::IsString(L, 3)) { Game::Lua::Error(L, - "Usage: C_PlayerInfo.RememberPlayer(guid, name, classToken [, raceToken [, sex]])"); + "Usage: C_PlayerCache.RememberPlayer(guid, name, classToken [, raceToken [, sex]])"); return 0; } uint64_t guid; @@ -645,10 +645,11 @@ int __fastcall Script_C_PlayerInfo_RememberPlayer(void *L) { return 1; } -// `ClassicAPI.SetPersistentNameCacheEnabled(bool)` — opt-in toggle. -// Persists to the account-level settings file. Enabling triggers a -// lazy load of any prior cache contents for the current realm. -int __fastcall Script_ClassicAPI_SetPersistentNameCacheEnabled(void *L) { +// `C_PlayerCache.SetEnabled(bool)` — opt-in toggle for the persistent +// name cache. Persists to the account-level settings file. Enabling +// triggers a lazy load of any prior cache contents for the current +// realm. +int __fastcall Script_C_PlayerCache_SetEnabled(void *L) { LoadSettingsIfNeeded(); bool desired = false; if (Game::Lua::IsNumber(L, 1)) @@ -669,18 +670,18 @@ int __fastcall Script_ClassicAPI_SetPersistentNameCacheEnabled(void *L) { return 0; } -int __fastcall Script_ClassicAPI_GetPersistentNameCacheEnabled(void *L) { +int __fastcall Script_C_PlayerCache_IsEnabled(void *L) { LoadSettingsIfNeeded(); Game::Lua::PushBoolean(L, g_enabled ? 1 : 0); return 1; } -// `ClassicAPI.SetNameCacheScanEnabled(bool)` — opt-in toggle for the -// visible-object sweep. Independent of the cache toggle: turning this -// on without `SetPersistentNameCacheEnabled(true)` does nothing +// `C_PlayerCache.SetScanEnabled(bool)` — opt-in toggle for the +// visible-object sweep. Independent of the cache toggle: turning +// this on without `C_PlayerCache.SetEnabled(true)` does nothing // (scan results would have nowhere to go). Persists to the same // account-level settings file. -int __fastcall Script_ClassicAPI_SetNameCacheScanEnabled(void *L) { +int __fastcall Script_C_PlayerCache_SetScanEnabled(void *L) { LoadSettingsIfNeeded(); bool desired = false; if (Game::Lua::IsNumber(L, 1)) @@ -694,23 +695,23 @@ int __fastcall Script_ClassicAPI_SetNameCacheScanEnabled(void *L) { return 0; } -int __fastcall Script_ClassicAPI_GetNameCacheScanEnabled(void *L) { +int __fastcall Script_C_PlayerCache_IsScanEnabled(void *L) { LoadSettingsIfNeeded(); Game::Lua::PushBoolean(L, g_scanEnabled ? 1 : 0); return 1; } void RegisterLuaFunctions() { - Game::Lua::RegisterTableFunction("C_PlayerInfo", "RememberPlayer", - &Script_C_PlayerInfo_RememberPlayer); - Game::Lua::RegisterTableFunction("ClassicAPI", "SetPersistentNameCacheEnabled", - &Script_ClassicAPI_SetPersistentNameCacheEnabled); - Game::Lua::RegisterTableFunction("ClassicAPI", "GetPersistentNameCacheEnabled", - &Script_ClassicAPI_GetPersistentNameCacheEnabled); - Game::Lua::RegisterTableFunction("ClassicAPI", "SetNameCacheScanEnabled", - &Script_ClassicAPI_SetNameCacheScanEnabled); - Game::Lua::RegisterTableFunction("ClassicAPI", "GetNameCacheScanEnabled", - &Script_ClassicAPI_GetNameCacheScanEnabled); + Game::Lua::RegisterTableFunction("C_PlayerCache", "RememberPlayer", + &Script_C_PlayerCache_RememberPlayer); + Game::Lua::RegisterTableFunction("C_PlayerCache", "SetEnabled", + &Script_C_PlayerCache_SetEnabled); + Game::Lua::RegisterTableFunction("C_PlayerCache", "IsEnabled", + &Script_C_PlayerCache_IsEnabled); + Game::Lua::RegisterTableFunction("C_PlayerCache", "SetScanEnabled", + &Script_C_PlayerCache_SetScanEnabled); + Game::Lua::RegisterTableFunction("C_PlayerCache", "IsScanEnabled", + &Script_C_PlayerCache_IsScanEnabled); } const Game::ModuleAutoRegister _autoreg{&RegisterLuaFunctions}; diff --git a/src/player/NameCache.h b/src/player/NameCache.h index 1fdbffe6..7c83018f 100644 --- a/src/player/NameCache.h +++ b/src/player/NameCache.h @@ -18,7 +18,7 @@ // Opt-in persistent name cache, keyed by GUID. When enabled, every // SMSG_NAME_QUERY_RESPONSE the engine processes — plus anything fed -// in via `C_PlayerInfo.RememberPlayer` from Lua — is persisted to +// in via `C_PlayerCache.RememberPlayer` from Lua — is persisted to // `WTF\Account\\\ClassicAPI_NameCache.txt` and survives // across sessions on the same realm. Shared across all characters // on that account+realm, so a 50-character bank alt's cache is