Room Class

The Room class defines a room in the network. Users can join and leave rooms and send data to all other users in the same room.

Definition

Namespace: Alteruna.Multiplayer.Core
Assembly: Alteruna (in Alteruna.dll) Version: 2.0.1+a1176e08a0b4a6bfd8fefeddde6163a16d29e5ab
C#
public class Room : ISessionCustomDataRO
Inheritance
Object    Room
Implements
ISessionCustomDataRO

Properties

CurrentUsers Amount of users in this Room.
CustomData Custom data for a room.
DisplayName The name of this Room.
IDObsolete.
InviteOnlyObsolete.
IsLocked Get if this Room is locked. True when the room state is busy.
IsPasswordProtected Defines if this Room requires a pin to enter.
Local Defines if this Room is hosted locally.
MaxUsers The maximum allowed number of Users within this Room
NameObsolete.
OnDemand Defines if this Room will automatically close when empty.
PincodeObsolete.
Private Defines if this Room should appear in room lists.
SceneId Base room scene id. -1 means no specified scene.
SessionID The ID of this Room.
State 
Users The Users currently in this Room. Only gets populated if in the same Room.

Methods

Destroy Destroy room from server.
Equals
(Overrides ObjectEquals(Object))
GetUserCount Amount of users in this Room.
Obsolete.
Join Attempt to join this Room.
Join(UInt16) Attempt to join this Room using a pin.
KickUser Kick user from current room.
Leave Send to leave request to current Room.

Operators

See Also