Refactor calendar event functions to enhance parameter aliasing and improve documentation clarity

This commit is contained in:
2025-05-18 01:07:24 +02:00
parent 11f27b18de
commit ff89e99749
10 changed files with 88 additions and 151 deletions

View File

@@ -1,42 +1,38 @@
---@diagnostic disable: missing-return, lowercase-global
---@meta
---@alias month
---| 1 January
---| 2 February
---| 3 March
---| 4 April
---| 5 May
---| 6 June
---| 7 July
---| 8 August
---| 9 September
---| 10 October
---| 11 November
---| 12 December
---@alias weekday
---| 1 Sunday
---| 2 Monday
---| 3 Tuesday
---| 4 Wednesday
---| 5 Thursday
---| 6 Friday
---| 7 Saturday
---@param eventIndex number
---@return 12 month
---@return 1
---@return 2
---@return 3
---@return 4
---@return 5
---@return 6
---@return 7
---@return 8
---@return 9
---@return 10
---@return 11
---@return 12
---@return month month
---@return number day
---@return 7 weekday
---@return 1
---@return 2
---@return 3
---@return 4
---@return 5
---@return 6
---@return 7
---@return weekday weekday
---@return number hour
---@return number minute
---@return 6 eventType
---@return 1
---@return 2
---@return 3
---@return 4
---@return 5
---@return 6
---@return eventType eventType
---@return string title
---@return GUILD_EVENT calendarType
---@return GUILD_ANNOUNCEMENT
---@return GUILD_EVENT
---@return calendarType calendarType
---@return string textureName
---Returns information about a calendar guild-event
function CalendarGetGuildEventInfo(eventIndex) end