mirror of
https://github.com/brues-code/ClassicAPI.git
synced 2026-11-16 16:10:36 +00:00
6f55df19faf97a43a2a6715fcdd8a764b855c739
578
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
|
889a096963 |
feat(chat): give CHAT_MSG_* 4.3.4's lineID and sender GUID (arg11, arg12)
4.3.4's SendChatEvent fires every chat event with lineID and the sender's GUID string after the ten arguments 1.12 already passes. 1.12 fires all ten from one FUN_FIRE_EVENT call in FUN_0049B0B0, so that call is redirected to append them: - arg11 lineID: ++counter per message, before its event fires; 0 for text emotes, as 4.3.4's AddTextEmoteMessage passes. - arg12 guid: the sender's GUID only for a player sender and a message not tagged GM, "" otherwise. The redirect also works under Turtle's .tdata detour on the same function, which returns to the PUSH just before the CALL. GetCurrentChatGUID() stays and now reads the same sender, nil where arg12 is "". It moves into the new Chat::EventArgs module with the redirect. The sender GUID was wrong or missing on several paths, all fixed here: - Monster say/yell put the monster's TARGET (often the local player) in the pair we published; the packet layout (vmangos BuildChatPacket, matching FUN_0049D560's reads) sends sender, name, target. Monster chat now has no sender, as in 4.3.4. - Raid boss whispers are rewritten to a plain whisper carrying the target, so they reported the local player as sender. An SMSG_MESSAGECHAT subscriber keeps the wire type for the dispatch that follows. - A message from a sender the name cache did not know was queued and later dispatched with both GUID pairs zeroed, by the name-query callback FUN_0049CCC0 or the enter-world drain FUN_0049D230. The queue entry keeps the GUID, and both callers pass pointers into it. - Text emotes fire without passing their GUID on; the builder is co-hooked to provide it. Chat::Dispatch's argument labels are corrected too: the pair it called the target GUID is the speaker the speech bubble is placed on. |
||
|
|
99de63755b |
CreateFrame("Cooldown") (#106)
* feat(frame): CreateFrame("Cooldown") builds vanilla's cooldown Model
Later clients have a native Cooldown frame type; vanilla draws cooldown
sweeps with a Model from FrameXML's CooldownFrameTemplate, driven by
CooldownFrame_SetTimer, and its CreateFrame rejects the type name
("Unknown frame type 'Cooldown'"). Ported code writes
CreateFrame("Cooldown", name, parent, "CooldownFrameTemplate") and then
calls CooldownFrame_SetTimer - Zygor Guides Viewer 2.0 does it while
building its guide window, which stopped there.
In the CreateFrame hook, build a "Cooldown" request as "Model", defaulting
the template to CooldownFrameTemplate when none is given.
Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0):
CreateFrame("Cooldown", nil, UIParent, "CooldownFrameTemplate") returns a
Model, and Zygor's guide window builds.
* feat(frame): give the Cooldown frame 4.3.4's methods
4.3.4's CGCooldown_Scripts registers SetCooldown, SetReverse,
GetReverse, SetDrawEdge and GetDrawEdge. The Cooldown frame built by
the CreateFrame hook now has the same five: SetCooldown takes start
and duration in seconds and errors as 4.3.4 does when either is not a
number, the setters read their value as 4.3.4's StringToBOOL does,
and both flags start false.
The hook marks each frame it builds as a Cooldown. The methods keep
their state per marked frame, SetCooldown drives the sweep through
CooldownFrame_SetTimer, and a marked frame reports its type as
"Cooldown" from GetObjectType / GetFrameType and answers
IsObjectType("Cooldown"). Every other frame delegates to the engine's
own type methods.
The reverse and draw-edge flags are stored and reported, but do not
change how the sweep draws: the sweep has no reversed form and no
edge. The five methods sit on the Model registry, so a Model that was
not built as a Cooldown raises the wrong-object-type error when one
is called on it.
---------
Co-authored-by: Jared Reni <jaredreni@gmail.com>
|
||
|
|
7cd891e86c |
fix(bindings): follow 4.3.4's bindings, modified clicks and key state
Modified clicks: IsModifiedClick, GetModifiedClick, SetModifiedClick, GetNumModifiedClickActions and GetModifiedClickAction, with 4.3.4's <ModifiedClick> Bindings.xml node and its 18 defaults. Each binding set loads, saves and copies them through co-hooks on the engine's own binding-set steps, in 4.3.4's "modifiedclick" file lines. [mod:] asks IsModifiedClick, as 4.3.4's macro conditions do. Direct actions run as 4.3.4's ExecKey runs them: SPELL / ITEM / MACRO on key release through 1.12's spellbook, item and macro functions, cast at you for SELFCAST and at your focus for FOCUSCAST; CLICK sends the frame a mouse down and up, with 4.3.4's virtual-click button logic built from the button's own methods. RunBinding no longer runs them. While a key binding runs, its own modifiers count as released for every modifier read, the engine's IsKeyDown included. Overrides follow 4.3.4: two lists per key, checked inside the key lookup at both of 1.12's lookup steps; GetBindingAction takes checkOverride; isPriority is loose; "" removes; the owner must be a frame. ActionButtonUseKeyDown (default 0) and 4.3.4's action-button key handlers, ported onto 1.12's bars. |
||
|
|
6e50577565 |
fix(target): follow 4.3.4's TargetNearest and TargetDirection
TargetNearest, TargetNearestEnemyPlayer and TargetNearestFriendPlayer now run the engine's own tab cycle (FUN_00493F60), which is 4.3.4's TargetNearestEnemy: units in front first, the targetNearestDistance / targetNearestDistanceRadius ranges, no critters or unseen units, and the 3 s / 1 s snapshot shared with the native functions. A co-hook on its predicate adds 4.3.4's types 0, 2 and 4 as three new modes. TargetNearest now cycles any unit, as in 4.3.4. TargetDirectionEnemy / TargetDirectionFriend are now 4.3.4's CGGameUI::TargetDirection, built on 1.12's GetScreenCoordinates, the camera's forward vector and the tab search's tests: facing is a screen direction relative to the camera, the search starts at the target when it is on screen, the cone is at least 22.5 degrees, and a hit locks further calls until the new TargetDirectionFinished(). |
||
|
|
024c6d2021 |
feat(chat): prefix %t with the target's raid marker, as 4.3.4 does
4.3.4's chat parser prefixes both of its name codes, %f and %t / %n,
with {rtN} when the unit carries a raid marker and a name was found.
1.12's %t already resolves the name the same way, so the hook only
writes the marker in front of the %t pair and the engine still fills
in the name.
Rename Chat::FocusToken to Chat::ChatTokens; %f and %t share the name
lookup and the marker helper.
|
||
|
|
1aa5a07823 |
feat(tooltip): add GameTooltip:SetFrameStack, as 4.3.4 does
Mirror 4.3.4's CGTooltip::SetFrameStack: walk the engine frame list,
hit-test the layout rect against the cursor, name each frame the way
4.3.4 does, sort by strata and level, and fire the new
OnTooltipSetFrameStack script before Show. Every input already exists
in 1.12; the new offsets are verified against the binary.
GetMouseFoci now replays the engine's mouse-focus pass instead of
calling Lua getters: it walks the per-strata mouse input queues and
calls the engine's hit test, so hit-rect insets and scroll clipping
apply as they do for GetMouseFocus.
Also fix the FUN_REGION_GET_RECT comment: the rect is
{bottom, left, top, right}, not {top, left, bottom, right}.
|
||
|
|
00f32e0e2f |
feat(xml): load <Attributes> on frames, as 4.3.4 does
4.3.4's CSimpleFrame::LoadXML reads an <Attributes> child through LoadXML_Attributes; 1.12's frame loader (FUN_XML_FRAME_LOAD) walks its child elements and silently skips the unknown one, so ported templates lost every attribute. Each <Attribute name= type= value=> is now set the way 4.3.4 sets it: type nil/boolean/number/string (default), converted with the loader's own helpers (FUN_XML_ATTR_TO_BOOL, new FUN_SSTR_TO_FLOAT), stored without firing OnAttributeChanged (through our SetAttributeNoHandler, so unit/type* behave as when set from Lua), and malformed entries logged through the loader's status sink with 4.3.4's warning texts (VTBL_XML_STATUS_ADD, level 1). FUN_XML_FRAME_LOAD was already hooked by Xml::ParentKey, and MinHook takes one hook per address, so Xml::FrameLoad now owns it and fans out after the engine loads each node (the RunnerHook / WorldTick pattern). ParentKey's frame binds and the attribute loader subscribe; its node helpers and loader-safe wrapper push moved there too. OFF_COBJECT_LUA_REGISTRY_REF duplicated OFF_COBJECT_LUA_REF (both 0x08) and is folded into it. Verified in-game with a test addon: template attributes inherited and overridden by the frame's own, number / boolean / nil types, a mixed- case name, values present by OnLoad, no OnAttributeChanged on load, and the three FrameXML.log warnings. |
||
|
|
5537432662 |
docs(frame): describe 4.3.4's attribute and mouseover behavior
OnAttributeChanged takes (self, name, value) and nested changes fire their handlers; mouseover follows SecureButton_GetModifiedUnit; the 3-arg GetAttribute and SetAttribute's required value. Drops the implementation paragraphs. |
||
|
|
f5acea6060 |
fix(coroutine): follow 4.3.4's coroutine library
Compared against 4.3.4's stock Lua 5.1 co_funcs (lbaselib.c), opened by
luaopen_base in FrameScript_Initialize:
- status: a coroutine mid-resume of another one is "normal", not
"suspended". Test what the engine's own resume body (0x006F67B0)
tests - ci > base_ci AND CI_YIELD on the CallInfo - instead of
ci > base_ci alone. Resuming it now fails with 5.1's "cannot resume
normal coroutine".
- running: push the thread with the exec-context field set, as every
engine push does; it was left as whatever the stack slot held, which
lua_pushvalue copies into the script context. The main thread is read
from G->mainthread (+0x50, set by f_luaopen) instead of an L captured
at registration.
- Registered on the glue state too.
- 5.1's error texts ("cannot resume %s coroutine"); too many arguments
or results raise, and the results check reserves the slot for true.
- wrap re-raises a non-string error object unchanged through the raw
lua_error (LUA_RAW_ERROR, 0x6F4440); a string still gets luaL_where.
Verified in-game: "normal" status and its resume error, the lifecycle
and running(), an error in the body is not read as a yield, and the
wrap error text.
|
||
|
|
a86f1219c3 |
fix(frame): follow 4.3.4's HookScript, so a hooked handler keeps its args
HookScript's HookThunk was a C closure, which Frame::ScriptArgs treats as
wanting no positional args, and it called the old handler with none - so
a modern SetScript("OnShow", function(self) ... end) saw self == nil as
soon as anything hooked it. It also padded the hook to 9 args and only
detected OnEvent by exact case.
Follow 4.3.4's FrameScript_Object::HookScript instead:
- an unset script gets the hook itself, so GetScript returns it;
- a set one gets the same wrapper hooksecurefunc installs (4.3.4 uses
FrameScript_HookWrapper for both), exposed via HookSecureFunc.h: the
old handler and the hook get the script's own args, and a hook error
goes through the engine's script error handler.
ScriptArgs' HandlerWantsArgs looks inside that wrapper (C function
compare, upvalues at CClosure +0x10 per lua_pushcclosure), so a hooked
script takes the positional path only when either side declares
parameters. The usage error names the frame as the engine does:
vtable+4 GetName, else its "<unnamed>".
Verified in-game: old and hook both get self; OnEvent gets (self, event)
with no padding; an unset script stores the hook; a three-deep chain;
a hook error is reported after the old handler ran; both error texts.
|
||
|
|
338c6777d6 |
feat(hooksecurefunc): follow 4.3.4's hooksecurefunc
Compared against 4.3.4's Script_hooksecurefunc / FrameScript_HookWrapper (taint bookkeeping aside, which 1.12 has no counterpart for): - The hook runs under lua_pcall with the engine's frame-script message handler as errfunc, so a broken hook is reported like any script error instead of being dropped silently. The original's results still reach the caller. - The wrapper is installed with lua_rawset, so a target's __newindex never runs. The original is still read with lua_gettable, so an inherited method can be hooked. - Registered on the glue state too: 4.3.4 registers it from FrameScript_Initialize, which runs for both states. - 4.3.4's error texts, and its lua_isstring name check, so a number name works. - _G is pushed and inserted at index 1, so both call forms share one layout. The comment saying pushvalue(GLOBALS_INDEX) crashes was written in the commit that fixed LUA_PUSH_VALUE (it pointed at lua_remove); the engine's lua_pushvalue resolves the pseudo-index. The 11.0 unhookable-name list stays. lua_rawgeti moves into Game::Lua now that ScriptArgs is not its only caller. Verified in-game: a hook error is reported and T(3) still returns 3 6; __newindex does not run and an __index method hooks; a number name hooks; all three error texts. |
||
|
|
aeb3bdf07b |
feat(playercache): resolve GetPlayerInfoByName through the engine's name search
C_PlayerCache.GetPlayerInfoByName read only the persistent NameCache, so it returned nothing for every name while that cache was off, even for a player standing next to you. It now resolves the name to a GUID first (Player::Info::GuidFromName): the engine's own by-name search behind TargetByName (party and raid members, including out-of-range ones, then every visible player), then the friends list, then the persistent cache. The result is built from that GUID by the same code as GetPlayerInfoByGUID. The engine search is wrapped once as Unit::Identity::FindGuidByName, which UnitTokenFromName now uses too. |
||
|
|
1caf9fde18 |
feat(luasyntax): give strings 4.3.4's shared metatable
4.3.4 ships stock Lua 5.1, whose createmetatable gives every string one
metatable { __index = string } in G(L)->mt[LUA_TSTRING]. 1.12 differs in
one line of each reader: lua_getmetatable returns 0 for a non-table, and
luaT_gettmbyobj returns nil. Co-hook both so a string reads a per-state
metatable instead, and drop the index-continuation hook that answered
with the string table directly.
getmetatable("") now returns the metatable, so libraries that extend it
(StatLogic: getmetatable("").__index.trim = trim) work, and a replaced
or function __index resolves through the engine's own code. A method
lookup costs what 4.3.4's does: luaH_getstr for "__index", then the
lookup in string.
Verified in-game: getmetatable("").__index == string, methods, nil on a
missing key, extending __index, a function __index, the write / call /
arithmetic errors, tostring, and the kill switch.
|
||
|
|
d496ff2aa7 |
feat(string): string.trim and string.join, as later clients expose them (#94)
* feat(string): string.trim and string.join, as later clients expose them
Later clients put strtrim / strjoin on the string table too (string.split
was already registered), so (" x "):trim() works and libraries capture
them at file scope - AceConfigCmd-3.0 does strtrim = string.trim and then
calls it for every toggle/slash command ("attempt to call a nil value").
Not verified in-game yet: these register the existing strtrim / strjoin
functions a second time, under the string table. The testkit check for
them (string methods, the chars argument, the globals agreeing) runs at
the next login, and I'll add the result here.
* docs(string): document string.split and cite 4.3.4's compat.lua
string.split was registered but undocumented. 4.3.4's compat.lua aliases
all three str* globals onto the string table (str.trim / str.split /
str.join), so name it as the source and list the three the same way.
strsplit takes the separator first, so its method form is called on the
separator.
* fix(string): bind the str* globals to their string-table functions
Each Register* call mints its own closure, so registering one C function
as both strtrim and string.trim gave two values and strtrim ~= string.trim.
4.3.4's compat.lua binds each pair by assignment (gsub = str.gsub, strrev
= str.reverse, str.trim = strtrim, str.split = strsplit, str.join =
strjoin), so the globals now alias the string-table entries by value via
RegisterGlobalAlias, as tinsert already does. Verified in-game:
strtrim == string.trim and ClassicAPI.strtrim == strtrim.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
9d3bdfb6ad |
feat(focus): follow 4.3.4's focus, and give every unit event to focus, nameplates and marks
Every unit event the engine fires now reaches focus, nameplateN and
markN, as 4.3.4 does for its focus: the unit gets a script-registration
bit, so the engine watches its fields, and whatever the engine fires
for the unit fires for the token too.
- A co-hook on the registration recompute (FUN_0060c520) keeps bit
0x8000 on units with one of these tokens. Post-init runs it too, so a
unit coming back into range is watched again. 0x2000 is SuperWoW's
and WeirdUtils' sparkle bit on every unit.
- nampower replaces the broadcast (0x00515E50) and the combat feedback
(0x00494600) with detours that never call the original, so neither
can be co-hooked. Their 38 + 4 CALL/JMP sites, which no loaded DLL
touches, are redirected to functions that call the original address
and then fire for the unit's tokens. Sites are found by a .text scan
and patched only when the counts match Ghidra's xrefs.
- The tokens gain UNIT_COMBAT, UNIT_NAME_UPDATE, UNIT_PORTRAIT_UPDATE,
UNIT_MODEL_CHANGED, UNIT_CLASSIFICATION_CHANGED and group-stat
updates. TokenObserver now serves only focustarget: with SuperWoW
every unit is engine-watched, so an observer would double-fire.
Focus drop rules follow 4.3.4 where 1.12 has the data: out of range is
kept for you, your pet, a party or raid member or their pet (the
engine's own target rule); death while not friendly, or arrival already
dead and not friendly; becoming not selectable. Death and the flag act
on the change. 1.12 has no duel exception and no SMSG_BREAK_TARGET.
%f in sent chat (4.3.4's ChatParserParseText) becomes the focus's name,
with a {rtN} prefix when marked, or FOCUS_TOKEN_NOT_FOUND.
The .text bounds move into Offsets.h (shared with interface/Export).
The focus still survives /reload; focustarget events stay as a
ClassicAPI extension.
|
||
|
|
42d037f080 |
fix(text): lay out inline-icon lines the way 4.3.4 does
Chat lines with icons ran past the frame edge after
|
||
|
|
af4a379311 |
feat(equipmentset): follow 4.3.4's equipment manager
UseEquipmentSet now behaves like 4.3.4's CGEquipmentManager: - in combat only the weapon slots swap (one COMBAT_SWAP message); - missing items and full bags report through UI_ERROR_MESSAGE; - bank items are used only while the bank is open, and then equip straight from the bank; - a swap in flight or an item on the cursor refuses the call. EQUIPMENT_SWAP_FINISHED now fires when the swap settles instead of during the call: success when the paperdoll matches, failure on an SMSG_INVENTORY_CHANGE_FAILURE for one of the moved items, or when the paperdoll stops changing short of the target. Its failure value is nil, not 0. CanUseEquipmentSets and the set buttons are blocked meanwhile. GetEquipmentSetInfo uses 4.3.4's GetSetStatus counts and strict IsSetEquipped; GetItemIDs and GetItemLocations return all 19 slots with the 0/1/-1 markers; set buttons also grey when a replaced item is locked. Set names go through a port of ScrubString. Item tooltips get the "Equipment Sets:" line (dontShowEquipmentSetsOnItems hides it). |
||
|
|
2b9d0e7127 |
fix(player): fire HEARTHSTONE_BOUND on SMSG_PLAYERBOUND
The server re-sends SMSG_BINDPOINTUPDATE at login and on every map change, which needed two gates to filter out. SMSG_PLAYERBOUND (0x158) is sent only from the bind spell effect, right after the bind-point update, so it needs no filtering. 1.12 handles it in the shared player packet handler FUN_005E38C0. Subscribe through Net::PacketDispatch instead of hooking the bind-point handler, which drops one MinHook and the two unused offsets. |
||
|
|
a68fb0a6be |
fix(frame): keep a scroll child clipped when its ScrollFrame moves (#60)
* fix(frame): keep a scroll child clipped when its ScrollFrame moves A frame a ScrollFrame draws carries a "scrolled" flag (0x2000 at +0xB4): the strata pass skips it and the ScrollFrame draws it inside a viewport cut to its rect. SetScrollChild sets the flag through the setter at 0x0076A400, which also marks the scroll child (0x4000) and recurses into child frames. SetParent sets a moved frame's flag from its new parent through the same setter, and the recursion doesn't stop at a ScrollFrame, so moving a frame that holds a ScrollFrame under an unscrolled parent cleared the flag on the scroll child and everything in it. The strata pass then drew them whole, past the ScrollFrame's edges. AceGUI-3.0 builds each widget under UIParent and then moves it into its container, so every AceGUI ScrollFrame spilled: AceConfigDialog-3.0's pages drew below the Interface Options window (61 frames under Zygor Guides Viewer 2.0's "Display" scroll child had lost the flag). Hook the setter to keep a frame marked as a scroll child scrolled when a value is only being passed down (third argument -1). SetScrollChild's own calls are unchanged. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): AceConfigDialog-3.0's Interface Options pages clip and scroll inside their box; on the "Display" page no frame under the scroll child lacks the flag any more (61 did before), and a ScrollFrame built under UIParent and then moved keeps its content, its content's children and a child added afterwards scrolled. * docs(frame): describe ScrollFrame clipping without version history State what stays clipped and when, with AceGUI-3.0 as the case it serves. Remove the vanilla comparison and the engine flag explanation; the comment in src/frame/ScrollChildren.cpp already records them. * fix(frame): skip scroll children the way 3.3.5's setter does 3.3.5's CSimpleFrame::SetBeingScrolled (0x00490F60) does not pass the scrolled value into a child frame marked as the scroll child, and its direct call is not gated: a scroll child that is itself given a new parent takes the new parent's value. The hook forced any scroll child scrolled on a pass-down call, which also kept a directly reparented scroll child clipped to its old ScrollFrame. Skip a scroll child only inside the setter's own recursion, told apart by a depth counter (the setter is its only nested caller). SetParent's and SetScrollChild's direct calls run unchanged. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
721f32ac77 |
feat(map): keep the closed world map on the player's zone (#71)
* feat(map): keep the closed world map on the player's zone
GetPlayerMapPosition("player") reads the map the world map is set to,
open or closed, and returns 0,0 off it. The 3.x FrameXML resets that
map to the player's zone in WorldMapFrame_OnHide and in WatchFrame's
PLAYER_ENTERING_WORLD and (map closed) ZONE_CHANGED_NEW_AREA handlers;
vanilla has neither, so after zoning the closed map stays on the old
zone. Do the same resets from the bundled addon. Zygor Guides Viewer's
travel steps read the player's position this way.
Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0):
after logging in, the closed world map is on the player's zone (Darkshore)
and GetPlayerMapPosition("player") returns the player's position there.
Not checked yet: changing zones with the map closed (the
ZONE_CHANGED_NEW_AREA reset) and closing the map on another zone (the
OnHide reset).
* docs(map): describe the closed world map without version history
State what the map does and when it goes back to the player's zone,
and add that a zone change does not move the map while it is open.
Remove the 3.x and vanilla comparison and the FrameXML handler names;
the code comment in Util/WorldMap.lua already records them.
* docs(readme): keep Highlights for major features
Single-behavior fixes (faction while loading, <Script file> paths, the
closed world map, the quest completed line, SetParent frame levels,
frame alpha, OnSizeChanged sizes) each had a row in the Modern client
behaviors table. Remove those rows and point to docs/API.md, where each
fix keeps its own section.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
6be4aac9fb |
feat(macro): resolve every macro's display the way 3.3.5 does
Compared Macro::ShowTooltip against 3.3.5's decompiled MACRONODE::Parse, FindSpellID and GetFullIconPath (WoW/Source/Ui/UIMacros.cpp) and fixed the differences: - Every macro body is parsed, directive or not. A question-mark macro with no #show now shows its first action's icon, and its button follows that action's cooldown, count and usable state; the tooltip stays the engine's (Kind::Implicit). #show counts anywhere in the body, not only on line 1. - "#showtooltip none" stops the parse: the macro keeps its own icon and holds no spell, instead of greying out. - /castrandom and /userandom show their first entry (3.3.5 cuts the value at the first comma); they used to grey the button. - /equip and /equipslot lines are collected and resolve to items only. - Bare numbers 1..23 are inventory slots, the equipped bags included. Edits now always end in a repaint, as 3.3.5's EditMacro does: the engine repaints a macro's buttons straight after its parse, before our rescan, so a re-parsed body is marked and repainted on the next tick, and a reader's catch-up defers its repaint instead of firing ACTIONBAR_SLOT_CHANGED from inside a button handler. Implicit macros are also parked across the unlearn sweep, so a condition-picked value can't delete a macro from the bar. |
||
|
|
47b258ad95 |
fix(text): size, space and align inline icons by the engine's own rules
The inline-texture backport placed icons with hand-tuned constants: a 0.18 x font lead/trail pad, a 0.6 x font vertical centre, a -1px region nudge, and written sizes taken as raw screen pixels. Replace all of them with the rules from the 3.3.5 / 4.3.4 clients (decompiled; the size formula's helpers confirmed against the real 4.3.4 binary): - A written size multiplies by fontPx / (14 x ddcWidthScale), so it follows the text's size, the UI scale and the resolution, and then by the fontstring's layout scale, as 3.3.5 does. Size defaults follow ParseEmbeddedTexture: ":0:2" is a width ratio, ":20:0" is font-wide. - An icon starts at the previous glyph's ink edge (bearing + cell width) plus the face's outline gap, found by replaying the run's placements with the emitter's own glyph helpers; the next glyph starts at the rounded icon edge. - Vertical alignment follows the node's justify-V (node+0x50). - Offsets move only the drawn icon; a positive offsetY now moves it up. GetCoinTextureString now matches 3.3.5: default height 14, a space between denominations, and retail's 2:0 coin offset in the strings. The four Coordinate statics at 0x00832A40 get their real names (VAR_COORD_DDC_WIDTH_SCALE and siblings). Known gap: the fs-level wrap callers can't see the fontstring, so they budget icons at layout scale 1. |
||
|
|
2a05baee8d |
feat(cvar): GetCVar returns nil for an unknown cvar (#82)
* feat(cvar): GetCVar returns nil for an unknown cvar
Later clients return nil from GetCVar for a name they do not know; vanilla
raises "Couldn't find CVar named '<name>'". Ported code uses the nil as
a feature probe - LibCamera-1.0 opens with
if not GetCVar("cameraYawE") then return end, which throws at file load
on vanilla.
Co-hook Script_GetCVar: a string name that FUN_FIND_CVAR (the lookup
Script_GetCVar and C_CVar.DoesCVarExist share) does not find yields nil.
Everything else, including non-string arguments, runs the engine function
unchanged. The glue state registers the same function, so both match.
Verified in-game (1.12.1 client via VanillaFixes): GetCVar with an unknown
name returns nil at file load, without an error.
* feat(cvar): GetCVarDefault stops raising for an unknown cvar
Script_GetCVarDefault has the same isstring -> tostring -> FUN_FIND_CVAR
-> raise shape as Script_GetCVar, so it gets the same co-hook. Both now
return no values for an unknown name, matching 1.15.9 (`/dump` prints
"empty result" for each) instead of a single nil.
Docs: describe behavior only, without version or vanilla-gap notes.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
80ef0e2988 |
feat(lua): give modern XML handler bodies their implicit parameters (#84)
* feat(lua): give modern XML handler bodies their implicit parameters
Later clients compile an XML handler body as a function whose parameters
name the script's arguments - self, then elapsed / button, down /
event, ... and so on. Vanilla compiles it as a zero-parameter chunk and
publishes the frame and arguments only through the this / argN globals,
so a ported <OnLoad>self:Foo()</OnLoad> indexes a nil global.
Zygor Guides Viewer 2.0 has 85 such bodies; 13 fail at load.
For a chunk compiled by the XML script funnel FUN_00704C70 (return
address 0x00704C8C, engine-built chunkname "<Frame>:<Script>") whose body
reads self - or reads one of its script's parameter names and none of
this / argN - wrap it as return function(self, <names>, ...) ... end,
reusing the vararg path's materialize-the-inner-function shape.
Frame::ScriptArgs already pushes (self, arg1..argN) in that order. Vanilla
bodies are untouched, so FrameXML and 1.12 addons keep their globals and
no names are shadowed.
`event` alone doesn't trigger the wrap. Vanilla sets a global `event`
during OnEvent dispatch, so FrameXML's own
<OnEvent>ActionButton_OnEvent(event)</OnEvent> bodies (about 250) already
work; a body that also reads self still gets (self, event, ...), which
binds the same value.
Adds RET_LUA_SCRIPT_COMPILE (found by scanning FUN_00704C70 for the E8
call to luaL_loadbuffer; the same scan reproduces RET_LUA_FILE_COMPILE),
an XmlHandlerArgs transpile toggle, and a 6th _classicapi_TranspileStats
return counting wrapped handlers.
Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0):
probe XML bodies see self in OnLoad, elapsed in OnUpdate, button in
OnClick ("LeftButton") and event in OnEvent; Zygor's bodies load without
an error, and 112 of the 36,627 chunks compiled that session were wrapped.
* fix(lua): match 3.3.5's handler parameters; treat ... as a modern body
OnSizeChanged binds (self, w, h), as 3.3.5's wrapper does, not
(self, width, height); the table now names its 3.3.5 source.
A handler body with a ... expression is wrapped with its named
parameters. Lua 5.0 can't compile one, so only a body written for later
clients has it, and the plain vararg wrap gave an OnEvent body's ...
(self, event, args) instead of the arguments after event.
The docs list each script's names and drop the version history, and say
the values need SetModernScriptArgs on.
* fix(frame): pass OnSizeChanged the size in GetWidth/GetHeight units
FUN_FRAME_ON_SIZE_CHANGED (0x0076B660), the only code that fires
OnSizeChanged, pushed the frame's screen-rect size in raw layout units:
a 20 x 10 frame's handler saw (0.0092, 0.0046). 3.3.5 divides out the
frame's layout scale (OnFrameSizeChanged, 0x0048FA20) and converts with
the chain 1.12's own GetWidth uses (Game::InternalToPixel) before the
script runs.
A co-hook now does both: convert, then divide by the frame's effective
scale (OFF_REGION_EFFECTIVE_SCALE). Verified in game at a 0.91 UI
scale: (19.99993, 9.99997) against GetWidth/GetHeight's (20, 10).
Converting alone gave (18.2, 9.1). The vmethod uses the values for
nothing else, and neither stock FrameXML nor any installed addon reads
OnSizeChanged's arguments.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
5df5ce00cf |
fix(xml): resolve <Script file> subdirectory paths relative to the XML file (#80)
* fix(xml): resolve <Script file> subdirectory paths relative to the XML file The XML file processor joins <Include file> onto the including file's directory, but <Script file> only when the value has no backslash (strchr at 0x006EE06E); a value with one is loaded from the game root. So <Script file="widgets\AceGUIWidget-Button.lua"/> inside Libs\AceGUI-3.0\AceGUI-3.0.xml fails with "Error loading widgets\AceGUIWidget-Button.lua" - all 23 AceGUI-3.0 widget files in Zygor Guides Viewer 2.0, and every other addon that embeds AceGUI-3.0. Later clients resolve it relative to the XML file. Co-hook the XML file processor (FUN_XML_LOAD_FILE) to track the file being processed, and at the <Script> call into FUN_LUA_LOAD_FILE (return address RET_XML_SCRIPT_FILE_LOAD) retry a backslash path that does not exist as given against that file's directory, only when the joined file exists. Root-relative paths that load on vanilla are unchanged. FUN_LUA_LOAD_FILE is already co-hooked by AddOns::SavedVarsFirst, which now calls Xml::ScriptPath::Resolve first. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): a probe addon's <Script file="sub\File.lua"/> loads from its XML file's folder, and Zygor's AceGUI-3.0 option pages, built from those widget files, work. * refactor(xml): share the Lua file-loader hook; collapse .. in Script paths FUN_LUA_LOAD_FILE now has one owner, Script::LoadFile, which runs path rewriters and then suppressors. Xml::ScriptPath is a rewriter and AddOns::SavedVarsFirst a suppressor, so neither module reaches into the other's hook. Xml::ScriptPath joins onto the XML file's folder with each \..\ collapsed first, as FUN_XML_LOAD_FILE does before its own joins; the tracked pointer is the caller's uncollapsed path, so an XML file reached through <Include file="..\x.xml"/> joined onto a path with .. in it. The user docs no longer name later clients or what 1.12 does. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
1297b9522a |
feat(macro): accept a macro name in GetMacroInfo/EditMacro/PickupMacro/DeleteMacro (#96)
* feat(macro): accept a macro name in GetMacroInfo/EditMacro/PickupMacro/DeleteMacro
2.0+ clients take `index or "name"` in all four; vanilla raises
"Usage: DeleteMacro(index)" (etc.) for a name. Co-hook each script
function: a non-numeric string first argument becomes the macro's
1-based index via FUN_MACRO_NAME_TO_SLOT (the GetMacroIndexByName
resolver), and an unknown name becomes 0, which each original treats
like any out-of-range index (GetMacroInfo returns nils, the others do
nothing). Zygor Guides Viewer clears its scratch macros with
DeleteMacro("ZygorGuidesMacro" .. i) every time a step starts.
Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0):
an unknown name is a no-op in all four, and Zygor's DeleteMacro calls on
every step start run without an error. The known-name path hasn't run
in-game yet: the test character has no macros.
* docs(macro): say what EditMacro returns for an unknown macro name
An unknown name leaves EditMacro returning the first empty slot's index
(or 0 when every slot is full), the same as an out-of-range index and as
3.3.5; the section said all three non-GetMacroInfo functions "do
nothing". Also drop the patch-version mention.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
b3188ced2a |
feat(tradeskill): add GetTradeSkillRecipeLink and IsTradeSkillLinked (#75)
* feat(tradeskill): add GetTradeSkillRecipeLink and IsTradeSkillLinked GetTradeSkillRecipeLink(index) links the recipe in a trade-skill row as an enchant: link carrying the recipe's spell ID, in the form the client's own GetCraftItemLink (0x004F72A0) gives an enchanting formula (|cffffffff|Henchant:%d|h[%s]|h|r, format at 0x0084D410), with the spell's name in the client's locale. Rows are read as the engine's row functions read them, so a header row (spell ID -1) returns nothing. Vanilla's window only links the item a recipe makes. IsTradeSkillLinked() returns nil: on this client the trade-skill window and its functions only describe the player's own professions, since a received trade: link opens ClassicAPI's separate viewer. Zygor Guides Viewer 2.0 calls both on TRADE_SKILL_SHOW to record the recipes the player knows. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): in the First Aid and Cooking windows, all 15 recipe rows link the row's own spell (checked against GetSpellInfo) and header rows return nothing; IsTradeSkillLinked() returns nil. * fix(tradeskill): match 3.3.5's GetTradeSkillRecipeLink and show its links GetTradeSkillRecipeLink now builds 3.3.5's link: gold, "Profession: Recipe" (the profession from the engine's SkillLineAbility lookup FUN_006de040, for the player's race and class), gated on SPELL_ATTR_TRADESPELL. Empty names are pushed as the record holds them, and the index is checked as a double before the cast, the way the engine truncates and compares unsigned. IsTradeSkillLinked returns (nil, nil), as 3.3.5 does. Both globals get doc descriptors. 1.12's SetHyperlink accepts enchant: only for records with +0x0C == 3, which no trade-skill recipe has, and raises "Unknown link type" for the rest. Tooltip::Hyperlink now shows the spell tooltip for a trade-spell enchant: link, as 3.3.5 does. That also fixes clicking SuperWoW's GetTradeSkillItemLink(index, 1) links; its SetHyperlink patch at 0x00532210 runs after this co-hook and handles only quest:. SPELL_ATTR_TRADESPELL moves to Offsets.h now that two files use it. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
f55893fdf4 |
feat(frame): Button:Set/GetNormalFontObject and Frame:IsProtected (#93)
* feat(frame): Button:Set/GetNormalFontObject and Frame:IsProtected - button:SetNormalFontObject / GetNormalFontObject: 3.0's names for vanilla's SetTextFontObject / GetTextFontObject; delegate to them. Zygor Guides Viewer 2.0 and AceGUI-3.0 call the new names. - frame:IsProtected() returns false, false: vanilla has no protected frames (the secure system arrived in 2.0). AceHook-3.0 asks before hooking scripts. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): Zygor sets its guide window's tab fonts with SetNormalFontObject while it builds, without an error. Not yet checked: that the font set reads back through GetTextFontObject and the reverse, and IsProtected's two values; the testkit check for those runs at the next login. * docs(frame): drop version and implementation notes from the new methods The SetNormalFontObject and IsProtected sections named the patches the APIs came from, said what 1.12 lacks, and described how the methods are implemented. User docs describe the contract only. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
e0b2e56070 |
feat(frame): multiply frame alpha into child frames, as 3.x does (#70)
* feat(frame): multiply frame alpha into child frames, as 3.x does A frame now draws at its own alpha times its parent's drawn alpha, and GetAlpha returns the frame's own alpha. Vanilla keeps one alpha per frame and copies it into the children that exist when SetAlpha runs: - an XML frame with alpha="0" drew its child frames at full alpha, because the attribute is applied before its <Frames> are built; - a child's own alpha was overwritten whenever its parent's changed; - a frame created or reparented under a transparent frame drew opaque. Zygor Guides Viewer's border glow is the first case. It is an alpha="0.0" frame whose child holds the glow textures, so on vanilla the glow covered the guide frame from login until the first step flash. Co-hooks the engine's alpha setter, SetParent, the frame destructor and frame GetAlpha. Own alpha lives in a table keyed by frame. The engine's byte holds the drawn value, so region recolors and the Model family's model alpha read it unchanged. Children are recomputed through their own vtable setter, as the engine's copy-down calls it. Vanilla code that shows a child under a transparent parent (parent:SetAlpha(0); child:SetAlpha(1)) now leaves the child hidden, as 3.x does. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): Zygor's guide frame no longer shows its border glow from login. With own alphas 0.5 / 0.8 / 1.0, a child and a grandchild draw at 0.4; the child of an XML frame with alpha="0" keeps its own 1.0 and draws at 0; a child keeps its own 0.5 while its parent goes to 0.2 and back to 1; a frame with its own 0.6 draws at 0.3 under a 0.5 parent and at 0.18 once moved under a 0.3 one. * fix(frame): match 3.3.5's effective-alpha math and read it from the byte - Multiply child alpha by truncating (a*b/255), as 3.3.5's CSimpleFrame::UpdateAlpha and GetEffectiveAlpha do, instead of rounding. - GetEffectiveAlpha reads the frame's alpha byte, which Frame::Alpha keeps at the drawn value, instead of multiplying GetAlpha up the parent chain. This is 3.3.5's Script_GetEffectiveAlpha. Drops the now-unused FUN_SCRIPT_REGION_GETPARENT. - Drop the reload cleanup of the own-alpha table. The frame destructor hook already removes each frame's entry, and a frame that outlives a /reload would have lost its own alpha. - Rewrite the API.md frame-alpha and GetEffectiveAlpha sections as user-facing behavior. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
20dc9fc962 |
fix(frame): move a frame's children along when SetParent sets its level (#61)
* fix(frame): move a frame's children along when SetParent sets its level Vanilla's SetParent gives the frame its new parent's strata and level + 1, but calls the level setter without its children flag, so the frames under it keep the levels they had. A panel built on its own and then moved into a raised window draws its contents behind that window: Zygor Guides Viewer 2.0's AceConfigDialog-3.0 panel in the Interface Options window had its widgets at levels 1-4 under a window at level 5. Hook the level setter (0x0076A4F0) and pass the children flag on SetParent's two calls, recognized by their return addresses. The setter then moves each same-strata child by the same amount, recursively. Script SetFrameLevel and the setter's other callers are unchanged. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): the AceConfigDialog-3.0 panel's widgets draw above the Interface Options window, and none of its 18 frames sit below the window's container any more. A frame with a child and a grandchild moved under a level-20 frame sits at 21/22/23, and at 0/1/2 once moved to no parent. * refactor(frame): patch SetParent's children flag instead of hooking the setter The two `push 0` that pass the level setter's children flag from SetParent become `push 1`, which is what 3.3.5's SetParent passes. This drops the MinHook on the level setter, which 11 call sites share, and the return-address checks. Each site's bytes are checked before the write, as in Quest::CompleteMessage. Docs: describe only the current behavior in API.md and the README row. Verified in-game: a frame with a child and a grandchild moved under a level-20 frame sits at 21/22/23, and at 0/1/2 once moved to no parent. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
51d226f67d |
feat(tooltip): SetHyperlink takes full links and spell:/quest: links (#68)
* feat(tooltip): SetHyperlink takes full links and spell:/quest: links
Vanilla's GameTooltip:SetHyperlink matches only a bare `item:` or
`enchant:` payload and raises "Unknown link type" for anything else,
including the full |cff..|H..|h[..]|h|r links 2.0+ GetItemInfo and chat
hand out. Co-hook it:
- a full link is reduced to the payload between |H and |h;
- spell:<id> builds the SetSpellByID tooltip;
- quest:<id> shows the cached title and objectives text (tokens
expanded by the engine's quest-text substituter); an uncached quest
leaves the tooltip empty and queues the quest query once;
- everything else runs the engine function on the payload.
Quest::Cache::Lookup gains `unique`, the engine's own dedup flag (the
last _GetRecord argument, previously passed as an unused 0), so a
tooltip redrawn every frame waits on one queued callback.
Zygor Guides Viewer reads quest titles with
SetHyperlink("|Hquest:<id>:1|h[q]|h") and item names with full links.
Verified in-game (1.12.1 client via VanillaFixes): on a
GameTooltipTemplate tooltip, a full Hearthstone link shows Hearthstone's
tooltip, "spell:133" shows Fireball's, and "quest:957" shows Bashal'Aran's
title and objectives.
* refactor(tooltip): share the C tooltip line helpers; tidy SetHyperlink
- Add tooltip/Lines.h (Clear / Add / Show over the engine's tooltip clear,
raw add-line and Script_Show) and use it in place of the four local
copies in Hyperlink, CompareItem, totem/Tracker and equipmentset/Tooltip.
EquipmentSet keeps its exact colors as packed constants.
- SetHyperlink quest colors come from UI::ColorData (HIGHLIGHT_FONT_COLOR,
NORMAL_FONT_COLOR) instead of hand-packed doubles.
- spell:<bad id> now clears the tooltip, like quest:<bad id>, instead of
leaving the previous tooltip's lines.
- Rewrite the SetHyperlink API.md section in plain English without version
or vanilla-gap notes.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
eb3c32094c |
feat(pvp): add IsActiveBattlefieldArena (#77)
* feat(pvp): add IsActiveBattlefieldArena Stock 1.12 has no arenas, so it answers nil there. Turtle-lineage clients add arena matches, run in instances IsInInstance reports as "pvp": in a "pvp" instance their scoreboard asks for arena scores over the hidden TW_ARENA channel, only an arena answers, and the scoreboard keeps the reply in WorldStateScoreFrame.arenaData until the world states update outside an instance. isArena follows that state, as the scoreboard's own arena view does (Octo's FrameXML, patch-4.mpq: WorldStateFrame.lua and Turtle_ArenaUI.lua). isRegistered is always nil: the reply has no rated flag, and the client's queue window only joins skirmishes. Zygor Guides Viewer 2.0 calls it, unguarded, to decide whether to set its corpse arrow when the player is dead outside a battleground. Verified in-game (OctoWoW 1.12.1 client via VanillaFixes): outside an instance it returns nil, nil. The arena branch has not been exercised in a match yet. * refactor(pvp): answer IsActiveBattlefieldArena from DBC data in C The Lua version read Turtle's scoreboard state (WorldStateScoreFrame.arenaData), which is nil until the server's TW_ARENA reply lands and depends on Turtle's FrameXML. The client's own data already marks an arena: a pvp-type map (Map.dbc instanceType 3) whose area carries AreaTable flag 0x80, the flag Script_GetZonePVPInfo reports as isArena. Check the zone as well as the subzone, since the arena maps' areas are top-level zones. The type-3 gate keeps the open-world rings (Gurubashi, The Maul) out. Returns booleans, as retail does; isRegistered is always false. Offsets.h: add OFF_AREATABLE_FLAGS, AREA_FLAG_ARENA and VAR_PLAYER_SUBZONE_AREA_ID, and correct the zone-change handler's second argument (the subzone ID, not the parent area ID). * docs(pvp): note the server only ever creates arena map 26 tortoise-wow's GetBattleGrounMapIdByTypeId sends its one arena type, BATTLEGROUND_BR, to map 26 (Blood Ring); map 28 (Lordaeron Arena) is client data only. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
26ca1b4e84 |
feat(quest): print "<quest> completed." for chain quests too (#76)
* feat(quest): print "<quest> completed." for chain quests too The client prints ERR_QUEST_COMPLETE_S on SMSG_QUESTGIVER_QUEST_COMPLETE only for a quest with no next quest in its chain. The handler (and the callback it leaves for a quest not yet cached) skips the message when the cached record's NextQuestInChain (+0x24) is set, so a turn-in in the middle of a chain printed only the experience and money lines. Zygor Guides Viewer 2.0 completes a turn-in step only on that line, so its steps for chain quests stayed open until the next login. NOP the two `jne` over the message (0x005DC4DC, 0x005DC756), after checking the bytes, so every turn-in goes through the engine's own message path: same text, sound and CHAT_MSG_SYSTEM chat type, ahead of the experience and money lines. That later clients print the line for every turn-in is an inference, not read from a later client's binary: the 3.3.5a build of Zygor Guides Viewer completes chain turn-ins on this line the same way. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): mid-chain turn-ins (The Harvest Golem Mystery 40470, The Red Crystal 4811, As Water Cascades 4812, Bashal'Aran 956, Buzzbox 323 1002) print "<quest> completed." and Zygor completes the turn-in step at once; a quest at the end of its chain prints it as before. * docs(quest): the completed line's order depends on the quest cache When the quest record is not cached at turn-in, the callback 0x005DC710 prints the line on the record's arrival: after the experience and money lines, and after QUEST_TURNED_IN. Stop promising a fixed order. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
27d8f90f03 |
fix(unit): UnitFactionGroup("player") answers while addons load (#79)
* fix(unit): UnitFactionGroup("player") answers while addons load
Script_UnitFactionGroup resolves "player" through the in-world unit
descriptor, so it returns nil at file scope, ADDON_LOADED and
VARIABLES_LOADED and only answers from PLAYER_LOGIN. UnitName, UnitRace
and UnitClass already answer then, and later clients answer
UnitFactionGroup too, so ported addons read it at file scope. AceDB-3.0
does exactly that to build its "<faction> - <realm>" profile key, and
fails to load on nil ("attempt to concatenate local 'factionKey'").
Co-hook the engine function: when it answers nothing for the "player"
token, fall back to the login-time race byte (VAR_PLAYER_RACE_BYTE) and
the same race -> faction-group chain its player branch uses. That chain
moves out of C_CreatureInfo.GetFactionInfo into a shared
Creature::Info::FactionGroupForRace; GetFactionInfo's behavior is
unchanged. Once the player object exists the engine answers by itself.
Adds FUN_SCRIPT_UNIT_FACTION_GROUP (slot 13 of table 0x00850438).
Measured in-game before the fix (Octo 1.18.1 client, Human):
UnitFactionGroup("player") = nil at file load / ADDON_LOADED /
VARIABLES_LOADED, "Alliance" from PLAYER_LOGIN; UnitName/UnitRace
answer at every stage.
Verified in-game after the fix (same client and character):
UnitFactionGroup("player") is "Alliance" at file load, ADDON_LOADED and
VARIABLES_LOADED, and AceDB-3.0 sets up Zygor Guides Viewer 2.0's saved
settings.
* fix(unit): keep UnitFactionGroup's in-world nil; describe both engine branches
Script_UnitFactionGroup reads the live faction template when the unit's
object is in the world, and only falls back to the name cache's race when
it isn't. The race fallback now runs only under that same condition (no
player object), so an in-world nil (e.g. charmed by a monster) stays nil
instead of turning into the race's faction. Comments and API.md now say
which engine branch the fallback mirrors.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
35ef1228eb |
feat(lua): give each pass of a for loop its own loop variables, as in 5.1 (#66)
* feat(lua): give each pass of a for loop its own loop variables, as in 5.1 Lua 5.0 declares a for loop's variables once for the whole loop (its parser's forbody activates them before entering the loop block), so every function made in the body shares one variable, which is nil once a generic for ends. Lua 5.1 declares them per pass, and 5.1 code relies on it. Zygor Guides Viewer 2.0's recent-guides menu gives each entry `checked = function() return ... guide.full end`; on 1.12 it errored with "attempt to index a nil value" whenever the menu opened. A new transpile pass rewrites such a loop to the 5.1 manual's own equivalent, `for __cf_k, __cf_v in e do local k, v = __cf_k, __cf_v;`, on the same line. It applies only to loops whose body contains a function, and not when the body assigns to a loop variable (5.0 carries that into the next pass and 5.1 doesn't). Chunks whose blocks don't balance are left alone. The trigger scan follows blocks and brackets without allocating. Toggle: "ForLoopScopes". Tested offline on the rewriter's own code: 21 targeted cases, and 1,417 addon and Classic Era FrameXML files (67.7 MB). 184 loops were rewritten, and every rewritten file still compiles under Lua 5.1. The pass adds about 0.03-0.05 s over the whole 67.7 MB. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): the recent-guides menu opens without an error, and functions made in a generic for, a numeric for and a pair of nested loops each return their own pass's values. * refactor(lua): close loop upvalues per pass in the compiler instead of rewriting source Replace the token-scanning source rewrite with a hook on the parser's forbody. Lua 5.0's loop variables are the loop's control registers, and a function made in the body keeps them open until forstat's block ends. Emitting one OP_CLOSE at the end of each pass, before OP_FORLOOP / OP_TFORLOOP, gives each function its own pass's values. The OP_CLOSE is emitted only when a nested function names a loop variable. markupval already records that on forstat's block, so nothing is guessed from tokens. A loop that captures nothing compiles to the engine's exact bytecode. This fixes the gaps in the source rewrite (indexed and dotted targets, `function v()`, nested elseif, long target lists). It adds no locals, so it can't push a function past the 200-local limit, and it adds no scan to every chunk load. Assignment to a loop variable still steers the loop, as stock 5.0 code may rely on. The ForLoopScopes toggle is gone with the rewrite. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
76cc907bd0 |
feat(tooltip): add GameTooltip:AddTexture on the engine's own routine (#67)
* feat(tooltip): add GameTooltip:AddTexture on the engine's own routine
Vanilla has the 3.x tooltip-texture feature built in and unexposed:
GameTooltipTemplate declares <name>Texture1..3, the XML-OnLoad scan
binds them (tooltip+0x34C), FUN_005303D0 lays the next one out on the
last line (sized to the line, text shifted right) and the tooltip clear
undoes it. Nothing in the 1.12 binary calls that routine; expose it as
GameTooltip:AddTexture. The engine's limits stay: three textures per
tooltip, none on the header line. Zygor Guides Viewer adds guide
images to its tooltips this way.
Verified in-game (1.12.1 client via VanillaFixes): on a
GameTooltipTemplate tooltip with two lines,
AddTexture("Interface\\Icons\\INV_Misc_Bag_08") shows <name>Texture1
with that file, and ClearLines hides it again.
* fix(tooltip): repair AddTexture layout around the engine routine
The engine's texture routine was never called before, and its layout has
two defects. The tooltip clear re-anchors the line below a textured line
at (0, 0) instead of the template's 2px gap, so that line sat too close on
every later tooltip from the frame. And every re-anchor replaces the
line's offset, so a second texture on one line, or one on the line right
below a texture, broke the text alignment.
Tooltip::ClearItemGuid becomes Tooltip::Clear: the one clear co-hook now
also restores the gap below each textured line. AddTexture refuses a
texture on or right below a textured line, accepts only strings, and
returns whether it placed the texture. Correct the Offsets.h description
of the routine and keep the user doc to the contract.
---------
Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com>
|
||
|
|
e9e431e014 |
feat(frame): add SetClampRectInsets / GetClampRectInsets (#69)
* feat(frame): add SetClampRectInsets / GetClampRectInsets Later clients let a frame that is clamped to the screen keep a different rect on screen than its own: SetClampRectInsets(left, right, top, bottom) grows or shrinks the rect the clamp uses. Zygor Guides Viewer 2.0 sets them on its frames while building them (a negative top inset lets a frame's top go off screen), and 3.3.5's own FrameXML uses them too. The engine clamps a frame to the screen inside its rect calculation (0x00767A20): it resolves the edges and, for a clamped frame, slides the rect onto the screen. Hook that calculation: for a frame with insets, take the unclamped rect, grow it by the insets (converted from the frame's units to layout units with the inverse of Script GetLeft's scaling), slide that onto the screen with the engine's own steps and order, and move the frame's rect by the same amount. Frames without insets go through the engine's clamp as before. SetClampRectInsets re-lays the frame out, as SetClampedToScreen does, and (0, 0, 0, 0) clears the insets. Sign convention from 3.3.5's own calls: WorldMapFrame (0, 0, 0, -60) "don't overlap the xp/rep bars", chat frames (-35, 35, 26, -50). Verified in-game (1.12.1 client via VanillaFixes): a clamped 100x100 frame placed 10 above the bottom of the screen stays at 10, moves to 60 with (0, 0, 0, -60) and back to 10 once cleared; a frame placed 20 over the top is clamped to the edge and, with a top inset of -25, keeps its 20 over. GetClampRectInsets returns the insets set. * refactor(frame): address review of SetClampRectInsets Use the existing OFF_REGION_ANCHOR and UI coordinate globals instead of new duplicate offsets, and move the pixel/anchor-unit conversion into one shared Game::PixelToInternal / InternalToPixel pair (replacing the copies in LinePool, Transform and Metrics). Restore only the clamp bit around the unclamped rect calculation so other layout flag bits survive. Add doc descriptors for both methods and drop version/implementation notes from the user docs. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
fbcc1c9ae1 |
feat(editbox): add SetCountInvisibleLetters / IsCountInvisibleLetters (#88)
* feat(xml): read parentKey, function= and button font style= from XML Later clients' XML has three attributes vanilla's parser keeps on the node but never reads. Ported UIs lean on all three: Zygor Guides Viewer 2.0 uses parentKey 69 times (its arrow, skin buttons and step frames), binds its main frame's whole OnLoad with function=, and names button fonts with style=. All three hook the engine's per-object XML node loaders. Those run on the object's layout sub-object ((object+0x24)->vtable[+8], called from the frame builder at 0x006EE4D9 and the region factory at 0x006F2756), so the object is `this - OFF_XML_LOADER_SUBOBJECT`. The loaders: frames FUN_00769820 (every derived frame type's loader calls it first), textures FUN_0076FE20, font strings FUN_00770F40, and Button's FUN_XML_BUTTON_LOAD (CheckButton's calls it first). Each hook runs the engine's loader, then: - parentKey="Name" sets parent[Name] = object on the Lua wrappers, the parent being the object's script-region parent (OFF_REGION_PARENT, which GetParent reads). An unnamed element has no wrapper yet, so it is registered the way the engine's own lazy path does (ScriptRegister(object, NULL), as GetParent does); a named one is never registered here, since SetName already did that under its name. The builder loads content and child frames before it finalizes, so a parent's <OnLoad> already sees its keys, and keys inside a virtual template bind on every frame built from it. - A script element with function="Name" becomes frame:SetScript(<element>, _G[Name]). The loader runs before the builder's finalize, so a bound OnLoad fires at the usual point. - A NormalFont / HighlightFont / DisabledFont with style and no inherits is applied through the engine's own setter for that state with _G[style]. Vanilla reads only inherits there and otherwise leaves the button's embedded font empty, so its text had no font. Adds FUN_XML_FRAME_LOAD / FUN_XML_TEXTURE_LOAD / FUN_XML_FONTSTRING_LOAD / FUN_XML_BUTTON_LOAD, OFF_XML_LOADER_SUBOBJECT and OFF_SCRIPT_REGION_NAME, with their derivations. Verified in-game (1.12.1 client via VanillaFixes, Zygor Guides Viewer 2.0): probe XML gets its parent keys on a Frame, a Texture, a FontString, a button's NormalTexture and a frame inside an inherited template; an <OnShow function="..."/> handler runs; a button with <NormalFont style="GameFontHighlightSmall"/> reports that font object. Zygor's frames build with their keys, its main frame's OnLoad runs, and it loads without a Lua error. * feat(editbox): add SetCountInvisibleLetters / IsCountInvisibleLetters 3.3.5's EditBox can count color codes and hyperlink markup toward its SetMaxLetters limit: SetCountInvisibleLetters(true), or countInvisibleLetters="true" in XML (its macro text, friends broadcast and BNet report boxes). Off is the default. AceGUI-3.0's MultiLineEditBox calls the setter while building. 1.12's SetMaxLetters limit (+0x340) counts only visible letters: its counter (0x0077BC80) skips the markup classes in the edit box's per-byte table (+0x330), so with a limit of 5 "|cffff0000abcdefg|r" keeps "|cffff0000abcde" (checked in-game). That is 3.x's default (off). With the flag on, the limit check's three counts (returns 0x0077C09F, 0x0077C0C1, 0x0077C0E9) count each markup token at its length instead. The counter's other callers, the cursor movement and GetUTF8CursorPosition, are unchanged. For XML, hook the EditBox node loader (0x00779FB0, identified by the "letters"/"autoFocus"/"multiLine" attributes it reads after calling the frame loader) and, after it runs, read the attribute and parse it with the engine's own boolean parser (0x006F1B30, as for autoFocus). The loader follows the node-loader convention of the XML attributes change (OFF_XML_LOADER_SUBOBJECT), which this builds on. Verified in-game (1.12.1 client via VanillaFixes): with SetMaxLetters(12), "|cffff0000abcdefg|r" is kept whole with the flag off and cut to "|cffff0000ab" with it on; an XML EditBox with letters="12" and countInvisibleLetters="true" reports the flag on and cuts the text the same way. * docs: correct GetNumLetters note, drop version comparisons GetNumLetters counts the letters you see (FUN_007992C0 calls the same counter as the limit check), not bytes. Remove the 3.3.5 / stock 1.12 / later-client comparisons from the new XML and edit box sections. * fix(frame): build extra templates' child frames in CreateFrame The multi-template graft called the main vtable's +8 slot, which is the Lua method lookup FUN_00778590, not a node applier, passing the XML node as the Lua state. Its second call (the +0x24 sub-object's node loader) applied the template's content, but <Frames> children are built only by FUN_0076A060 from the finalize step, so an extra template's child frames were never created. Call the node loader, then FUN_XML_FRAME_LOAD_CHILD_FRAMES directly, so OnLoad is not re-run. Correct the notes in Offsets.h and CreateFrame.cpp. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
142faafb13 |
feat(frame): add SetHyperlinksEnabled / GetHyperlinksEnabled (#92)
* feat(frame): add SetHyperlinksEnabled / GetHyperlinksEnabled 3.3.5 has SetHyperlinksEnabled/GetHyperlinksEnabled on ScrollingMessageFrame and SimpleHTML only, so register them on those two types' method tables (0x00CF5294, 0x00CF5328), and hook the three functions both types fire OnHyperlinkEnter/Leave/Click through (0x007A3780, 0x007A37B0, 0x007A37E0) to skip the script while a frame's hyperlinks are off. On stays the default, which is vanilla's behavior. Zygor Guides Viewer 2.0 turns hyperlinks off on the step lines it fills with Gold Guide item lists, and back on when they show guide steps. Verified in-game (1.12.1 client via VanillaFixes): both types report true by default, false after SetHyperlinksEnabled(false) and true again after SetHyperlinksEnabled(true), and a plain Frame has neither method, as in 3.3.5. Not yet checked: the skipped script itself (a click on a link with hyperlinks off), which needs the mouse; that check runs next session. * refactor(frame): gate hyperlink scripts via RunnerHook, keep Leave Replace the three MinHooks on the per-type hyperlink fire functions with a Frame::RunnerHook subscriber keyed on the script slot (+0x320 Enter, +0x330 Click). OnHyperlinkLeave is never suppressed, so a tooltip shown before hyperlinks were disabled still closes. Parse the argument with the engine's loose boolean (default on), as 3.3.5's setter does. --------- Co-authored-by: Brues <5278969+brues-code@users.noreply.github.com> |
||
|
|
917b15640e |
feat(quest): add C_QuestLog.GetInfo and C_QuestLog.GetQuestLogTitle
Both run the engine's Script_GetQuestLogTitle (0x004DF930) and repackage its returns, so title, level, header, collapse and complete/failed state match the stock GetQuestLogTitle. Also registers Enum.QuestFrequency and Enum.QuestClassification. Corrects the Quest::Cache note on +0x14..+0x24: those slots are RepObjectiveFaction, RepObjectiveValue, the two opposite-rep fields and NextQuestInChain, not SuggestedPlayers and friends. The 1.12 wire carries no suggested group size, so suggestedGroup is always 0. |
||
|
|
85619155f8 |
feat(equipmentset): add C_EquipmentSet.PickupEquipmentSet
Equipment sets become action-bar buttons, as in 3.3.5: action type 0x20000000 | setID and cursor type 13. The set can be picked up, placed, dragged off, and swapped with other actions. The button shows the set icon, name and tooltip, and grays out while a set item is locked. A click fires WEAR_EQUIPMENT_SET(setID) and the embedded EquipmentManager equips the set. The server drops action type 0x20 without saving it, so placements are kept in the per-character equipment-set file. The server is sent an empty slot, and the saved buttons are merged into the SMSG_ACTION_BUTTONS buffer at login. GetActionInfo and GetCursorInfo report "equipmentset", name. |
||
|
|
46dc198505 |
feat(tooltip): add GameTooltip:GetUnit
GetUnit() returns (name, unitToken). The engine drops the token after
SetUnit resolves it to a GUID, so it is kept where it enters:
- SetUnit is re-registered in front of the engine method and stages
the token; it binds in the unit-builder co-hook that SetEvents
already owns, before OnTooltipSetUnit fires.
- A build with no staged token is the world mouseover ("mouseover");
the in-place refresh keeps the bound token.
- Unit-frame hover (Frame::Attributes) stages the frame's unit, since
the engine resolves "mouseover" only for a live object and an
offline or far group member has none.
The name follows Script_UnitName's order (live object, group roster
slot, name cache), so offline members resolve for GetUnit and
GetUnitGUID alike.
|
||
|
|
7707127d5f |
fix(macro): add the question-mark icon to the macro icon list
The stock 1.12 macro icon list holds only Ability_* and Spell_* icons, so on a client without Turtle or pfUI the macro picker cannot select INV_Misc_QuestionMark, and #showtooltip never gets a macro to take over. Mirror 3.3.5's loader: seed the icon through pass 3's own append before the walks, then move it to index 0 after the engine sorts and dedups. |
||
|
|
3467513df9 |
feat(container): group sorted gear by equip slot
Gear was one category per quality tier, ordered inside by class, subclass and name, so a helm could sit between two pairs of boots and an epic helm landed far from a green one. Gear is now one category, ordered by class, then equip slot, then subclass, then quality (best first), then name, so like pieces sit together. The slot key ranks Item.dbc inventoryType through a table rather than the raw INVTYPE number, which does not follow the character pane (robe is 20, chest 5; cloak 16). The order is Baganator's: weapons by hand, ranged and ammo, then armor with shields and off-hands first, head to feet, then jewelry, shirt and tabard. |
||
|
|
6000df8009 |
feat(cvar): add C_CVar.SetTempCVar and RemoveTempCVar
SetTempCVar changes a cvar for the session without saving it to Config.wtf; RemoveTempCVar restores the value from before the first temp set. The temp set passes a6 = 0 to the engine setter, the only argument that marks the config dirty, so it applies the value and runs the change callback without asking for a save. When something else dirties the config, a co-hook on the config writer (0x0063D980) points each temp cvar's value at its saved string for the write and restores it after. A plain SetCVar over a temp value wins: the entry drops itself, so the user's set is saved and never rolled back. Errors mirror Script_SetCVar. Registered in-game and on glue. |
||
|
|
fde3beca9d |
fix(table): keep the stored length on weak-valued tables
The getn heal read a nil at the stored last slot as proof that nobody maintained the length. For a weak-VALUED table that is false: the collector clears those slots behind the writer, so `luaL_setn` is still exactly what the last append left and the holes below it come and go between two reads. Compost-2.0 is the casualty. `secondarycache` is `__mode = "v"`, filled with `table.insert`; `GetTable` walks it with `pairs` and calls `table.remove(cache, i)` on a live index. Once the GC clears slot 1 and the stored last slot, the heal bisects to border 0, `luaB_tremove` takes its `e == 0` empty-table early-out and returns NOTHING, and the next line indexes with the nil it got back -- "table index is nil" at Compost-2.0.lua:81, once per recycled table, in every addon that pulls Compost in through AceLibrary. The border search is what exposed it (5aa382b's table.insert switch is not involved -- Compost never appends a nil, so no mark ever applied to its tables). The walk-down it replaced returned the HIGHEST populated slot, which is always at or above the live index the pairs loop holds, so remove still found something; a bisect returns some border and probes its way down to 0 through the collected slots. That tradeoff was known and written down -- a weak cache read through table.remove is where it bites. So gate the heal: `__mode` mentioning "v" returns the stored length untouched, as rule 3, ahead of the mark. It costs one getmetatable and a raw `__mode` fetch on the already-rare unhealthy path, so the bisect keeps its win everywhere else, and the mode is read raw -- the same fetch the collector's own check uses. New plumbing: Game::Lua::GetMetatable, from the offset already catalogued in LuaCAPI.md. LuaEnv::Fenv had rolled its own copy; it now shares this one. Verified in game: a three-slot weak table with slots 1 and 3 collected reports getn 3 and hands back its live slot (0 and nothing before), and the Compost errors are gone. |
||
|
|
bbefdb847d |
fix(aura): include the player's pet in the PLAYER filter
Blizzard defines the token as "Include only auras that were cast by the
player, or by the player's pet or vehicle"
(AuraUtil.AuraFilters.Player). There are no vehicles here, so the caster
set is player + pet -- but all three comparisons tested
`casterGuid == PlayerGuid()` and nothing else.
A pet's cast carries the PET's guid in the Aura::Source cache, since
that is who SMSG_SPELL_GO names, so "HARMFUL|PLAYER" silently dropped
every aura the pet applied. `!PLAYER` had the mirror bug: it returned
the pet's auras as though a third party cast them.
Centralize on one IsPlayerOrPetCaster predicate rather than fixing each
site -- IsPlayerCast, GroupIsPlayerCast and CachedMatches had already
grown three separate copies of the comparison, which is how they would
drift again. The pet guid comes from VAR_PET_GUID, a live engine global,
so the predicate stays two compares with no object resolve; it runs per
aura slot. A caster of 0 (cache miss) still matches nothing.
Unrelated and untouched: the `isFromPlayerOrPlayerPet` aura field, which
means "applied by ANY player or a player's pet" and is answered from the
caster's HIGHGUID prefix.
Verified in-game: a Hunter pet's Scorpid Poison now returns from
C_UnitAuras.GetAuraDataByIndex("target", 1, "HARMFUL|PLAYER").
|
||
|
|
0296e0e5a4 |
feat(player): add WEAPON_SLOT_CHANGED
Fires with no payload when the item in inventory slot 16, 17 or 18 changes -- equip, unequip and swap alike. The narrow sibling of PLAYER_EQUIPMENT_CHANGED that swing-timer consumers want, so they no longer filter three slots out of a 19-slot event in Lua on every gear change. Blizzard's own Blizzard_SwingTimer registers this event. Rides the descriptor-field observers Player::Equipment already installs for PLAYER_EQUIPMENT_CHANGED -- the weapon slots are three of the 19 -- so there is no new hook, no second registration and no polling. The dispatcher invokes the callback only when a slot's item GUID actually changed, and seeds each node's mirror from live at registration, so login and /reload produce no fire. Coalesced to at most one fire per frame via a dirty flag drained on WorldTick: one action can change two weapon slots (a two-hander replacing a one-hander plus an off-hand) and the per-slot observer would otherwise fire twice for it. The drain checks the reservation slot before clearing the flag, so a change marked while the reservation is still unclaimed is held rather than swallowed. Slot 18 is exempted for the classes whose slot 18 is a relic slot -- a Libram/Idol/Totem is a passive stat item, not something you swing. Gated on the same data Script_UnitHasRelicSlot (0x00519E50) reads rather than a hardcoded class list: ChrClasses.dbc[class] + 0x40, verified in the disassembly at 0x00519EAE-0x00519EC0 and against the client's own ChrClasses.dbc, where that column is 1 for PALADIN/SHAMAN/DRUID and 0 for the other six. Read live, since the class-byte global is repopulated per character-enter. Not verified in-game yet: built and deployed only. |
||
|
|
4d835aa674 |
feat(combat): add PLAYER_SWING / PLAYER_SWING_RANGE_UPDATE / C_SwingTimer
Backports the Forever beta swing-timer API. PLAYER_SWING and PLAYER_SWING_RANGE_UPDATE fire off the packets the engine already sends for melee/ranged auto-attacks, mirrored as state (parry haste, extra attacks, on-next-swing abilities, cast-time resets) rather than relayed 1:1, so N packets for one logical reset collapse into one event. Two bugs surfaced only by in-game testing, not by reading the disassembly: - FUN_UNIT_CAN_ATTACK (0x00606980) is __thiscall with the second unit pushed on the stack, not __fastcall(ecx,edx) -- Ghidra's decompile of the one caller renders it as a plain two-arg call either way, so the wrong convention crashed on a bogus ecx read off [ebp+8] garbage. Same trap as FUN_SET_CVAR_VALUE. - The generic engine range core (FUN_006e3480, what C_Spell.IsSpellInRange already uses) computes full 3D distance, but the server's actual melee-attack gate (Unit::CanReachWithMeleeAutoAttackAtPosition, WorldObject::CanReachWithMeleeSpellAttack) is explicitly 2D -- verified by landing hits at 5.08yd 3D distance that the 3D check rejected. Melee now gets its own 2D check (Combat::Swing::InMeleeRange), reading the same live engine reach constants; ranged keeps the 3D core, which matches the server's own (also 3D) generic spell-range gate. Also: attack-start no longer resets the off-hand timer unless the target is actually in range. Unit::Attack's off-hand reset fires the instant an attack is declared, even out of range, and the server just silently re-arms it every 100ms until you're close enough -- firing PLAYER_SWING there promised a swing time that was not real. Slam is special-cased for Turtle: every rank in Turtle's own client Spell.dbc carries AttributesEx2's swing-reset exemption, but packet timestamps show Turtle's server does not honor it for Slam -- both melee timers delay after casting it, contradicting both the client data and the public tortoise-wow reference source. Combat::Swing::AutoSwingResetOverride is a small extension point (mirroring Turtle::ComboDuration's Rip override) for this kind of server/client divergence; src/turtle/SwingReset.cpp registers the known Slam ranks. Verified in-game: swing detection (dual-wield, extra attacks coalescing to one event, cast-time resets), the melee range fix, and the attack-start range gate. The Slam override has not been rebuilt/retested yet. |
||
|
|
dfbba225d2 |
fix(macro): correct the loose/mpq split in the icon enumeration
The three macro-icon scan callbacks were named and tagged for the wrong walker. FUN_LOAD_MACRO_ICONS hands 0x004F0220 to FUN_MPQ_ENUM_FILES (the archive listfile walk) and 0x004F0350 / 0x004F04F0 to the disk walker, but Icons.cpp had it exactly inverted: the archive pass was tagged SRC_LOOSE and both disk passes SRC_MPQ. So GetMacroIcons / GetMacroItemIcons returned the loose on-disk icons -- nothing at all on a stock install -- while GetLooseMacroIcons / GetLooseMacroItemIcons returned the archive set. It went unnoticed because the only consumer, IconDataProviderMixin, calls all four and concatenates, so only the ordering within each list changed and never the content. Tags corrected, and the offsets renamed to what the loader actually hands them to, with each one's filter recorded since that is the load-bearing difference between the two disk passes: FUN_MACRO_ICON_CB_DISK -> FUN_MACRO_ICON_CB_MPQ FUN_MACRO_ICON_CB_USER_MPQ -> FUN_MACRO_ICON_CB_DISK_PREFIXED FUN_MACRO_ICON_CB_INSTALL_MPQ -> FUN_MACRO_ICON_CB_DISK_ANY Also replaces a wrong guess in the Offsets.h block. It claimed a filter inside the SStrDup/array-append helpers downstream of all three callbacks was what kept INV_* out of the engine's own list. Decompiling the loader and all three callbacks shows there is no shared downstream helper at all: the grow-and-append code is inlined identically into each callback, so the only filtering is what each one does itself. The list is Ability_*/Spell_* only because passes 1-2 prefix-filter and pass 3 -- the one that does not -- is a disk walk over a folder that ships empty. A loose INV_*.blp dropped into Interface\Icons\ does enter the list, through pass 3 alone. The block now also records the qsort + adjacent SStrCmpI dedup, that GetMacroIconInfo pushes the empty string rather than nil for a bad index, and that only GetNumMacroIcons triggers the lazy build. Verified in-game. |