diff --git a/api/CalendarContextDeselectEvent.lua b/api/CalendarContextDeselectEvent.lua index 3f5822a..c908c94 100644 --- a/api/CalendarContextDeselectEvent.lua +++ b/api/CalendarContextDeselectEvent.lua @@ -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 diff --git a/api/CalendarContextEventCanComplain.lua b/api/CalendarContextEventCanComplain.lua index 4329aef..4d10379 100644 --- a/api/CalendarContextEventCanComplain.lua +++ b/api/CalendarContextEventCanComplain.lua @@ -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 \ No newline at end of file +---@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 diff --git a/api/CalendarContextEventCanEdit.lua b/api/CalendarContextEventCanEdit.lua index afb2972..60d5fe0 100644 --- a/api/CalendarContextEventCanEdit.lua +++ b/api/CalendarContextEventCanEdit.lua @@ -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 \ No newline at end of file +function CalendarContextEventCanEdit(monthOffset, day, index) end diff --git a/api/CalendarContextEventComplain.lua b/api/CalendarContextEventComplain.lua index 70d6ba5..14563be 100644 --- a/api/CalendarContextEventComplain.lua +++ b/api/CalendarContextEventComplain.lua @@ -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 \ No newline at end of file +function CalendarContextEventComplain(monthOffset, day, index) end diff --git a/api/CalendarContextEventCopy.lua b/api/CalendarContextEventCopy.lua index e8971f7..f316670 100644 --- a/api/CalendarContextEventCopy.lua +++ b/api/CalendarContextEventCopy.lua @@ -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 \ No newline at end of file +function CalendarContextEventCopy(monthOffset, day, index) end diff --git a/api/CalendarContextEventGetCalendarType.lua b/api/CalendarContextEventGetCalendarType.lua index 5204252..dfa2070 100644 --- a/api/CalendarContextEventGetCalendarType.lua +++ b/api/CalendarContextEventGetCalendarType.lua @@ -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 \ No newline at end of file +function CalendarContextEventGetCalendarType(monthOffset, day, index) end diff --git a/api/CalendarContextEventPaste.lua b/api/CalendarContextEventPaste.lua index 2870f92..0b368ac 100644 --- a/api/CalendarContextEventPaste.lua +++ b/api/CalendarContextEventPaste.lua @@ -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 \ No newline at end of file +function CalendarContextEventPaste(monthOffset, day) end diff --git a/api/CalendarContextEventRemove.lua b/api/CalendarContextEventRemove.lua index 4bab186..f298d04 100644 --- a/api/CalendarContextEventRemove.lua +++ b/api/CalendarContextEventRemove.lua @@ -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 \ No newline at end of file +function CalendarContextEventRemove(monthOffset, day, index) end diff --git a/api/CalendarContextEventSignUp.lua b/api/CalendarContextEventSignUp.lua index b9d9430..f4b909f 100644 --- a/api/CalendarContextEventSignUp.lua +++ b/api/CalendarContextEventSignUp.lua @@ -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 \ No newline at end of file +function CalendarContextEventSignUp(monthOffset, day, index) end diff --git a/api/CalendarContextGetEventIndex.lua b/api/CalendarContextGetEventIndex.lua index 8b584e1..2f9ed6c 100644 --- a/api/CalendarContextGetEventIndex.lua +++ b/api/CalendarContextGetEventIndex.lua @@ -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 diff --git a/api/CalendarContextInviteAvailable.lua b/api/CalendarContextInviteAvailable.lua index ffad1c6..b456ee2 100644 --- a/api/CalendarContextInviteAvailable.lua +++ b/api/CalendarContextInviteAvailable.lua @@ -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 \ No newline at end of file +function CalendarContextInviteAvailable(monthOffset, day, index) end diff --git a/api/CalendarContextInviteDecline.lua b/api/CalendarContextInviteDecline.lua index e7692b3..cdda299 100644 --- a/api/CalendarContextInviteDecline.lua +++ b/api/CalendarContextInviteDecline.lua @@ -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 \ No newline at end of file +function CalendarContextInviteDecline(monthOffset, day, index) end diff --git a/api/CalendarContextInviteIsPending.lua b/api/CalendarContextInviteIsPending.lua index 8fcabbb..998977b 100644 --- a/api/CalendarContextInviteIsPending.lua +++ b/api/CalendarContextInviteIsPending.lua @@ -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 \ No newline at end of file +function CalendarContextInviteIsPending(monthOffset, day, index) end