Returns the month, day, and index of the event selection used only for CalendarContext functions. The selection state referenced by this function is used only by other CalendarContext functions; other calendar event functions use the selection state set by CalendarOpenEvent, CalendarNewEvent, CalendarNewGuildEvent, or CalendarNewGuildAnnouncement (if they use a selection state at all).

Used in the default UI to implement the calendar's context menu (on right-click).


See also Calendar functions.

Signature:

monthOffset, day, index = CalendarContextGetEventIndex()

Returns:

  • monthOffset - Month relative to the calendar's currently displayed month (number)

    • -1 - Month preceding the calendar's current month
    • 0 - The calendar's current month (i.e. same month as CalendarGetMonth())
    • 1 - Month after the calendar's current month

  • day - Day of the month (number)

  • index - Index of the event on the given day (from 1 to CalendarGetNumDayEvents()) (number)