PartyRoomclass

public void CancelJoin()PUBLIC

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.

public void ConfigureGame(string gameIdent, Sandbox.Modals.CreateGameResults settings)PUBLIC

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

public static System.Threading.Tasks.Task`1<Sandbox.PartyRoom.Entry[]> Find()PUBLICSTATIC

Find open parties with space for another member.

public static System.Threading.Tasks.Task`1<System.Nullable`1<Sandbox.PartyRoom.Entry>> GetEntryAsync(ulong id)PUBLICSTATIC

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

public Sandbox.PartyRoom.MemberStatus GetMemberStatus(Sandbox.Friend member)PUBLIC

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.

public bool IsGameSelected(Sandbox.Package package)PUBLIC

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

public bool IsMemberReady(Sandbox.Friend member)PUBLIC

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

public static System.Threading.Tasks.Task`1<bool> Join(ulong id)PUBLICSTATIC

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

public void Kick(Sandbox.SteamId friend)PUBLIC

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

public void Leave()PUBLIC

Leave this party and stop following its leader.

public void MakePublic()PUBLIC

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

public void RetryJoin()PUBLIC

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

public void SelectGame(Sandbox.Package package)PUBLIC

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

public void SendChatMessage(string text)PUBLIC

public bool SetOwner(Sandbox.SteamId friend)PUBLIC

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

public void SetPublic(bool isPublic)PUBLIC

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

public void SetReady(bool ready)PUBLIC

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

public static Sandbox.PartyRoom Sandbox.PartyRoom.Current { get; set; }PUBLICSTATICGETSET

The party we currently belong to, if any.

public System.Nullable`1<Sandbox.Menu.LoadingProgress> Sandbox.PartyRoom.DownloadProgress { get; set; }PUBLICGETSET

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

public System.Nullable`1<Sandbox.Menu.LoadingProgress> Sandbox.PartyRoom.HostDownloadProgress { get; set; }PUBLICGETSET

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.

public Sandbox.SteamId Sandbox.PartyRoom.Id { get; set; }PUBLICGETSET

The unique identifier of this party.

public bool Sandbox.PartyRoom.IsPublic { get; set; }PUBLICGETSET

Whether this party is discoverable and joinable by everyone.

public string Sandbox.PartyRoom.JoinError { get; set; }PUBLICGETSET

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

public Sandbox.PartyRoom.JoinStage Sandbox.PartyRoom.JoiningStage { get; set; }PUBLICGETSET

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

public Sandbox.PartyRoom.OwnerJoinState Sandbox.PartyRoom.JoinState { get; set; }PUBLICGETSET

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

public int Sandbox.PartyRoom.MaxMembers { get; set; }PUBLICGETSET

The maximum number of members allowed in this party.

public int Sandbox.PartyRoom.MemberCount { get; set; }PUBLICGETSET

The current number of members in this party.

public System.Collections.Generic.IEnumerable`1<Sandbox.Friend> Sandbox.PartyRoom.Members { get; set; }PUBLICGETSET

A list of members in this party.

public string Sandbox.PartyRoom.Name { get; set; }PUBLICGETSET

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

public System.Action`2<Sandbox.Friend,string> Sandbox.PartyRoom.OnChatMessage { get; set; }PUBLICGETSET

public System.Action`1<Sandbox.Friend> Sandbox.PartyRoom.OnJoin { get; set; }PUBLICGETSET

public System.Action`1<Sandbox.Friend> Sandbox.PartyRoom.OnLeave { get; set; }PUBLICGETSET

public System.Action`2<Sandbox.Friend,byte[]> Sandbox.PartyRoom.OnVoiceData { get; set; }PUBLICGETSET

public Sandbox.Friend Sandbox.PartyRoom.Owner { get; set; }PUBLICGETSET

The current party leader.

public string Sandbox.PartyRoom.PackageIdent { get; set; }PUBLICGETSET

What package is this party's owner playing?

public string Sandbox.PartyRoom.PackageTitle { get; set; }PUBLICGETSET

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

public string Sandbox.PartyRoom.SelectedGameIdent { get; set; }PUBLICGETSET

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

public System.Nullable`1<Sandbox.Modals.CreateGameResults> Sandbox.PartyRoom.SelectedGameSettings { get; set; }PUBLICGETSET

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

public string Sandbox.PartyRoom.SelectedGameTitle { get; set; }PUBLICGETSET

The title of the game the party intends to play.

public bool Sandbox.PartyRoom.VoiceCommunicationAllowed { get; set; }PUBLICGETSET

Allow communication via voice when in the main menu.

public bool Sandbox.PartyRoom.VoiceRecording { get; set; }PUBLICGETSET

Whether we are recording voice for the party.