12.07.2015 Views

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

SHOW MORE
SHOW LESS
  • No tags were found...

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Chapter 27 ■ API <strong>Reference</strong> 589Returns:numEvents—Number <strong>of</strong> events on the given day (number)CalendarGetNumPendingInvitesReturns the number <strong>of</strong> calendar invitations to which the player has yet torespond.numInvites = CalendarGetNumPendingInvites()Returns:numInvites—Number <strong>of</strong> pending calendar invitations (number)CalendarGetRaidInfoReturns in<strong>for</strong>mation about a raid lockout or scheduled raid reset event.title, calendarType, raidID, hour, minute, difficulty = iCalendarGetRaidInfo(monthOffset, day, index)In<strong>for</strong>mation can only be retrieved <strong>for</strong> events which might be visible in thecalendar’s current month—i.e. those in the current month as well as those in(roughly) the last week <strong>of</strong> the previous month <strong>and</strong> (roughly) the first twoweeks <strong>of</strong> the following month. To reliably retrieve in<strong>for</strong>mation <strong>for</strong> eventsoutside the calendar’s current month, first change the calendar’s month withCalendarSetMonth.Arguments:monthOffset—Month to query relative to the calendar’s currently displayedmonth (i.e. 0 <strong>for</strong> current month, 1 <strong>for</strong> next month, -1 <strong>for</strong> previous month)(number)day—Day <strong>of</strong> the month to query (number)index—Index <strong>of</strong> an event on the given day (from 1 to CalendarGetNumDayEvents()) (number)Returns:title—Title displayed <strong>for</strong> the event (number)calendarType—Token identifying the type <strong>of</strong> event (string)RAID_LOCKOUT—Indicates when one <strong>of</strong> the player’s saved instances resetsRAID_RESET—Indicates scheduled reset times <strong>for</strong> major raid instancesraidID—ID number <strong>of</strong> the instance to which the player is saved, or 0 if notapplicable (number)hour—Hour part <strong>of</strong> the time at which the instance resets (on a 24-hour clock)(number)minute—Minute part <strong>of</strong> the time at which the instance resets (number)difficulty—Difficulty <strong>of</strong> the dungeon or raid instance associated with theevent (number)1—Normal2—HeroicCalendarGetWeekdayNamesReturns a list <strong>of</strong> localized weekday names.... = CalendarGetWeekdayNames()

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!