Returns the month, day, and index of the selected calendar event

See also Calendar functions.


monthOffset, day, index = CalendarGetEventIndex()


  • 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)