C_Calendar

namespaceavailable in: camelot

Status in wowlua

90 functions: 6 implemented, 1 recorded, 83 guessed. 13 events, 1 of them fired by the emulator on its own.

Functions

function	what it does	status
`AddEvent`	Saves the new event currently being created to the server. `()`	guessed
`AreNamesReady`	Whether the calendar's player names have been loaded. · by wowlua `(): boolean`	guessed
`CanAddEvent`	Returns whether the player can add an event. `(): boolean`	guessed
`CanSendInvite`	Returns whether the player can send invites. `(): boolean`	guessed
`CloseEvent`	Closes the selected event without saving it. `()`	guessed
`ContextMenuEventCanComplain`	Returns whether the player can report the event as spam. `(offsetMonths: number, monthDay: number, eventIndex: number): boolean`	guessed
`ContextMenuEventCanEdit`	Returns whether the player can edit the event. `(offsetMonths: number, monthDay: number, eventIndex: number): boolean`	guessed
`ContextMenuEventCanRemove`	Returns whether the player can remove the event. `(offsetMonths: number, monthDay: number, eventIndex: number): boolean`	guessed
`ContextMenuEventClipboard`	Whether the calendar has a copied event to paste. · by wowlua `(): boolean`	guessed
`ContextMenuEventCopy`	Copies the event to the clipboard. `()`	guessed
`ContextMenuEventGetCalendarType`	Returns the calendar type of the event selected in the calendar's context menu, such as `"PLAYER"` or `"GUILD_EVENT"`. · by wowlua `(): string?`	guessed
`ContextMenuEventPaste`	Pastes the clipboard event to the date. `(offsetMonths: number, monthDay: number)`	guessed
`ContextMenuEventRemove`	Deletes the event. `()`	guessed
`ContextMenuEventSignUp`	Signs up for the event selected in the calendar's context menu. · by wowlua `()`	guessed
`ContextMenuGetEventIndex`	Returns the month offset, day and index of the event selected in the calendar's context menu. · by wowlua `(): CalendarEventIndexInfo?`	guessed
`ContextMenuInviteAvailable`	Accepts the invitation to the event. `()`	guessed
`ContextMenuInviteDecline`	Declines the invitation to the event. `()`	guessed
`ContextMenuInviteRemove`	Removes the event from the calendar. `()`	guessed
`ContextMenuInviteTentative`	Answers the invite to the event selected in the calendar's context menu as tentative. · by wowlua `()`	guessed
`ContextMenuSelectEvent`	Selects an event for the calendar's context menu. · by wowlua `(offsetMonths: number, monthDay: number, eventIndex: number)`	guessed
`CreateCommunitySignUpEvent`	Starts creating a new community event that members can sign up for. · by wowlua `()`	guessed
`CreateGuildAnnouncementEvent`	Starts creating a new guild announcement event. · by wowlua `()`	guessed
`CreateGuildSignUpEvent`	Starts creating a new guild event that members can sign up for. · by wowlua `()`	guessed
`CreatePlayerEvent`	Creates a new calendar event candidate for the player. `()`	guessed
`EventAvailable`	Accepts the invitation to the currently open event. `()`	guessed
`EventCanEdit`	Returns whether the event can be edited. `(): boolean`	guessed
`EventClearAutoApprove`	Turns off automatic confirmations. `()`	guessed
`EventClearLocked`	Unlocks the event. `()`	guessed
`EventClearModerator`	Removes the moderator status of an invitee of the open event. · by wowlua `(inviteIndex: number)`	guessed
`EventDecline`	Declines the invitation to the currently open event. `()`	guessed
`EventGetCalendarType`	Returns the calendar type of the open event, such as `"PLAYER"` or `"GUILD_EVENT"`. · by wowlua `(): string?`	guessed
`EventGetClubId`	Returns the ID of the community the open event belongs to, or nil. · by wowlua `(): ClubId?`	guessed
`EventGetInvite`	Returns status information for an invitee for the currently opened event. `(eventIndex: number): CalendarEventInviteInfo?`	guessed
`EventGetInviteResponseTime`	Returns when an invitee answered the open event's invite. · by wowlua `(eventIndex: number): CalendarTime?`	guessed
`EventGetInviteSortCriterion`	Returns how the open event's invite list is sorted, and whether the order is reversed. · by wowlua `(): (string, boolean)`	guessed
`EventGetSelectedInvite`	Returns the index of the invitee selected in the open event's invite list, or nil. · by wowlua `(): number?`	guessed
`EventGetStatusOptions`	Returns the statuses that can be chosen for a calendar event. · by wowlua `(eventIndex: number): CalendarEventStatusOption[]`	guessed
`EventGetTextures`	Returns the textures, such as dungeons or raids, that an event of the type can show. · by wowlua `(eventType: CalendarEventType): CalendarEventTextureInfo[]`	guessed
`EventGetTypes`	Returns the names of the calendar event types. · by wowlua `(): string[]`	guessed
`EventGetTypesDisplayOrdered`	Returns the calendar event types in the order the calendar shows them. · by wowlua `(): CalendarEventTypeDisplayInfo[]`	guessed
`EventHasPendingInvite`	Returns whether the player has an unanswered invitation to the currently selected event. `(): boolean`	guessed
`EventHaveSettingsChanged`	Returns whether the currently opened event has been modified. `(): boolean`	guessed
`EventInvite`	Invites a player to the currently selected event. `(name: string)`	guessed
`EventRemoveInvite`	Removes an invitee from the open event. · by wowlua `(inviteIndex: number)`	guessed
`EventRemoveInviteByGuid`	Removes the invitee with the given GUID from the open event. · by wowlua `(guid: string)`	guessed
`EventSelectInvite`	Selects an invitee in the open event's invite list. · by wowlua `(inviteIndex: number)`	guessed
`EventSetAutoApprove`	Sets the open event to approve sign-ups automatically. · by wowlua `()`	guessed
`EventSetClubId`	Sets the community the open event belongs to. · by wowlua `(clubId: ClubId?)`	guessed
`EventSetDate`	Sets the date for the currently opened event. `(month: number, monthDay: number, year: number)`	guessed
`EventSetDescription`	Sets the open event's description. · by wowlua `(description: string)`	guessed
`EventSetInviteStatus`	Sets the status of an invitee of the open event. · by wowlua `(eventIndex: number, status: CalendarStatus)`	guessed
`EventSetLocked`	Locks the open event, so invitees can no longer change their answer. · by wowlua `()`	guessed
`EventSetModerator`	Makes an invitee of the open event a moderator. · by wowlua `(inviteIndex: number)`	guessed
`EventSetTextureID`	Sets the texture, such as a dungeon or raid, of the open event. · by wowlua `(textureIndex: number)`	guessed
`EventSetTime`	Sets the time for the currently opened event. `(hour: number, minute: number)`	guessed
`EventSetTitle`	Sets the title for the currently opened event. `(title: string)`	guessed
`EventSetType`	Sets the event type for the current calendar event. `(typeIndex: CalendarEventType)`	guessed
`EventSignUp`	Signs up for the open event. · by wowlua `()`	guessed
`EventSortInvites`	Sorts the open event's invite list. · by wowlua `(criterion: string, reverse: boolean)`	guessed
`EventTentative`	Answers the open event's invite as tentative. · by wowlua `()`	guessed
`GetClubCalendarEvents`	Returns a community's calendar events between two times. · by wowlua `(clubId: ClubId, startTime: CalendarTime, endTime: CalendarTime): CalendarDayEvent[]`	guessed
`GetDayEvent`	Returns information about the specified calendar event. `(monthOffset: number, monthDay: number, index: number): CalendarDayEvent?`	implemented
`GetDefaultGuildFilter`	Returns the default level range and rank for inviting guild members to an event. · by wowlua `(): CalendarGuildFilterInfo`	implemented
`GetEventIndex`	Returns the month offset, day and index of the open event. · by wowlua `(): CalendarEventIndexInfo?`	guessed
`GetEventIndexInfo`	Returns the month offset, day and index of the event with the given ID. · by wowlua `(eventID: CalendarEventID, monthOffset: number?, monthDay: number?): CalendarEventIndexInfo?`	guessed
`GetEventInfo`	Returns info for a calendar event. `(): CalendarEventInfo?`	guessed
`GetFirstPendingInvite`	Returns the index of the first event on a day that the player has not answered yet, or nil. · by wowlua `(offsetMonths: number, monthDay: number): number?`	guessed
`GetGuildEventInfo`	Returns information about one of the guild's upcoming events. · by wowlua `(index: number): CalendarGuildEventInfo?`	guessed
`GetGuildEventSelectionInfo`	Returns the month offset, day and index of one of the guild's upcoming events. · by wowlua `(index: number): CalendarEventIndexInfo?`	guessed
`GetHolidayInfo`	Returns seasonal holiday info. `(monthOffset: number, monthDay: number, index: number): CalendarHolidayInfo?`	guessed
`GetMaxCreateDate`	Returns the last day supported by the Calendar API. `(): CalendarTime`	guessed
`GetMinDate`	Returns the first day supported by the Calendar API. `(): CalendarTime`	guessed
`GetMonthInfo`	Returns information about the calendar month by offset. `(offsetMonths: number): CalendarMonthInfo`	implemented
`GetNextClubId`	Returns the community the next created calendar event will belong to, or nil. · by wowlua `(): ClubId?`	guessed
`GetNumDayEvents`	Returns the number of events for a given day/month offset. `(offsetMonths: number, monthDay: number): number`	implemented
`GetNumGuildEvents`	Returns how many upcoming events the guild has. · by wowlua `(): number`	guessed
`GetNumInvites`	Returns the number of invitees for the currently opened event. `(): number`	guessed
`GetNumPendingInvites`	Returns how many calendar invites the player has not answered yet. · by wowlua `(): number`	recorded
`GetRaidInfo`	Returns information about a raid lockout shown on the calendar. · by wowlua `(offsetMonths: number, monthDay: number, eventIndex: number): CalendarRaidInfo?`	guessed
`IsActionPending`	Whether the calendar is waiting for the server to answer an action. · by wowlua `(): boolean`	guessed
`IsEventOpen`	Whether a calendar event is open for viewing or editing. · by wowlua `(): boolean`	guessed
`MassInviteCommunity`	Invites the community's members in a level range, and up to a rank, to the open event. · by wowlua `(clubId: ClubId, minLevel: number, maxLevel: number, maxRankOrder: number?)`	guessed
`MassInviteGuild`	Invites the guild's members in a level range, and up to a rank, to the open event. · by wowlua `(minLevel: number, maxLevel: number, maxRankOrder: number)`	guessed
`OpenCalendar`	Requests calendar information from the server. Does not open the calendar frame. `()`	guessed
`OpenEvent`	Establishes an event for future calendar API calls `(offsetMonths: number, monthDay: number, index: number): boolean`	guessed
`RemoveEvent`	Removes the selected event from the calendar (invitees only). `()`	guessed
`SetAbsMonth`	Sets the reference month and year for functions which use a month offset. `(month: number, year: number)`	implemented
`SetMonth`	Moves the month the calendar shows by the given number of months. · by wowlua `(offsetMonths: number)`	implemented
`SetNextClubId`	Sets the community the next created calendar event will belong to. · by wowlua `(clubId: ClubId?)`	guessed
`UpdateEvent`	Saves the selected event. `()`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`CALENDAR_ACTION_PENDING`	`pending: boolean`	implemented
`CALENDAR_CLOSE_EVENT`	`no payload`	not implemented
`CALENDAR_EVENT_ALARM`	`title: string, hour: number, minute: number`	not implemented
`CALENDAR_NEW_EVENT`	`isCopy: boolean`	not implemented
`CALENDAR_OPEN_EVENT`	`calendarType: string`	not implemented
`CALENDAR_UPDATE_ERROR`	`errorReason: string`	not implemented
`CALENDAR_UPDATE_ERROR_WITH_COUNT`	`errorReason: string, count: number`	not implemented
`CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME`	`errorReason: string, playerName: string`	not implemented
`CALENDAR_UPDATE_EVENT`	`no payload`	not implemented
`CALENDAR_UPDATE_EVENT_LIST`	`no payload`	not implemented
`CALENDAR_UPDATE_GUILD_EVENTS`	`no payload`	not implemented
`CALENDAR_UPDATE_INVITE_LIST`	`hasCompleteList: boolean?`	not implemented
`CALENDAR_UPDATE_PENDING_INVITES`	`no payload`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("CALENDAR_CLOSE_EVENT").

