C_RecentAllies

namespaceavailable in: camelot

Status in wowlua

15 functions: 0 implemented, 3 recorded, 12 guessed. 5 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`CanSetRecentAllyNote`	Whether the player can set a note on the given recent ally. · by wowlua `(characterGUID: string): boolean`	guessed
`GetRecentAllies`	Returns the players the player recently grouped or interacted with. · by wowlua `(): RecentAllyData[]`	guessed
`GetRecentAllyByFullName`	Returns a recent ally by name, or nil when there is none. · by wowlua `(fullCharacterName: string): RecentAllyData?`	guessed
`GetRecentAllyByGUID`	Returns a recent ally by GUID, or nil when there is none. · by wowlua `(characterGUID: string): RecentAllyData?`	guessed
`IsInteractionCategoryFilterSupportedForCurrentGameType`	Whether the recent allies list can be filtered by the given kind of interaction in the current game mode. · by wowlua `(interactionCategoryFilter: RecentAlliesInteractionCategoryFilter): boolean`	recorded
`IsRecentAllyByFullName`	Whether the character with the given full name is one of the player's recent allies. · by wowlua `(fullCharacterName: string): boolean`	guessed
`IsRecentAllyByGUID`	Whether the character with the given GUID is one of the player's recent allies. · by wowlua `(characterGUID: string): boolean`	guessed
`IsRecentAllyDataReady`	Whether the recent allies data has been loaded and can be queried. · by wowlua `(): boolean`	guessed
`IsRecentAllyPinned`	Whether the given recent ally is pinned to the top of the list. · by wowlua `(characterGUID: string): boolean`	guessed
`IsSystemEnabled`	Whether the recent allies system is enabled. · by wowlua `(): boolean`	recorded
`IsSystemSupported`	Whether the recent allies system is supported on this client. · by wowlua `(): boolean`	recorded
`SearchRecentAllies`	Returns the recent allies that match the given search criteria. · by wowlua `(searchInfo: RecentAlliesSearchInfo): RecentAllyData[]`	guessed
`SetRecentAllyNote`	Sets the note shown for the given recent ally. · by wowlua `(characterGUID: string, note: string)`	guessed
`SetRecentAllyPinned`	Pins or unpins the given recent ally. · by wowlua `(characterGUID: string, isPinned: boolean)`	guessed
`TryRequestRecentAlliesData`	Requests the recent allies data from the server if it is not loaded yet. · by wowlua `()`	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
`LET_RECENT_ALLIES_SEE_LOCATION_SETTING_UPDATED`	`no payload`	not implemented
`RECENT_ALLIES_CACHE_UPDATE`	`no payload`	not implemented
`RECENT_ALLIES_DATA_READY`	`no payload`	not implemented
`RECENT_ALLIES_SYSTEM_STATUS_UPDATED`	`no payload`	not implemented
`RECENT_ALLY_DATA_UPDATED`	`characterGUID: string`	not implemented

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

Structures

RecentAlliesSearchInfo · searchText, isOnline, isDND, isAFK, isOffline, interactionCategoryFilters
RecentAllyCharacterData · guid, name, fullName, realmName, level, classID, raceID, sex
RecentAllyData · stateData, characterData, interactionData
RecentAllyInteraction · type, description, timestamp, contextData
RecentAllyInteractionContextData · itemID?, locationName?, activityDifficultyID?, activityDifficultyLevel?
RecentAllyInteractionData · interactions, note?
RecentAllyStateData · isOnline, isDND, isAFK, isConvertedLegacyFriend, pinExpirationDate?, friendRequestSentThisSession, currentLocation?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (RecentAllies system, camelot 1.60.1). Descriptions: written by wowlua where no documentation describes the entry.