Refactor calendar context functions to improve documentation clarity and parameter usage

This commit is contained in:
2025-05-18 00:53:16 +02:00
parent 377b3b7aa7
commit e01a681d66
5 changed files with 45 additions and 56 deletions

View File

@@ -1,21 +1,19 @@
---@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 8 inviteStatus
---@return 1
---@return 2
---@return 3
---@return 4
---@return 5
---@return 6
---@return 7
---@return 8
---@alias inviteStatus
---| 1 Invited (also used for non-invitation/non-signup events)
---| 2 Accepted
---| 3 Declined
---| 4 Confirmed
---| 5 Out
---| 6 Standby
---| 7 Signed up
---| 8 Not signed up
---@param monthOffset monthOffset
---@param day number
---@param index number
---@return inviteStatus
---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