C_PartyInfo
namespaceavailable in: camelotStatus in wowlua
55 functions: 9 implemented, 4 recorded, 42 guessed. 33 events, 11 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
AllowedToDoPartyConversion | Whether the player may convert the group between party and raid. · by wowlua(toRaid: boolean): boolean | recorded |
CanFormCrossFactionParties | Whether the player can form groups with players of the other faction. · by wowlua(): boolean | implemented |
CanInvite | Whether the player can invite others to the group: when alone or leading the group. · by wowlua(): boolean | guessed |
CanStartInstanceAbandonVote | Returns whether it's possible to start a vote at this time(): boolean | guessed |
ChallengeModeRestrictionsActive | Whether Mythic+ (challenge mode) restrictions are active for the group. · by wowlua(): boolean | guessed |
ConfirmConvertToRaid | Immediately convert to raid with no regard for potentially destructive actions.() | guessed |
ConfirmInviteTravelPass | Confirms sending a group invite to a Battle.net friend. · by wowlua(targetName: string, targetGUID: string) | guessed |
ConfirmInviteUnit | Immediately invites the named unit to a party, with no regard for potentially destructive actions.(targetName: string) | guessed |
ConfirmLeaveParty | Immediately leave the party with no regard for potentially destructive actions.(category: number?) | guessed |
ConfirmReadyCheck | Responds to a ready check.(isReady: boolean) | guessed |
ConfirmRequestInviteFromUnit | Immediately request an invite into the target party, this is the confirmation function to call after RequestInviteFromUnit, or if you would like to skip the confirmation process.(targetName: string, tank: boolean?, healer: boolean?, dps: boolean?) | guessed |
ConvertToParty | Converts a raid group with 5 or less members to a party.() | implemented |
ConvertToRaid | Usually this will convert to raid immediately. In some cases (e.g. PartySync) the user will be prompted to confirm converting to raid, because it's potentially destructive.() | implemented |
DelveTeleportOut | Teleports the group out of the current delve. · by wowlua() | guessed |
DemoteAssistant | Demotes player from assistant status. Requires raid leadership.(name: string, exactNameMatch: boolean?) | guessed |
DoCountdown | Countdown timer sent to all party members. Has no effect if not in a group/instance.(seconds: number): boolean | guessed |
DoReadyCheck | Initiates a ready check.() | guessed |
GetActiveCategories | Returns the group categories the player is currently in, or nil when there are none. · by wowlua(): number[]? | guessed |
GetAvailableLootMethods | Returns the loot methods the group can choose from. · by wowlua(): LootMethod[] | guessed |
GetInstanceAbandonShutdownTime | Returns the total duration of the shutdown time after a vote passes and how much time is left before it ends(): (number, number) | guessed |
GetInstanceAbandonVoteCooldownTime | Returns the total duration of the abandon vote cooldown and how much time is left before it ends(): (number?, number?) | guessed |
GetInstanceAbandonVoteRequirements | Returns values controlling the vote(): (number, number) | guessed |
GetInstanceAbandonVoteResponse | Returns how the player voted, nil for not yet(): boolean? | guessed |
GetInstanceAbandonVoteTime | Returns the total duration of the vote and how much time is left before it ends(): (number, number) | recorded |
GetInviteConfirmationInvalidQueues | Returns the queues the player would leave by accepting the given group invite. · by wowlua(inviteGUID: string): QueueSpecificInfo[]? | guessed |
GetInviteReferralInfo | Returns info for Quick join invites.(inviteGUID: string): (string?, string?, PartyRequestJoinRelation?, boolean?, ClubId?) | guessed |
GetLootMethod | Returns the current loot method.(): (LootMethod, number?, number?) | implemented |
GetLootMethodStyle | Returns the style of loot methods the game uses. · by wowlua(): LootMethodStyles | guessed |
GetMinItemLevel | Returns the lowest average item level in the group and the name of the member who has it; out of a group, the player's own. · by wowlua(avgItemLevelCategory: AvgItemLevelCategories): (number, string) | guessed |
GetMinLevel | Returns the lowest character level in the group; out of a group, the player's own. · by wowlua(category: number?): number | guessed |
GetNumInstanceAbandonGroupVoteResponses | Returns how many players have voted either way(): number | guessed |
GetRestrictPings | Returns who in the group is allowed to send pings. · by wowlua(): RestrictPingsTo | guessed |
InviteUnit | Invites a player to your group.(targetName: string) | implemented |
IsChallengeModeActive | Whether a Mythic+ (challenge mode) run is active for the group. · by wowlua(): boolean | guessed |
IsChallengeModeKeystoneOwner | Whether the player owns the keystone of the group's Mythic+ run. · by wowlua(): boolean | guessed |
IsCrossFactionParty | Whether the group contains players of both factions. · by wowlua(category: number?): boolean | guessed |
IsDelveComplete | Whether the group's current delve is complete. · by wowlua(): boolean | guessed |
IsDelveInProgress | Whether the group is in a delve that is in progress. · by wowlua(): boolean | guessed |
IsGUIDInGroup | Whether the given GUID belongs to the player or a member of the player's group. · by wowlua(guid: string, category: number?): boolean | guessed |
IsLootMethodAvailable | Whether the given loot method can be chosen for the group. · by wowlua(method: LootMethod): boolean | guessed |
IsPartyFull | Whether the player's party has no free spots left. · by wowlua(category: number?): boolean | implemented |
IsPartyInJailersTower | Whether the group is in Torghast, Tower of the Damned. · by wowlua(): boolean | guessed |
IsPartyWalkIn | Whether the group is in a walk-in scenario. · by wowlua(): boolean | guessed |
IsRaidListEnabled | Whether the raid list is enabled. · by wowlua(): boolean | recorded |
IsRaidListSupported | Whether the game supports the raid list. · by wowlua(): boolean | recorded |
LeaveParty | Leaves the group.(category: number?) | implemented |
PromoteToAssistant | Promotes player to assistant status. Requires raid leadership.(name: string, exactNameMatch: boolean?) | guessed |
PromoteToLeader | Promotes a unit to group leader.(name: string, exactNameMatch: boolean?) | implemented |
RequestInviteFromUnit | Attempt to request an invite into the target party, requires confirmation in some cases (e.g. there is a party sync in progress).(targetName: string, tank: boolean?, healer: boolean?, dps: boolean?) | guessed |
SetEveryoneIsAssistant | Sets whether every member of the raid is an assistant. Returns whether the change was made. · by wowlua(isAssistant: boolean): boolean | guessed |
SetInstanceAbandonVoteResponse | Vote on whether to abandon instance, true for yes, false for no(response: boolean) | guessed |
SetLootMethod | Sets the current loot method.(method: LootMethod, lootMaster: string?): boolean | guessed |
SetRestrictPings | Sets who in the group is allowed to send pings. · by wowlua(restrictTo: RestrictPingsTo) | guessed |
StartInstanceAbandonVote | Start the vote() | guessed |
UninviteUnit | Removes a player from the group if you're the leader, or initiates a vote to kick.(name: string, reason: string?, exactNameMatch: boolean?) | implemented |
"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 |
|---|---|---|
BNET_REQUEST_INVITE_CONFIRMATION | gameAccountID: number, questSessionActive: boolean, tank: boolean, healer: boolean, dps: boolean | not implemented |
CONVERT_TO_RAID_CONFIRMATION | no payload | not implemented |
ENTERED_DIFFERENT_INSTANCE_FROM_PARTY | no payload | not implemented |
GROUP_FORMED | category: number, partyGUID: string | implemented |
GROUP_INVITE_CONFIRMATION | no payload | not implemented |
GROUP_JOINED | category: number, partyGUID: string | implemented |
GROUP_LEFT | category: number, partyGUID: string | implemented |
GROUP_ROSTER_UPDATE | no payload | implemented |
INSTANCE_ABANDON_VOTE_FINISHED | votePassed: boolean | not implemented |
INSTANCE_ABANDON_VOTE_STARTED | no payload | not implemented |
INSTANCE_ABANDON_VOTE_UPDATED | no payload | not implemented |
INSTANCE_BOOT_START | no payload | not implemented |
INSTANCE_BOOT_STOP | no payload | not implemented |
INSTANCE_GROUP_SIZE_CHANGED | no payload | not implemented |
INVITE_TO_PARTY_CONFIRMATION | targetName: string, willConvertToRaid: boolean, questSessionActive: boolean | not implemented |
INVITE_TRAVEL_PASS_CONFIRMATION | targetName: string, targetGUID: string, willConvertToRaid: boolean, questSessionActive: boolean | not implemented |
LEAVE_PARTY_CONFIRMATION | reason: LeavePartyConfirmReason | not implemented |
PARTY_INVITE_CANCEL | no payload | not implemented |
PARTY_INVITE_REQUEST | name: string, isTank: boolean, isHealer: boolean, isDamage: boolean, isNativeRealm: boolean, allowMultipleRoles: boolean, inviterGUID: string, questSessionActive: boolean | not implemented |
PARTY_LEADER_CHANGED | no payload | implemented |
PARTY_LFG_RESTRICTED | no payload | implemented |
PARTY_LOOT_METHOD_CHANGED | no payload | implemented |
PARTY_MEMBER_DISABLE | unitTarget: string | implemented |
PARTY_MEMBER_ENABLE | unitTarget: string | implemented |
PLAYER_DIFFICULTY_CHANGED | no payload | implemented |
PLAYER_ROLES_ASSIGNED | no payload | implemented |
RAID_ROSTER_UPDATE | no payload | not implemented |
READY_CHECK | initiatorName: string, readyCheckTimeLeft: number | not implemented |
READY_CHECK_CONFIRM | unitTarget: string, isReady: boolean | not implemented |
READY_CHECK_FINISHED | preempted: boolean | not implemented |
REQUEST_INVITE_CONFIRMATION | targetName: string, partyLevelLink: number, questSessionActive: boolean, tank: boolean?, healer: boolean?, dps: boolean? | not implemented |
SOCIAL_UI_RAID_LIST_SYSTEM_STATUS_UPDATED | no payload | not implemented |
VOTE_KICK_REASON_NEEDED | name: string, resultGUID: string | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("BNET_REQUEST_INVITE_CONFIRMATION").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (2 systems, camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated); warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.