newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Classes
PartyRoom
chevron_left Classes
class
PartyRoom

Properties

data_objectIddata_objectJoinStatedata_objectMaxMembersdata_objectMemberCountdata_objectMembersdata_objectNamedata_objectOnChatMessagedata_objectOnJoindata_objectOnLeavedata_objectOnVoiceDatadata_objectOwnerdata_objectPackageIdentdata_objectVoiceCommunicationAlloweddata_objectVoiceRecording

Methods

functionsKickfunctionsLeavefunctionsSendChatMessagefunctionsSetOwner

Static Properties

data_objectCurrent

Static Methods

remove_circleCreatefunctionsFind
PartyRoom
A Party. A Party with your friends.
class Sandbox .
Sandbox.Engine

data_object Properties 14

Id
SteamId
The unique identifier of this lobby
JoinState
OwnerJoinState
The current join state of the owner of the party
MaxMembers
int
The maximum number of members allowed in this lobby.
MemberCount
int
The current number of members in this lobby.
Members
IEnumerable`1
A list of members in this room
Name
string
The name of this lobby.
OnChatMessage
Action`2
OnJoin
Action`1
OnLeave
Action`1
OnVoiceData
Action`2
Owner
Friend
PackageIdent
string
What package is this party's owner playing?
VoiceCommunicationAllowed
bool
Allow communication via voice when in the main menu.
VoiceRecording
bool

functions Methods 4

Kick (friend)
Kick a member from the lobby. Only the owner can kick members.
Leave ()
SendChatMessage (text)
SetOwner (friend)
bool
Set the owner to someone else. You need to be the owner

data_object Static Properties 1

Current
PartyRoom

functions Static Methods 2

Create (maxMembers)
obsoleteTask`1
Find ()
Task`1
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.