s&box docs
API ReferenceSandbox

PartyRoomclass

A Party. A Party with your friends.

object→PartyRoom
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.PartyRoom

Methods7

Showing 7 methods

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

Returns:Task<Entry[]>—

public void Kick(Sandbox.SteamId friend)PUBLIC

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

ParameterTypeDescription
friendSteamId—
Returns:void—

public void Leave()PUBLIC

Returns:void—

public void SendChatMessage(string text)PUBLIC

ParameterTypeDescription
textstring—
Returns:void—

public bool SetOwner(Sandbox.SteamId friend)PUBLIC

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

ParameterTypeDescription
friendSteamId—
Returns:bool—

Properties15

Showing 15 properties

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

The unique identifier of this lobby

Returns:SteamId—

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

The maximum number of members allowed in this lobby.

Returns:int—

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

The current number of members in this lobby.

Returns:int—

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

A list of members in this room

Returns:IEnumerable<Friend>—

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

The name of this lobby.

Returns:string—

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

Returns:Action<Friend,string>—

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

Returns:Action<Friend>—

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

Returns:Action<Friend>—

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

Returns:Action<Friend,byte[]>—

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

What package is this party's owner playing?

Returns:string—

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

Allow communication via voice when in the main menu.

Returns:bool—

IsNearlyZero()

Previous Page

Current

Next Page

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