C_Calendar.GetMonthInfo

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
mainline  cata  vanilla
Links
GitHub  Globe  Townlong Yak  Blizzard Docs  /api
Patch
Added in 8.0.1 / 2.5.4 / 1.14.3

Returns information about the calendar month by offset.

monthInfo = C_Calendar.GetMonthInfo([offsetMonths])

Arguments

offsetMonths

number? = 0 - Offset in months from the currently selected Calendar month, positive numbers indicating future months.

Returns

monthInfo

structure - CalendarMonthInfo

Field	Type	Description
month	number	Month index (1-12)
year	number	Year at the offset date (2004+)
numDays	number	Number of days in the month (28-31)
firstWeekday	number	Weekday on which the month begins (1 = Sunday, 2 = Monday, ..., 7 = Saturday)

Details

• This function returns information based on the currently selected calendar month (per C_Calendar.SetMonth). Prior to opening the calendar for the first time in a given session, this is set to C_Calendar.GetMinDate (i.e. November 2004).

Patch changes

• Patch 8.0.1 (2018-07-17): Moved to C_Calendar.GetMonthInfo.
  
• Patch 3.0.2 (2008-10-14): Added as CalendarGetMonth.