Refactor calendar context functions to improve documentation clarity and parameter usage

api/CalendarContextInviteModeratorStatus.lua

@@ -1,15 +1,13 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset CalendarContextSelectEvent 
+---@alias modStatus #The player's level of authority for the event, or "" if not applicable
----@param -1  
+---| "MODERATOR" The player has been granted moderator status for the event
----@param 0  
+---| "CREATOR" The player is the original creator of the event
----@param 1  
+
----@param nil CalendarContextSelectEvent 
+---@param monthOffset monthOffset
 ---@param day number
 ---@param index number
----@return MODERATOR modStatus 
+---@return modStatus modStatus
----@return  CREATOR 
----@return  MODERATOR 
 ---Returns the player's moderator status for an event
-function CalendarContextInviteModeratorStatus(monthOffset, -1, 0, 1, nil, day, index) end
+function CalendarContextInviteModeratorStatus(monthOffset, day, index) end

api/CalendarContextInviteRemove.lua

@@ -1,12 +1,8 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset CalendarContextSelectEvent 
+---@param monthOffset monthOffset
----@param -1  
----@param 0  
----@param 1  
----@param nil CalendarContextSelectEvent 
 ---@param day number
 ---@param index number
 ---Removes an invitation from the player's calendar or removes the player from a guild event's signup list
-function CalendarContextInviteRemove(monthOffset, -1, 0, 1, nil, day, index) end
+function CalendarContextInviteRemove(monthOffset, day, index) end

api/CalendarContextInviteStatus.lua

@@ -1,21 +1,19 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset CalendarContextSelectEvent 
+---@alias inviteStatus
----@param -1  
+---| 1 Invited (also used for non-invitation/non-signup events)
----@param 0  
+---| 2 Accepted
----@param 1  
+---| 3 Declined
----@param nil CalendarContextSelectEvent 
+---| 4 Confirmed
+---| 5 Out
+---| 6 Standby
+---| 7 Signed up
+---| 8 Not signed up
+
+---@param monthOffset monthOffset
 ---@param day number
 ---@param index number
----@return 8 inviteStatus 
+---@return inviteStatus
----@return  1 
----@return  2 
----@return  3 
----@return  4 
----@return  5 
----@return  6 
----@return  7 
----@return  8 
 ---Returns the player's invite status for an event
-function CalendarContextInviteStatus(monthOffset, -1, 0, 1, nil, day, index) end
+function CalendarContextInviteStatus(monthOffset, day, index) end

api/CalendarContextInviteType.lua

@@ -1,15 +1,13 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset CalendarContextSelectEvent 
+---@alias inviteType
----@param -1  
+---| 1 Characters can only be explicitly invited to the event (or event is a non-invite/non-signup event)
----@param 0  
+---| 2 Event is visible to the player's entire guild; guild members can sign up and other characters can be explicitly invited
----@param 1  
+
----@param nil CalendarContextSelectEvent 
+---@param monthOffset monthOffset
 ---@param day number
 ---@param index number
----@return 2 inviteType 
+---@return inviteType
----@return  1 
----@return  2 
 ---Returns the invite type for an event
-function CalendarContextInviteType(monthOffset, -1, 0, 1, nil, day, index) end
+function CalendarContextInviteType(monthOffset, day, index) end

api/CalendarContextSelectEvent.lua

@@ -1,12 +1,11 @@
 ---@diagnostic disable: missing-return, lowercase-global
 ---@meta
 
----@param monthOffset CalendarContextSelectEvent 
+---@param monthOffset monthOffset
----@param -1  
----@param 0  
----@param 1  
----@param nil CalendarContextSelectEvent 
 ---@param day number
 ---@param index number
----Selects an event for use only with other CalendarContext functions. The selection state set 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).
+---Selects an event for use only with other CalendarContext functions. The selection state set by this function is used only by other CalendarContext
-function CalendarContextSelectEvent(monthOffset, -1, 0, 1, nil, day, index) end
+---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 CalendarContextSelectEvent(monthOffset, day, index) end