パッケージnet.user1.reactor
クラスpublic class RoomSettings
継承RoomSettings Inheritance Object

バージョン : Reactor 1.0.0

新しいルームのコンフィグ設定を記述するシンプルなデータコンテナです。 パスワード設定は例外ですが、ルーム設定は内部的にはルーム属性に変換され、RoomクラスのgetAttribute()メソッドを通して問い合わせできます。 しかし、より一般的には、ルームのコンフィグ設定は ##[ここにAPIを記述] を通してアクセスします。

次のコードは"examples.chatRoom1"ルームを生成します。 createRoom()コマンドは、ルームから最後のクライアントが退室した後にもそのルームが存在し続けるべきかどうかをRoomSettingsオブジェクトを使用してサーバーに指示します。

   var roomSettings:RoomSettings = new RoomSettings();
   roomSettings.dieOnEmpty = false;
   
   var chatRoom1:Room = reactor.getRoomManager().createRoom(
                                                   "examples.chatRoom1",
                                                   roomSettings);
   

関連項目

RoomManager.createRoom()


パブリック プロパティ
 プロパティ定義元
  clientTimeout : int = -1
ミリ秒で、クライアントが活動なしでルームに滞在していられる合計時間を指定します。
RoomSettings
  dieOnEmpty : Boolean = true
ルームが空になった(全てのクライアントが退室した)とき、それ自身を除去するかどうかを指定します。
RoomSettings
  maxClients : int = -1
同時にルームに入室できるクライアントの最大数です。
RoomSettings
  password : String
入室に必要なパスワードです。
RoomSettings
パブリック メソッド
 メソッド定義元
  
serialize():String
u24 UPCを通してサーバーに送信するのに適応しているルーム設定のストリング表現を返します。
RoomSettings
プロパティの詳細
clientTimeoutプロパティ
public var clientTimeout:int = -1

バージョン : Reactor 1.0.0

ミリ秒で、クライアントが活動なしでルームに滞在していられる合計時間を指定します。 デフォルトは-1(制限なし)です。 ##["ルーム内の活動"とは何かを記述します]

dieOnEmptyプロパティ 
public var dieOnEmpty:Boolean = true

バージョン : Reactor 1.0.0

ルームが空になった(全てのクライアントが退室した)とき、それ自身を除去するかどうかを指定します。 デフォルトはtrueです。 falseのとき、ルームは永続し、サーバーから手動で削除する必要があります(クライアントはRoomManagerのremoveRoom()メソッドを通して手動でルームの除去要求を発行できます)。 dieOnEmptyがtrueで、5分間ルームにクライアントが入ってこなかったルームはサーバーによって自動的に削除されます。

maxClientsプロパティ 
public var maxClients:int = -1

バージョン : Reactor 1.0.0

同時にルームに入室できるクライアントの最大数です。 無制限にするには-1を使用します。 デフォルトは-1です。

passwordプロパティ 
public var password:String

バージョン : Reactor 1.0.0

入室に必要なパスワードです。 指定しない場合、デフォルトは空の文字列で、パスワード無しで入室できることを意味します。

メソッドの詳細
serialize()メソッド
public function serialize():String

バージョン : Reactor 1.0.0

u24 UPCを通してサーバーに送信するのに適応しているルーム設定のストリング表現を返します。 このメソッドはReactorによって内部的に使用されます。

戻り値
String