s&box docs

public class Sandbox.PartyRoom

A Party. A Party with your friends.

Methods

Showing 7 methods

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

public void Kick(Sandbox.SteamId friend)

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

public void Leave()

public void SendChatMessage(string text)

public bool SetOwner(Sandbox.SteamId friend)

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

Properties

Showing 15 properties

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

The unique identifier of this lobby

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

The maximum number of members allowed in this lobby.

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

The current number of members in this lobby.

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

A list of members in this room

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

The name of this lobby.

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

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

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

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

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

What package is this party's owner playing?

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

Allow communication via voice when in the main menu.

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.PartyRoom

On this page

Methodspublic static System.Threading.Tasks.Task`1<Sandbox.PartyRoom> Create(System.Int32 maxMembers, System.String name, System.Boolean ispublic)public static System.Threading.Tasks.Task`1<Sandbox.PartyRoom> Create(System.Int32 maxMembers)public static System.Threading.Tasks.Task`1<Sandbox.PartyRoom.Entry[]> Find()public System.Void Kick(Sandbox.SteamId friend)public System.Void Leave()public System.Void SendChatMessage(System.String text)public System.Boolean SetOwner(Sandbox.SteamId friend)Propertiespublic static Sandbox.PartyRoom Sandbox.PartyRoom.Current { get; set; }public Sandbox.SteamId Sandbox.PartyRoom.Id { get; set; }public Sandbox.PartyRoom.OwnerJoinState Sandbox.PartyRoom.JoinState { get; set; }public System.Int32 Sandbox.PartyRoom.MaxMembers { get; set; }public System.Int32 Sandbox.PartyRoom.MemberCount { get; set; }public System.Collections.Generic.IEnumerable`1<Sandbox.Friend> Sandbox.PartyRoom.Members { get; set; }public System.String Sandbox.PartyRoom.Name { get; set; }public System.Action`2<Sandbox.Friend,System.String> Sandbox.PartyRoom.OnChatMessage { get; set; }public System.Action`1<Sandbox.Friend> Sandbox.PartyRoom.OnJoin { get; set; }public System.Action`1<Sandbox.Friend> Sandbox.PartyRoom.OnLeave { get; set; }public System.Action`2<Sandbox.Friend,System.Byte[]> Sandbox.PartyRoom.OnVoiceData { get; set; }public Sandbox.Friend Sandbox.PartyRoom.Owner { get; set; }public System.String Sandbox.PartyRoom.PackageIdent { get; set; }public System.Boolean Sandbox.PartyRoom.VoiceCommunicationAllowed { get; set; }public System.Boolean Sandbox.PartyRoom.VoiceRecording { get; set; }Metadata