dave/wow_Meta
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor calendar context functions to use parameter aliases for improved clarity

Browse Source
This commit is contained in:
PhatPhuckDave
2025-05-18 00:50:42 +02:00
parent 5f352cbfbe
commit 9ee4bb792c
13 changed files with 72 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
api/CalendarContextGetEventIndex.lua
View File

@@ -1,11 +1,11 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@return 1 monthOffset
---@return -1
---@return 0
---@return 1
---@return monthOffset monthOffset
---@return number day
---@return number index
---Returns the month, day, and index of the event selection used only for CalendarContext functions. The selection state referenced by this function is used only by other CalendarContext functions; other calendar event functions use the selection state set by CalendarOpenEvent, CalendarNewEvent, CalendarNewGuildEvent, or CalendarNewGuildAnnouncement (if they use a selection state at all). Used in the default UI to implement the calendar's context menu (on right-click).
---Returns the month, day, and index of the event selection used only for CalendarContext functions. The selection state referenced by this function
---is used only by other CalendarContext functions; other calendar event functions use the selection state set by CalendarOpenEvent, CalendarNewEvent,
---CalendarNewGuildEvent, or CalendarNewGuildAnnouncement (if they use a selection state at all). Used in the default UI to implement the
---calendar's context menu (on right-click).
function CalendarContextGetEventIndex() end