Skip to content

Commit 6c6e830

Browse files
committed
Enrich new pages with pulled info: Blizzard doc strings, function signatures, mixin inheritance
1 parent ad54934 commit 6c6e830

3 files changed

Lines changed: 268 additions & 250 deletions

File tree

docs/patches/12.1.0/field-level.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ Changes *inside* API entries that exist in both builds — struct fields, enum v
153153

154154
### `HousingDecorInstanceInfo` (struct)
155155

156+
Info for an instance of Housing Decor that has been/is being placed within a House or its exterior Plot
157+
156158
```diff
157159
decorGUID: WOWGUID
158160
decorID: number
@@ -349,6 +351,8 @@ Changes *inside* API entries that exist in both builds — struct fields, enum v
349351

350352
#### `C_ActionBar.ForceUpdateAction`
351353

354+
Force updates some internals for an action button slot.
355+
352356
- args: `slotID: luaIndex``slotID: luaIndex, suppressEvents: bool`
353357

354358
#### `C_CombatAudioAlert.SpeakText`
@@ -357,18 +361,26 @@ Changes *inside* API entries that exist in both builds — struct fields, enum v
357361

358362
#### `C_HousingDecor.GetMaxPlacementBudget`
359363

364+
Returns the max decor placement budget for the current owned house interior or plot; Can be increased via house level
365+
360366
- returns: `maxBudget: number``maxBudget: number?`
361367

362368
#### `C_HousingDecor.GetSpentPlacementBudget`
363369

370+
Returns how much of the current owned house interior or plot's decor placement budget has been spent; Different kinds of decor take up different budget amounts, so this value isn't an individual decor count, see GetNumDecorPlaced for that
371+
364372
- returns: `totalCost: number``totalCost: number?`
365373

366374
#### `C_HousingLayout.GetRoomPlacementBudget`
367375

376+
Returns the max room placement budget for the current owned house's interior; Can be increased via house level
377+
368378
- returns: `placementBudget: number``placementBudget: number?`
369379

370380
#### `C_HousingLayout.GetSpentPlacementBudget`
371381

382+
Returns how much of the current owned house's room placement budget has been spent; Different kinds of rooms take up different budget amounts, so this value isn't an individual room count, see GetNumActiveRooms for that
383+
372384
- returns: `spentPlacementBudget: number``spentPlacementBudget: number?`
373385

374386
#### `C_Ping.SendMacroPing`
@@ -389,14 +401,20 @@ Changes *inside* API entries that exist in both builds — struct fields, enum v
389401

390402
#### `C_Spell.GetSpellName`
391403

404+
Returns nil if spell is not found
405+
392406
- returns: `name: string``name: cstring`
393407

394408
#### `C_Spell.GetSpellTexture`
395409

410+
Returns nothing if spell is not found
411+
396412
- returns: `iconID: fileID, originalIconID: fileID``iconID: fileID, originalIconID: fileID, conditionalIconID: fileID?`
397413

398414
#### `FrameScript.CreateSecureDelegate`
399415

416+
Creates a secure delegate closure for a Lua function. The delegate invokes the original function in a protected call context with secure execution taint, and supports passing and returning values directly.
417+
400418
- args: `luaFunction: LuaValueReference``luaFunction: LuaValueReference, options: SecureDelegateOptions?`
401419

402420
#### `SimpleAnimAPI.GetScript`

0 commit comments

Comments
 (0)