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

4
api/CalendarContextDeselectEvent.lua
View File

@@ -1,5 +1,7 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---Clears the event selection used only for CalendarContext functions. The selection state cleared 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).
---Clears the event selection used only for CalendarContext functions. The selection state cleared 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).
function CalendarContextDeselectEvent() end

23
api/CalendarContextEventCanComplain.lua
View File

@@ -1,13 +1,16 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@return boolean canReport
---Returns whether the player can report an event invitation as spam. If all arguments are omitted, uses the event selected by CalendarContextSelectEvent.
function CalendarContextEventCanComplain(monthOffset, -1, 0, 1, nil, day, index) end
---@alias monthOffset
---| -1 month preceding the calendar's current month
---| 0 The calendar's current month (i.e. same month as CalendarGetMonth())
---| 1 month after the calendar's current month
---| nil Use the event selected by CalendarContextSelectEvent and ignore further arguments
---@param monthOffset monthOffset
---@param day number
---@param index number
---@return boolean canReport
---Returns whether the player can report an event invitation as spam. If all arguments are omitted
---uses the event selected by CalendarContextSelectEvent.
function CalendarContextEventCanComplain(monthOffset, day, index) end

14
api/CalendarContextEventCanEdit.lua
View File

@@ -1,13 +1,9 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@return boolean canEdit
---@param monthOffset monthOffset
---@param day number
---@param index number
---@return boolean canEdit
---Returns whether the player can edit an event
function CalendarContextEventCanEdit(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextEventCanEdit(monthOffset, day, index) end

12
api/CalendarContextEventComplain.lua
View File

@@ -1,12 +1,8 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@param monthOffset monthOffset
---@param day number
---@param index number
---Reports an event invitation as spam
function CalendarContextEventComplain(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextEventComplain(monthOffset, day, index) end

12
api/CalendarContextEventCopy.lua
View File

@@ -1,12 +1,8 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@param monthOffset monthOffset
---@param day number
---@param index number
---Copies an event for later pasting
function CalendarContextEventCopy(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextEventCopy(monthOffset, day, index) end

30
api/CalendarContextEventGetCalendarType.lua
View File

@@ -1,20 +1,18 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@return SYSTEM calendarType
---@return GUILD_ANNOUNCEMENT
---@return GUILD_EVENT
---@return HOLIDAY
---@return PLAYER
---@return RAID_LOCKOUT
---@return RAID_RESET
---@return SYSTEM
---@alias calendarType
---| "GUILD_ANNOUNCEMENT" Guild announcement (does not allow players to sign up)
---| "GUILD_EVENT" Guild event (allows players to sign up)
---| "HOLIDAY" World event (e.g. Lunar Festival, Darkmoon Faire, Stranglethorn Fishing Tournament, Call to Arms: Arathi Basin)
---| "PLAYER" Player-created event or invitation
---| "RAID_LOCKOUT" Indicates when one of the player's saved instances resets
---| "RAID_RESET" Indicates scheduled reset times for major raid instances
---| "SYSTEM" Other server-provided event
---@param monthOffset monthOffset
---@param day number
---@param index number
---@return calendarType
---Returns the type of a calendar event. If all arguments are omitted, uses the event selected by CalendarContextSelectEvent.
function CalendarContextEventGetCalendarType(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextEventGetCalendarType(monthOffset, day, index) end

9
api/CalendarContextEventPaste.lua
View File

@@ -1,10 +1,7 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset 1
---@param -1
---@param 0
---@param 1
---@param day number
---@param monthOffset monthOffset
---@param day number
---Pastes a copied event into a given date. Does nothing if no event has been copied via CalendarContextEventCopy.
function CalendarContextEventPaste(monthOffset, -1, 0, 1, day) end
function CalendarContextEventPaste(monthOffset, day) end

12
api/CalendarContextEventRemove.lua
View File

@@ -1,12 +1,8 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@param monthOffset monthOffset
---@param day number
---@param index number
---Deletes an event from the calendar
function CalendarContextEventRemove(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextEventRemove(monthOffset, day, index) end

12
api/CalendarContextEventSignUp.lua
View File

@@ -1,12 +1,8 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@param monthOffset monthOffset
---@param day number
---@param index number
---Signs the player up for a guild event
function CalendarContextEventSignUp(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextEventSignUp(monthOffset, day, index) end

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

12
api/CalendarContextInviteAvailable.lua
View File

@@ -1,12 +1,8 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@param monthOffset monthOffset
---@param day number
---@param index number
---Accepts an event invitation
function CalendarContextInviteAvailable(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextInviteAvailable(monthOffset, day, index) end

12
api/CalendarContextInviteDecline.lua
View File

@@ -1,12 +1,8 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@param monthOffset monthOffset
---@param day number
---@param index number
---Declines an event invitation
function CalendarContextInviteDecline(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextInviteDecline(monthOffset, day, index) end

14
api/CalendarContextInviteIsPending.lua
View File

@@ -1,13 +1,9 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@param monthOffset CalendarContextSelectEvent
---@param -1
---@param 0
---@param 1
---@param nil CalendarContextSelectEvent
---@param day number
---@param index number
---@return boolean pendingInvite
---@param monthOffset monthOffset
---@param day number
---@param index number
---@return boolean pendingInvite
---Returns whether the player has been invited to an event and not yet responded
function CalendarContextInviteIsPending(monthOffset, -1, 0, 1, nil, day, index) end
function CalendarContextInviteIsPending(monthOffset, day, index) end