Returns the player's invite status for an event


See also Calendar functions.

Signature:

inviteStatus = CalendarContextInviteStatus([monthOffset,] day, index)

Arguments:

  • monthOffset - Month containing an event 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
    • nil - Use the event selected by CalendarContextSelectEvent and ignore further arguments

  • day - Day of the month containing an event (number)

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

Returns:

  • inviteStatus - The player's status regarding the event (number)
    • 1 - Invited (also used for non-invitation/non-signup events)
    • 2 - Accepted
    • 3 - Declined
    • 4 - Confirmed
    • 5 - Out
    • 6 - Standby
    • 7 - Signed up
    • 8 - Not signed up