GODPAPER | All Packages | All Classes | Index | Frames No Frames |
RoomInfo

Package | playerio
Interface | public 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

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | toString():String Returns a formatted overview of the room. | RoomInfo

Property Detail

data | property

`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

id | property |

`id:String` [read-only]

The id of the room.

Implementation
`public function get id():String`

onlineUsers | property |

`onlineUsers:int` [read-only]

How many users are online in this room.

Implementation
`public function get onlineUsers():int`

roomType | property |

`roomType:String` [read-only]

The room type.

Implementation
`public function get roomType():String`

serverType | property |

`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

Thu Jan 16 2014, 01:11 PM +08:00