WoW API: CalendarGetDay

From AddOn Studio
Revision as of 04:45, 15 August 2023 by Move page script (talk | contribs) (Move page script moved page API CalendarGetDay to API CalendarGetDay without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

WoW API < CalendarGetDay

Retrieve information about the specified calendar day.

local pendingInviteIndex, calendarType, eventType, dayTexture =
  CalendarGetDay(monthOffset, day)

Arguments[edit]

  • monthOffset (number) - The number of months to offset from today
  • day (number) - The number of days to offset from today

Returns[edit]

  • pendingInviteIndex (number) - See the below table
  • calendarType (string) - One of "PLAYER", "GUILD", "ARENA", "HOLIDAY"
  • eventType (number) - See the below table
  • dayTexture (string) - Unknown

Details[edit]

These tables have been extracted from the Beta UI code to give details on the above return values:

pendingInviteIndex

CALENDAR_INVITESTATUS_INVITED      = 1
CALENDAR_INVITESTATUS_ACCEPTED     = 2
CALENDAR_INVITESTATUS_DECLINED     = 3
CALENDAR_INVITESTATUS_CONFIRMED    = 4
CALENDAR_INVITESTATUS_OUT          = 5
CALENDAR_INVITESTATUS_STANDBY      = 6
CALENDAR_INVITESTATUS_SIGNEDUP     = 7
CALENDAR_INVITESTATUS_NOT_SIGNEDUP = 8

eventType

CALENDAR_EVENTTYPE_RAID	= 1;
CALENDAR_EVENTTYPE_DUNGEON	= 2;
CALENDAR_EVENTTYPE_PVP		= 3;
CALENDAR_EVENTTYPE_MEETING	= 4;
CALENDAR_EVENTTYPE_OTHER	= 5;