Packageplayerio
Interfacepublic interface RoomInfo

Class that describes a room instance. Instances of this class is returned by client.multiplayer.listRooms requests

See also

Multiplayer.listRooms


Public Properties
 PropertyDefined By
  data : Object
[read-only] Data object for the room.
RoomInfo
  id : String
[read-only] The id of the room.
RoomInfo
  onlineUsers : int
[read-only] How many users are online in this room.
RoomInfo
  roomType : String
[read-only] The room type.
RoomInfo
  serverType : String
[read-only] The server type.
RoomInfo
Public Methods
 MethodDefined By
  
toString():String
Returns a formatted overview of the room.
RoomInfo
Property Detail
dataproperty
data:Object  [read-only]

Data object for the room. These are values that can be defined when the room is created. These values can also be changed on the server.


Implementation
    public function get data():Object

See also

Multiplayer.createRoom.data
idproperty 
id:String  [read-only]

The id of the room.


Implementation
    public function get id():String
onlineUsersproperty 
onlineUsers:int  [read-only]

How many users are online in this room.


Implementation
    public function get onlineUsers():int
roomTypeproperty 
roomType:String  [read-only]

The room type.


Implementation
    public function get roomType():String
serverTypeproperty 
serverType:String  [read-only]

The server type.


Implementation
    public function get serverType():String
Method Detail
toString()method
public function toString():String

Returns a formatted overview of the room.

Returns
String — String info