Structures

CalendarDayEvent · eventID, title, isCustomTitle, startTime, endTime, calendarType, sequenceType, eventType, iconTexture?, modStatus, inviteStatus, invitedBy, difficulty, inviteType, sequenceIndex, numSequenceDays, difficultyName, dontDisplayBanner, dontDisplayEnd, clubID, isLocked
CalendarEventIndexInfo · offsetMonths, monthDay, eventIndex
CalendarEventInfo · title, description, creator?, eventType, repeatOption, maxSize, textureIndex?, time, lockoutTime, isLocked, isAutoApprove, hasPendingInvite, inviteStatus?, inviteType?, calendarType, communityName?
CalendarEventInviteInfo · name?, level, className?, classFilename?, inviteStatus?, modStatus?, inviteIsMine, type, notes, classID?, guid
CalendarEventStatusOption · status, statusString
CalendarEventTextureInfo · title, iconTexture, expansionLevel, difficultyId?, mapId?, isLfr?
CalendarEventTypeDisplayInfo · displayString, eventType
CalendarGuildEventInfo · eventID, year, month, monthDay, weekday, hour, minute, eventType, title, calendarType, texture, inviteStatus, clubID
CalendarGuildFilterInfo · minLevel, maxLevel, rank
CalendarHolidayInfo · name, description, texture, startTime?, endTime?
CalendarMonthInfo · month, year, numDays, firstWeekday
CalendarRaidInfo · name, calendarType, raidID, time, difficulty, difficultyName?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Calendar system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.