A simple data container describing the configuration settings for a
room. Configuration settings for an existing room can be accessed
via Room's getRoomSettings() method.
The following code creates a room named "examples.chatRoom1". Using a
RoomSettings object, the createRoom() command tells the server that the
room should continue to exist even after the last client leaves.
var roomSettings:RoomSettings = new RoomSettings();
roomSettings.removeOnEmpty = false;
var chatRoom1:Room = reactor.getRoomManager().createRoom(
"examples.chatRoom1",
roomSettings);
Returns a string representation of the room settings, suitable for sending
to the server via the u24 UPC.
RoomSettings
Variable Descriptions
maxClients
variable
public var maxClients:Object = null
Since :
Reactor 1.0.0
The maximum number of clients allowed in the room at the same time.
Use -1 for no maximum. Defaults to -1.
password
variable
public var password:String
Since :
Reactor 1.0.0
The password required to join the room. To allow clients to join and observe
the room without a password, set to the empty string (""). To leave the
room's password unchanged, set to null. The password variable applies to
assigning room settings only, and is always null on RoomSettings objects
returned by Room's getRoomSettings() method.
removeOnEmpty
variable
public var removeOnEmpty:Object = null
Since :
Reactor 1.0.0
Indicates whether the room should remove itself when it becomes empty
(all its clients leave). Defaults to true.
When false, the room is permanent, and must be deleted from the server
manually (a client can issue a manual request to remove a room via
RoomManager's removeRoom() method). If removeOnEmpty is true, and no client
enters the room within 5 minutes, the room is automatically deleted by the
server.
Method Descriptions
serialize
()
method
public function serialize():String
Since :
Reactor 1.0.0
Returns a string representation of the room settings, suitable for sending
to the server via the u24 UPC. This method is used internally by Reactor.