C_SocialQueue

namespaceavailable in: camelot

Status in wowlua

10 functions: 0 implemented, 3 recorded, 7 guessed. 3 events, 2 of them fired by the emulator on its own.

Functions

function	what it does	status
`GetAllGroups`	Returns the GUIDs of the groups that friends and guild members are queued with. · by wowlua `(allowNonJoinable: boolean, allowNonQueuedGroups: boolean): string[]`	recorded
`GetConfig`	Returns the configuration of the quick join system. · by wowlua `(): SocialQueueConfig?`	recorded
`GetGroupForPlayer`	Returns the GUID of the quick join group the given player is in. · by wowlua `(playerGUID: string): (string?, boolean?)`	guessed
`GetGroupInfo`	Retrieves information about a group in social queue. `(groupGUID: string): (boolean?, number?, boolean?, boolean?, boolean?, boolean?, boolean?, string?)`	guessed
`GetGroupMembers`	Returns the members of a quick join group. · by wowlua `(groupGUID: string): SocialQueuePlayerInfo[]?`	guessed
`GetGroupQueues`	Returns the queues a quick join group is in. · by wowlua `(groupGUID: string): SocialQueueGroupQueueInfo[]?`	guessed
`IsSystemEnabled`	Whether the quick join system is enabled. · by wowlua `(): boolean`	guessed
`IsSystemSupported`	Whether the quick join system is supported on this client. · by wowlua `(): boolean`	recorded
`RequestToJoin`	Requests to join a quick join group in the given roles. Returns whether the request was sent. · by wowlua `(groupGUID: string, applyAsTank: boolean, applyAsHealer: boolean, applyAsDamage: boolean): boolean`	guessed
`SignalToastDisplayed`	Notifies the client that a quick join toast was shown for a group. · by wowlua `(groupGUID: string, priority: number)`	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
`SOCIAL_QUEUE_CONFIG_UPDATED`	`no payload`	implemented
`SOCIAL_QUEUE_UPDATE`	`groupGUID: string, numAddedItems: number?`	implemented
`SOCIAL_UI_SOCIAL_QUEUE_SYSTEM_STATUS_UPDATED`	`no payload`	not implemented

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

Structures

SocialQueueConfig · TOASTS_DISABLED, TOAST_DURATION, DELAY_DURATION, QUEUE_MULTIPLIER, PLAYER_MULTIPLIER, PLAYER_FRIEND_VALUE, PLAYER_GUILD_VALUE, THROTTLE_INITIAL_THRESHOLD, THROTTLE_DECAY_TIME, THROTTLE_PRIORITY_SPIKE, THROTTLE_MIN_THRESHOLD, THROTTLE_PVP_PRIORITY_NORMAL, THROTTLE_PVP_PRIORITY_LOW, THROTTLE_PVP_HONOR_THRESHOLD, THROTTLE_LFGLIST_PRIORITY_DEFAULT, THROTTLE_LFGLIST_PRIORITY_ABOVE, THROTTLE_LFGLIST_PRIORITY_BELOW, THROTTLE_LFGLIST_ILVL_SCALING_ABOVE, THROTTLE_LFGLIST_ILVL_SCALING_BELOW, THROTTLE_RF_PRIORITY_ABOVE, THROTTLE_RF_ILVL_SCALING_ABOVE, THROTTLE_DF_MAX_ITEM_LEVEL, THROTTLE_DF_BEST_PRIORITY
SocialQueueGroupInfo · canJoin, numQueues, needTank, needHealer, needDamage, isSoloQueueParty, questSessionActive, leaderGUID
SocialQueueGroupQueueInfo · clientID, eligible, needTank, needHealer, needDamage, isAutoAccept, queueData
SocialQueuePlayerInfo · guid, clubId?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (2 systems, 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.