A snapshot of this player's current download progress, or null when unavailable.

A snapshot of the leader's download progress, separate from this player's download. Null when the leader is not loading or has not reported valid progress.

The unique identifier of this party.

Whether this party is discoverable and joinable by everyone.

A human-readable failure message, or null when there is no failure. Do not use it to determine the join stage.

The local follower's join stage, or Sandbox.PartyRoom.JoinStage.None when no attempt exists.

The leader's advertised join state. Unknown or missing states report Sandbox.PartyRoom.OwnerJoinState.None.

The maximum number of members allowed in this party.

The current number of members in this party.

A list of members in this party.

The party name, filtered using the local player's chat filter settings. Only the leader can change it.

The current party leader.

What package is this party's owner playing?

The game title advertised by the party leader, which may be empty.

The game the party intends to play, without starting downloads or following the leader.

A copy of the leader's saved setup for the selected game, or null if it has not been configured.

The title of the game the party intends to play.

Allow communication via voice when in the main menu.

Whether we are recording voice for the party.

Cancel a download, wait for the leader, or connection attempt while staying in the party. Does nothing in other stages, including after joining. Must be called on the main thread.

Save the setup for the currently selected game. Only the leader can change it.

What this party member is doing - downloading the game, waiting, in it. Each member shares their own through the lobby, so this is at most half a second old.

Whether this package matches the chosen game, including its revision when one was selected.

Whether this member is ready for the current game setup. The leader starts the game instead.

Kick a member from the party. Only the owner can kick members.

Leave this party and stop following its leader.

Make this party discoverable and joinable by everyone. Only the leader can do this.

Retry a failed or cancelled join on the next party update. Does nothing in other stages. Must be called on the main thread.

Publish the leader's choice of game. Pass null to clear the choice.

Set the owner to someone else. You need to be the owner

Switch between a public party and an invitation-only party. Only the leader can do this.

Share whether the local member is ready for the selected game and its saved settings. Changing the setup clears everyone's readiness.

The maximum length of a custom party name.

The party we currently belong to, if any.

Create an open party with the local player as its leader.

Find open parties with space for another member.

Refresh a party's details without joining it. Returns null if it is no longer available.

Join a party by its identifier, checking that it still exists and is a party.