Refactor calendar context functions to use parameter aliases for improved clarity
This commit is contained in:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user