Refactor calendar event functions to enhance parameter aliasing and improve documentation clarity
This commit is contained in:
@@ -1,49 +1,27 @@
|
||||
---@diagnostic disable: missing-return, lowercase-global
|
||||
---@meta
|
||||
|
||||
---@return string title
|
||||
---@return string description
|
||||
---@return string creator
|
||||
---@return 5 eventType
|
||||
---@return 1
|
||||
---@return 2
|
||||
---@return 3
|
||||
---@return 4
|
||||
---@return 5
|
||||
---@return number repeatOption
|
||||
---@return number maxSize
|
||||
---@return number textureIndex
|
||||
---@return number weekday
|
||||
---@return number month
|
||||
---@return number day
|
||||
---@return number year
|
||||
---@return number hour
|
||||
---@return number minute
|
||||
---@return number lockoutWeekday
|
||||
---@return number lockoutMonth
|
||||
---@return number lockoutDay
|
||||
---@return number lockoutYear
|
||||
---@return number lockoutHour
|
||||
---@return number lockoutMinute
|
||||
---@return 1nil locked
|
||||
---@return 1nil autoApprove
|
||||
---@return 1nil pendingInvite
|
||||
---@return 8 inviteStatus
|
||||
---@return 1
|
||||
---@return 2
|
||||
---@return 3
|
||||
---@return 4
|
||||
---@return 5
|
||||
---@return 6
|
||||
---@return 7
|
||||
---@return 8
|
||||
---@return 2 inviteType
|
||||
---@return 1
|
||||
---@return 2
|
||||
---@return SYSTEM calendarType
|
||||
---@return GUILD_ANNOUNCEMENT
|
||||
---@return GUILD_EVENT
|
||||
---@return PLAYER
|
||||
---@return SYSTEM
|
||||
---@return string title - Title displayed for the event
|
||||
---@return string description - Descriptive text about the event
|
||||
---@return string creator - Name of the character who created the event
|
||||
---@return eventType eventType - Display style for the event; used in the default UI to determine which icon to show
|
||||
---@return number repeatOption - Index of an event repetition option; currently unused (always 1)
|
||||
---@return number maxSize - Maximum number of invites/signups; currently unused (always 100)
|
||||
---@return number textureIndex - Index of the dungeon or raid instance
|
||||
---@return number weekday - Index of the day of the week on which the event starts (1 = Sunday)
|
||||
---@return number month - Index of the month in which the event starts (1 = January)
|
||||
---@return number day - Day of the month on which the event starts
|
||||
---@return number year - Year in which the event starts (full four-digit year)
|
||||
---@return number hour - Hour part of the event's start time (24-hour clock)
|
||||
---@return number minute - Minute part of the event's start time
|
||||
---@return number lockoutWeekday - Currently unused
|
||||
---@return number lockoutMonth - Currently unused
|
||||
---@return number lockoutDay - Currently unused
|
||||
---@return number lockoutYear - Currently unused
|
||||
---@return number lockoutHour - Currently unused
|
||||
---@return number lockoutMinute - Currently unused
|
||||
---@return inviteStatus inviteStatus - The player's status regarding the event
|
||||
---@return inviteType inviteType - Invitation/announcement type for the event
|
||||
---@return calendarType calendarType - Token identifying the type of event
|
||||
---Returns information about the selected calendar event
|
||||
function CalendarGetEventInfo() end
|
||||
|
||||
Reference in New Issue
Block a user