WoW:API CalendarGetDay: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(New page: {{wowapi}} __NOTOC__ Retrieve information about the specified calendar day. pendingInviteIndex, calendarType, eventType, dayTexture = CalendarGetDay(monthOffset, day) == Arguments == ...)
 
(removedapi)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
 
{{removedapi|≤ 3.1.3}}
Retrieve information about the specified calendar day.
Retrieve information about the specified calendar day.
  pendingInviteIndex, calendarType, eventType, dayTexture = CalendarGetDay(monthOffset, day)
  pendingInviteIndex, calendarType, eventType, dayTexture = CalendarGetDay(monthOffset, day)

Revision as of 23:11, 30 July 2009

WoW API < CalendarGetDay

Retrieve information about the specified calendar day.

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


Arguments

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


Returns

pendingInviteIndex, calendarType, eventType, dayTexture
pendingInviteIndex
Number - See the below table
calendarType
String - One of "PLAYER", "GUILD", "ARENA", "HOLIDAY"
eventType
Number - See the below table
dayTexture
String - Unknown

Details

These tables have been extacted 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;

eventType

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