Split patch into per-section pages (collapsible nav) + widen sidebars

Author: DanderBot

docs/index.md

@@ -6,7 +6,7 @@ Built for addon developers. Each patch has its own page (see the navigation on t
 
 ## Patches
 
-- [**12.1.0 (PTR)** — vs 12.0.7](patches/12.1.0.md)
+- [**12.1.0 (PTR)** — vs 12.0.7](patches/12.1.0/index.md)
 
 ## How this is compiled
 

docs/patches/12.1.0.md

@@ -0,0 +1,112 @@
+# Auras & Cooldown Viewer
+
+## C_UnitAuras (UnitAuraDocumentation)
+
+**New:**
+
+- **`GetHiddenGroupBuffs() → spellIDs: table<number>`** — the list of group-buff spell IDs the player has hidden.
+- **`SetHiddenGroupBuffs(spellIDs: table<number>)`** — sets the list of group-buff spell IDs to hide.
+- **`GetGroupBuffVisualAlerts() → visualAlerts: table<GroupBuffVisualAlertInfo>`** — the configured group-buff visual alerts.
+- **`SetGroupBuffVisualAlerts(visualAlerts: table<GroupBuffVisualAlertInfo>)`** — sets the group-buff visual alerts.
+- **`HIDDEN_GROUP_BUFFS_CHANGED`** (event) — the hidden group-buff list changed. Payload: `spellIDs: table<number>`.
+- **`GROUP_BUFF_VISUAL_ALERTS_CHANGED`** (event) — group-buff visual alerts changed. Payload: `visualAlerts: table<GroupBuffVisualAlertInfo>`.
+
+**Removed:**
+
+- **`TriggerPrivateAuraShowDispelType`** — gone in 12.1.0.
+
+## UnitConstantsDocumentation
+
+**New:**
+
+- **`GroupBuffVisualAlertInfo`** (struct) — pairs a group-buff spell with its alert style. Fields: `spellID: number, visualValue: VisualAlertType`.
+
+**Changed:**
+
+`AddPrivateAuraAnchorArgs` (struct) — args for `C_UnitAuras.AddPrivateAuraAnchor`. `showCountdownFrame` was **renamed** to `showCooldownFrame`; `showCooldownEdge` and `showDispelIcon` were added; all bool fields now default `false`:
+
+```diff
+  unitToken: cstring
+  auraIndex: number
+  parent: SimpleFrame
+- showCountdownFrame: bool
++ showCooldownFrame: bool
++ showCooldownEdge: bool
+  showCountdownNumbers: bool
++ showDispelIcon: bool
+  isContainer: bool
+  iconInfo: PrivateAuraIconInfo?
+  durationAnchor: AnchorBinding?
+```
+
+## UnitAuraConstantsDocumentation *(new namespace)*
+
+**New:**
+
+- **`UnitAuraUIConstants`** (constants) — list-size caps. Values: `HIDDEN_GROUP_BUFF_LIST_SIZE = 32, GROUP_BUFF_VISUAL_ALERT_LIST_SIZE = 32`.
+
+## C_CooldownViewer (CooldownViewerDocumentation)
+
+**New:**
+
+- **`GetGroupBuffItems() → groupBuffItems: table<GroupBuffItem>`** — the available group-buff items.
+- **`GroupBuffItem`** (struct) — a group-buff entry. Fields: `spellID: number, name: cstring, iconID: fileID, flags: GroupBuffItemFlags, isKnown: bool`.
+
+**Changed:**
+
+`CooldownViewerCooldown` (struct, returned by `GetCooldownViewerCooldownInfo`) — `spellID` became nilable; `spellCategoryID`, `equipSlot`, and `isInvisible` were added:
+
+```diff
+  cooldownID: number
+- spellID: number
++ spellID: number?
++ spellCategoryID: number?
+  overrideSpellID: number?
+  overrideTooltipSpellID: number?
++ equipSlot: luaIndex?
+  linkedSpellIDs: table<number>
+  selfAura: bool
+  hasAura: bool
+  charges: bool
+  isKnown: bool
++ isInvisible: bool
+  flags: CooldownSetSpellFlags
+  category: CooldownViewerCategory
+```
+
+## CooldownViewerConstantsDocumentation
+
+**New:**
+
+- **`CooldownViewerSound`** (enum) — selectable "ready" alert sound; 94 values (0–93), e.g. `TextToSpeech (0)`, `AnimalsCat (1)`, `War3Bell (56)`.
+- **`GroupBuffItemFlags`** (enum) — flags for group-buff items. Values: `HideByDefault`.
+- **`GroupBuffUIConstants`** (constants) — Values: `GROUP_BUFF_ITEM_LIST_SIZE = 16`.
+
+**Changed:**
+
+- **`CooldownViewerCategory`** (enum) — grew from 4 to 9 values; added `GroupBuff (4), SpecAgnosticEssential (5), SpecAgnosticTracked (6), EquipSlotEssential (7), EquipSlotTracked (8)`.
+- **`CooldownViewerUIConstants`** (constants) — added `COOLDOWN_VIEWER_SPEC_AGNOSTIC_PARENT_ID = 0`.
+
+## SecretAspectConstantsDocumentation
+
+**Changed:**
+
+- **`SecretAspect`** (enum, bitfield) — added `RadialProgress (8388608)`; now 30 values.
+
+## ForbiddenAspectConstantsDocumentation *(new namespace)*
+
+**New:**
+
+- **`ForbiddenAspect`** (enum) — aspects forbidden from being set on protected frames. Values: `SetToDefaults, ScriptBindings`.
+
+## VisualAlertConstantsDocumentation *(new namespace)*
+
+**New:**
+
+- **`VisualAlertType`** (enum) — visual alert styles for group buffs. Values: `MarchingAnts (+ Cyan/Red/Green/Blue), Flash (+ Cyan/Red/Green/Blue)`.
+
+## TooltipInfoSharedDocumentation
+
+**Changed:**
+
+- **`TooltipDataLineType`** (enum) — added `ItemSpellTriggerOnUse (44), ItemSpellTriggerOnEquip (45), ItemSpellTriggerOnProc (46)` — tag tooltip lines for an item's Use/Equip/on-proc spell effects.

docs/patches/12.1.0/auras.md

@@ -0,0 +1,53 @@
+# Edit Mode, Nameplates & Misc
+
+## EditModeManagerConstantsDocumentation
+
+**New:**
+
+- **`EditModeRaidWarningSetting`** (enum) — settings for the new Raid Warning system. Values: `None`.
+
+**Changed:**
+
+- **`EditModeSystem`** (enum) — added `RaidWarning (24)` (`TotemActionBar` shifts to 25).
+- **`EditModeAccountSetting`** (enum) — added `ShowRaidWarning (33)` (`ShowTotemActionBar` shifts to 34).
+- **`EditModeMinimapSetting`** (enum) — added `IconScale (3)`.
+- **`EditModeUnitFrameSetting`** (enum) — the single `IconSize (19)` aura setting was **split**: slot 19 repurposed to `DebuffIconSize`, new `BuffIconSize (22)` appended. Buff and debuff icon sizes are now controlled independently; code reading the old `IconSize` must update.
+
+## NamePlateConstantsDocumentation
+
+**Changed:**
+
+- **`NamePlateStyle`** (enum) — added `Classic (6)`. Values: `Modern, Thin, Block, HealthFocus, CastFocus, Legacy, Classic`.
+
+## C_CVar (CVarDocumentation)
+
+**New:**
+
+- **`GetCVar(name: cstring) → value: string?`** — the current string value of a CVar by name (now part of the documented `C_CVar` surface).
+
+## C_Sound (SoundDocumentation)
+
+**New:**
+
+- **`PlaySoundWithOptions(params: PlaySoundParams) → success: bool, soundHandle: SoundHandle`** — plays a sound from an options struct (may return nothing).
+- **`PlaySoundParams`** (struct) — options for the above. Fields: `soundKitID: number, uiSoundSubType: UISoundSubType, forceNoDuplicates: bool, runFinishCallback: bool, overridePriority: number?, volumeOverride: number?, …`.
+
+## MacroConstantsDocumentation *(new namespace)*
+
+**New:**
+
+- **`MacroConsts`** (constants) — macro count limits. Values: `MAX_ACCOUNT_MACROS = 120, MAX_CHARACTER_MACROS = 30`.
+
+## DelvesConstantsDocumentation
+
+**Changed:**
+
+- **`TieredEntranceType`** (enum) — added `Lairs (4)`.
+- **`CompanionConfigSlotTypes`** (enum) — added `Flavor (3)`.
+
+## C_DelvesUI (DelvesUIDocumentation)
+
+**New:**
+
+- **`GetFlavorNodeForCompanion(companionID: number?) → nodeID: number`** — the flavor trait node ID for a delve companion.
+- **`GetFlavorNodeNameForCompanion(companionID: number?) → name: cstring`** — the display name of that flavor node.

docs/patches/12.1.0/edit-mode.md

@@ -0,0 +1,101 @@
+# Frames, UI & Secure Internals
+
+## FrameScript
+
+**New:**
+
+- **`GetForbiddenObjectTable(object: FrameScriptObject) → forbiddenTable: FrameScriptObject`** — secure-only; retrieves the forbidden-side object table for a script object.
+- **`securecopy(value: LuaValueReference, options: SecureCopyOptions?) → copy: LuaValueReference`** — securely copies a Lua value; tables deep-copied with recursive/shared refs preserved, script objects kept by reference, copy receives the current execution taint.
+- **`SecureCopyOptions`** (struct) — options for `securecopy`. Fields: `maxTraversalDepth: number (default 100), wrapUntrustedFunctions: bool (default true)`.
+- **`SecureDelegateOptions`** (struct) — options for `CreateSecureDelegate`. Fields: `wrapUntrustedFunctions: bool (default true)`.
+
+## SimpleFrameAPI
+
+**New:**
+
+- **`AddRoleset(roleset: string)`** — adds a roleset tag without removing existing ones.
+- **`RemoveRoleset(roleset: string)`** — removes a roleset tag.
+- **`SetRolesets(rolesetsString: cstring?)`** — sets the frame's roleset tags (comma-separated for multiple; nil clears) — used by the UI-mode system to gate visibility.
+- **`GetRolesetNames() → rolesets: table`** — the frame's roleset tags (`{"roleless"}` if none).
+- **`GetOnUpdateMode() → onUpdateMode: OnUpdateMode`** — the configured OnUpdate execution mode.
+- **`SetOnUpdateMode(onUpdateMode: OnUpdateMode)`** — changes when OnUpdate scripts run for this object.
+- **`CreateVectorGraphics(name: cstring?, drawLayer: DrawLayer?, templateName: cstring?, subLevel: number?) → vectorGraphics: SimpleVectorGraphics`** — creates a vector-graphics child region.
+
+## SimpleFrameScriptObjectAPI
+
+**New:**
+
+- **`GetName() → name: cstring`** — the object's name (secret-gated by the ObjectName aspect).
+- **`GetObjectTable() → objectTable: FrameScriptObject`** — the script object's backing object table.
+- **`HasAnyForbiddenAspect(aspect: ForbiddenAspect) → hasAnyForbiddenAspect: bool`** — whether the object has the supplied forbidden aspect.
+- **`HasAnyForbiddenAspects() → hasAnyForbiddenAspects: bool`** — whether the object has any forbidden aspects.
+
+## SimpleFrameScriptObjectConstants *(new namespace)*
+
+**New:**
+
+- **`OnUpdateMode`** (enum) — when OnUpdate scripts run. Values: `Disabled, RunWhenVisible, RunWhenVisibleOnce, RunOnce, RunAlways`.
+- **`ScriptBindingType`** (enum) — script binding phase. Values: `Precall, Extrinsic, Postcall`.
+- **`ScriptObjectMetatable`** (enum) — Values: `Public, Forbidden`.
+- **`ScriptObjectPartition`** (enum) — Values: `Public, Forbidden`.
+
+## SimpleStatusBarAPI
+
+**New:**
+
+- **`GetRenderMode() → renderMode: StatusBarRenderMode`** — the status bar's render mode.
+- **`SetRenderMode(renderMode: StatusBarRenderMode)`** — sets the render mode (linear fill vs radial progress).
+
+## SimpleStatusBarConstants
+
+**New:**
+
+- **`StatusBarRenderMode`** (enum) — how the bar renders its fill. Values: `Linear` (existing fill behaviour), `Radial` (drives the managed texture's radial fill percent instead of resizing anchors).
+
+## SimpleTextureBaseAPI
+
+**New (radial progress bar):**
+
+- **`ClearRadialProgressBar()`** — disables radial rendering, restores standard texture display.
+- **`Get/SetRadialProgressBarStartOffset(offset: normalizedValue)`** — start angle offset (0–1; 0 = bottom).
+- **`Get/SetRadialProgressBarEndOffset(offset: normalizedValue)`** — end angle offset (0–1).
+- **`Get/SetRadialProgressBarPercent(percent: normalizedValue)`** — fill percentage (0–1).
+- **`Get/SetRadialProgressBarFeather(feather: normalizedValue)`** — edge feather/blur amount.
+- **`Get/SetRadialProgressBarReverse(reverse: bool)`** — whether the bar fills counterclockwise.
+
+## SimpleAnimRadialProgressAPI *(new namespace)*
+
+**New:**
+
+- **`Get/SetFromPercent(percent: number)`** — animation's starting radial fill percent.
+- **`Get/SetToPercent(percent: number)`** — animation's ending radial fill percent.
+
+## SimpleVectorGraphicsAPI *(new namespace)*
+
+**New:**
+
+- **`SetSVG(svgAsset: FileAsset) → success: bool`** — assigns an SVG asset.
+- **`GetSVGFileID() → svgFile: fileID`** — file ID of the assigned SVG.
+- **`HasSVG() → hasSVG: bool`** — whether an SVG is assigned.
+- **`ClearSVG()`** — clears the assigned SVG.
+
+## C_Roleset (RolesetSystemDocumentation) *(new namespace)*
+
+**New:**
+
+- **`C_Roleset.ApplyRolesetFilters(blockedRolesets: table, allowedRolesets: table)`** — sets/clears both blocklist and allowlist filters atomically with one visibility re-evaluation; empty table clears the corresponding filter.
+
+## DurationTextBindingObjectAPI
+
+**New:**
+
+- **`SetTextColorCurve(curve: LuaColorCurveObject, property: DurationTextBindingProperty)`** — drive a font string's colour from a duration property via a curve.
+- **`GetTextColorCurve() → curve: LuaColorCurveObject, property: DurationTextBindingProperty`** — the curve and property in use (may return nothing).
+- **`ClearTextColorCurve()`** — clears the colour curve.
+- **`GetFormattedTextColor() → color: colorRGBA`** — the colour currently assigned to the configured font string (may return nothing).
+
+## MinimapFrameAPI
+
+**New:**
+
+- **`SetIconScale(scale: number)`** — sets the scale applied to minimap icons.

docs/patches/12.1.0/frames.md

@@ -0,0 +1,67 @@
+# Gameplay: PvP, Items, Spells, Specs
+
+## C_PvP (PvpInfoDocumentation)
+
+**New:**
+
+- **`CanSurrenderArena() → canSurrender: bool`** — whether the player can currently surrender the arena match.
+
+## ItemConstantsDocumentation
+
+**New:**
+
+- **`ItemConversionFlags`** (enum) — flags controlling item conversion. Values: `UseInputItemStats`.
+
+## C_Item (ItemDocumentation)
+
+**New:**
+
+- **`DoesItemMatchSpellItemCondition(itemLoc: ItemLocation) → matches: bool`** — whether the item at a location satisfies the current spell's item condition.
+
+## C_Spell (SpellDocumentation)
+
+**New:**
+
+- **`TargetSpellChecksItemCondition() → result: bool`** — whether the pending/target spell evaluates an item condition.
+
+## SpecializationSharedDocumentation
+
+**New:**
+
+- **`GetSpecializationSystem() → system: SpecializationSystem`** — which specialization system is active.
+
+## PaperDollInfoDocumentation
+
+**New:**
+
+- **`GetInventorySlotInfo(slotName: cstring) → invSlot: number, slotTexture: fileID, checkRelic: bool`** — resolves a slot by name (may return nothing) — the C_API equivalent of the old global.
+- **`GetInventorySlotInfoForInvSlot(invSlotValue: number) → invSlot: number, slotTexture: fileID, checkRelic: bool, slotName: cstring`** — resolves slot info from a Lua INVSLOT value (may return nothing).
+
+## C_PetJournal (PetJournalInfoDocumentation)
+
+**New:**
+
+- **`GetPetInfoTableBySpeciesID(speciesID: number) → petInfo: PetJournalPetInfo`** — a consolidated pet-info table for a species (may return nothing).
+
+## QuestHubInfoDocumentation
+
+**New:**
+
+- **`IsQuestCurrentlyRelatedToHub(questID: number, hubAreaPoiID: number) → isRelated: bool`** — whether a quest is currently associated with a given hub-area POI.
+
+## CharacterCreationConstantsDocumentation
+
+**New:**
+
+- **`RestrictionType`** (enum) — why a creation option is restricted. Values: `Invalid, ServerExpansion, AccountExpansion, Achievement, Entitlement`.
+
+## C_DyeColor (DyeColorInfoDocumentation)
+
+**New:**
+
+- **`GetDyeColorsForItem(itemLinkOrID: ItemInfo) → dyeColorIDs: table`** — all applicable dye-colour IDs for an item.
+- **`GetDyeColorsForItemLocation(itemLocation: ItemLocation) → dyeColorIDs: table`** — all applicable dye-colour IDs for an item at a location.
+
+**Removed:**
+
+- **`GetDyeColorForItem(itemLinkOrID: ItemInfo) → dyeColorID: number?`** and `GetDyeColorForItemLocation(itemLocation: ItemLocation) → dyeColorID: number?` — replaced by the plural versions that return a table of IDs.

docs/patches/12.1.0/gameplay.md

@@ -0,0 +1,11 @@
+# Housing
+
+Housing saw broad changes across many namespaces; most are internal UI plumbing plus struct/enum additions. The breaking change is the `IsInsideOwnHouse` → `IsInsideOwnedHouse` rename. Highlights by namespace:
+
+- **C_HousingBlueprint (new namespace)** — full blueprint-sharing system. `ImportBlueprint(shareCode: cstring)`, `ExportBlueprint(type: HousingBlueprintType, name: cstring)`, plus `ExportRoomBlueprint`, `DeleteBlueprint`, `RenameBlueprint`, `IsImportAvailable`/`IsExportAvailable`, `CanImportTypeFromCurrentLocation`, `IsShareCodeValid`, `GetBlueprintHyperlink`, `GetBlueprintTypeForCode`.
+- **HousingBlueprintConstants (new namespace)** — supporting types: enums `HousingBlueprintContentType` (None, HouseType, Room, Decor, Dye, Fixture, Other) and `HousingBlueprintUnmetRequirementFlags` (bitfield: InsufficientBudget, MissingRoom, MissingFixture, MissingDecor, MissingDye, MismatchedExteriorFaction, HouseTypeLocked, HouseSizeLocked); structs for blueprint collections/groups/entries.
+- **C_HousingUI** — `IsInsideOwnHouse` **renamed** to `IsInsideOwnedHouse() → bool`; new `IsInsideOwnedHouseOrPlot`, `IsInsideOwnedPlot`; new `ResetHouse(resetScope: HousingHouseScope)` (restricted; clears house contents) with `HOUSE_RESET_COMPLETED`/`HOUSE_RESET_FAILED` events; new `HouseFinderIgnoreNeighborhood`.
+- **C_HousingLayout** — `GetRoomPlayerIsIn() → roomGUID: WOWGUID` (may return nothing), `GetBaseRoomFloor`.
+- **C_HousingDecor** — decor pet-placement: `GetDecorCanAttachPet`, `GetDecorAssignedPetName`, `GetMax/SpentPetPlacementBudget`, `GetBothMaxPlacementBudgets`, `AnyDecorPlacedInRoom`.
+- **C_HousingCustomizeMode** — `ApplyPetToSelectedDecor`, `GetSelectedDecorPetInfo`.
+- **PlayerHousingConstants** — added `HousingBlueprintFlag`, `HousingHouseScope` enums + a `HousingConsts` table.