Skip to main content

Methods

MethodParametersReturnsNotes
CreateParty(maxSize, joinCode)int = 4, bool = truevoid
JoinByCode(joinCode)stringvoid
AcceptInvite(inviteId)stringvoid
LeaveParty()voidLeader leaving auto-transfers leadership
InvitePlayer(playerId)stringvoidAny member
SetReady(ready)boolvoid
KickMember(memberId)stringvoidLeader only
TransferLeadership(memberId)stringvoidLeader only
StartMatchmaking(queueName)stringvoidLeader only; queue from dashboard
CancelMatchmaking()voidLeader only
IsInParty()bool
IsLeader()bool
IsMatchmaking()bool
GetCurrentParty()Party?Null if not in party
GetMembers()List<PartyMember>
GetMatchmakingTicket()MatchmakingTicket?Null if not matchmaking
GetState()PartyState
Refresh()void
AddListener(listener)Actionvoid
RemoveListener(listener)Actionvoid

Party

FieldTypeNotes
Idstring
LeaderIdstring
MaxSizeint
JoinCodestring?Null if not generated
CreatedAtstring

PartyMember

FieldTypeNotes
PlayerIdstring
Rolestring"leader" or "member"
Readybool
JoinedAtstring
AttributesDictionary<string, string>Custom per-member data

MatchmakingTicket

FieldTypeNotes
TicketIDstring
QueueNamestring
EnqueuedAtstring