| パッケージ | net.user1.reactor |
| クラス | public class RoomEvent |
| 継承 | RoomEvent flash.events.Event |
| バージョン : | Reactor 1.0.0 |
// イベント登録コード
someRoom.addEventListener(RoomEvent.ADD_OCCUPANT,
addOccupantListener);
// イベントリスナーのコード
protected function addOccupantListener (e:RoomEvent):void {
trace("User " + e.getClient().getClientID() + " joined the room.");
}
関連項目
| メソッド | 定義元 | ||
|---|---|---|---|
RoomEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, client:IClient = null, clientID:String = null, status:String = null, changedAttr:Attribute = null, numClients:int = 0, roomID:String = null) コンストラクタ | RoomEvent | ||
clone():Event [オーバーライド] | RoomEvent | ||
変更されたルームかクライアントの属性情報を含む属性オブジェクトを返します。 | RoomEvent | ||
このイベントに関連するClientオブジェクトの参照を返します。 | RoomEvent | ||
getClientID():String このイベントに関連するクライアントのIDを返します。 | RoomEvent | ||
getNumClients():Number 現在このルームに入室中のクライアント数を返します。 | RoomEvent | ||
getRoomID():String このイベントに関係するルームのルームIDを返します。 | RoomEvent | ||
getStatus():String このイベントに関係する操作のステータスを返します。 | RoomEvent | ||
toString():String [オーバーライド] | RoomEvent | ||
| 定数 | 定義元 | ||
|---|---|---|---|
| ADD_OBSERVER : String = ADD_OBSERVER [静的] クライアントがルームの観戦を開始し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"観戦者リスト"更新が有効になっている(観戦者リスト更新はデフォルトでは無効です)。 | RoomEvent | ||
| ADD_OCCUPANT : String = ADD_OCCUPANT [静的] クライアントがルームに入室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"入室者リスト"更新が有効になっている(入室者リスト更新はデフォルトでは有効です)。 | RoomEvent | ||
| DELETE_CLIENT_ATTRIBUTE : String = DELETE_CLIENT_ATTRIBUTE [静的] 現クライアントがルームに入室するか、観戦を開始するときに送出され、次のいずれかが発生します: 入室者がルーム属性を削除し、現クライアントがルームをスコープとして共有された入室者属性(UpdateLevelsクラスのsharedOccupantAttributesRoom変数を参照)か、全てのルームをスコープとした入室者属性(UpdateLevelsクラスのallOccupantAttributesRoom変数を参照)の更新を有効化している。 入室者がグローバル属性を削除し、現クライアントが共有されたグローバル入室者属性(UpdateLevelsクラスのsharedOccupantAttributesGlobal変数を参照)か、全てのグローバル入室者属性(UpdateLevelsクラスのallOccupantAttributesGlobal変数を参照)の更新を有効化している。 観戦者がルーム属性を削除し、現クライアントがルームをスコープとして共有された観戦者属性(UpdateLevelsクラスのsharedObserverAttributesRoom変数を参照)か、全てのルームをスコープとした観戦者属性(UpdateLevelsクラスのallObserverAttributesRoom変数を参照)の更新を有効化している。 観戦者がグローバル属性を削除し、現クライアントが共有されたグローバル観戦者属性(UpdateLevelsクラスのsharedObserverAttributesGlobal変数を参照)か、全てのグローバル観戦者属性(UpdateLevelsクラスのallObserverAttributesGlobal変数を参照)の更新を有効化している。 ルームの入室者または観戦者の属性更新を有効化あるいは無効化するには、最初に、UpdateLevelsオブジェクト上の次の変数のいずれかをセットします: sharedOccupantAttributesRoom sharedOccupantAttributesGlobal sharedObserverAttributesRoom sharedObserverAttributesGlobal allOccupantAttributesRoom allOccupantAttributesGlobal allObserverAttributesRoom allObserverAttributesGlobal 次に、そのUpdateLevelsオブジェクトを次のいずれかのメソッドに渡してください: Roomのjoin()メソッド Roomのobserve()メソッド RoomのsteUpdateLevels()メソッド RoomManagerのjoinRoom()メソッド RoomManagerのobserveRoom()メソッド 例えば、次のコードはtheRoomによって参照されるルームの入室者の全ての共有属性の更新を無効化します: var updateLevels:UpdateLevels = new UpdateLevels(); updateLevels.sharedOccupantAttributesRoom = false; updateLevels.sharedOccupantAttributesGlobal = false; theRoom.setUpdateLevels(updateLevels); | RoomEvent | ||
| JOIN : String = JOIN [静的] サーバー側のコードか、先にルームへの入室要求を行った結果として、現クライアントがルームへの入室に成功したときに送出されます。 | RoomEvent | ||
| JOIN_RESULT : String = JOIN_RESULT [静的] 先に行われたルーム入室要求の結果を取得したときに送出されます。 | RoomEvent | ||
| LEAVE : String = LEAVE [静的] サーバー側のコードか、先にルームからの退室要求を行った結果として、現クライアントがルームからの退室に成功したときに送出されます。 | RoomEvent | ||
| LEAVE_RESULT : String = LEAVE_RESULT [静的] 先に行われたルーム退室要求の結果を取得したときに送出されます。 | RoomEvent | ||
| OBSERVE : String = OBSERVE [静的] サーバー側のコードか、先にルームの観察要求を行った結果として、現クライアントがルームの観察に成功したときに送出されます。 | RoomEvent | ||
| OBSERVER_COUNT : String = OBSERVER_COUNT [静的] 現クライアントが入室しているか観戦しているルームの観戦者数が変化し、現クライアントがそのルームについて"観戦者リスト"更新か"観戦者カウント"更新を有効にしているときに送出されます(どちらもデフォルトでは無効になっています)。 | RoomEvent | ||
| OBSERVE_RESULT : String = OBSERVE_RESULT [静的] 先に行われたルーム観察要求の結果を取得したときに送出されます。 | RoomEvent | ||
| OCCUPANT_COUNT : String = OCCUPANT_COUNT [静的] 現クライアントが入室しているか観戦しているルームの入室者数が変化し、現クライアントがそのルームについて"入室者リスト"更新か"入室者カウント"更新を有効にしているときに送出されます(入室者リスト更新はデフォルトで有効になっています)。 | RoomEvent | ||
| REMOVED : String = REMOVED [静的] それまで現クライアントによって把握されていたルームが把握できなくなったときに送出されます。 | RoomEvent | ||
| REMOVE_OBSERVER : String = REMOVE_OBSERVER [静的] クライアントがルームの観戦を停止し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"観戦者リスト"更新が有効になっている(観戦者リスト更新はデフォルトでは無効です)。 | RoomEvent | ||
| REMOVE_OCCUPANT : String = REMOVE_OCCUPANT [静的] クライアントがルームから退室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"入室者リスト"更新が有効になっている(入室者リスト更新はデフォルトでは有効です)。 | RoomEvent | ||
| STOP_OBSERVING : String = STOP_OBSERVING [静的] サーバー側のコードか、先にルームの観察停止要求を行った結果として、現クライアントがルームの観察停止に成功したときに送出されます。 | RoomEvent | ||
| STOP_OBSERVING_RESULT : String = STOP_OBSERVING_RESULT [静的] 先に行われた観察停止要求の結果を取得したときに送出されます。 | RoomEvent | ||
| SYNCHRONIZE : String = SYNCHRONIZE [静的] ルームがサーバーの状態と同期したときに送出されます。 | RoomEvent | ||
| UPDATE_CLIENT_ATTRIBUTE : String = UPDATE_CLIENT_ATTRIBUTE [静的] 現クライアントがルームに入室するか、観戦を開始するときに送出され、次のいずれかが発生します: 入室者がルーム属性をセットし、現クライアントがルームをスコープとして共有された入室者属性(UpdateLevelsクラスのsharedOccupantAttributesRoom変数を参照)か、全てのルームをスコープとした入室者属性(UpdateLevelsクラスのallOccupantAttributesRoom変数を参照)の更新を有効化している。 入室者がグローバル属性をセットし、現クライアントが共有されたグローバル入室者属性(UpdateLevelsクラスのsharedOccupantAttributesGlobal変数を参照)か、全てのグローバル入室者属性(UpdateLevelsクラスのallOccupantAttributesGlobal変数を参照)の更新を有効化している。 観戦者がルーム属性をセットし、現クライアントがルームをスコープとして共有された観戦者属性(UpdateLevelsクラスのsharedObserverAttributesRoom変数を参照)か、全てのルームをスコープとした観戦者属性(UpdateLevelsクラスのallObserverAttributesRoom変数を参照)の更新を有効化している。 観戦者がグローバル属性をセットし、現クライアントが共有されたグローバル観戦者属性(UpdateLevelsクラスのsharedObserverAttributesGlobal変数を参照)か、全てのグローバル観戦者属性(UpdateLevelsクラスのallObserverAttributesGlobal変数を参照)の更新を有効化している。 ルームの入室者または観戦者の属性更新を有効化あるいは無効化するには、最初に、UpdateLevelsオブジェクト上の次の変数のいずれかをセットします: sharedOccupantAttributesRoom sharedOccupantAttributesGlobal sharedObserverAttributesRoom sharedObserverAttributesGlobal allOccupantAttributesRoom allOccupantAttributesGlobal allObserverAttributesRoom allObserverAttributesGlobal 次に、そのUpdateLevelsオブジェクトを次のいずれかのメソッドに渡してください: Roomのjoin()メソッド Roomのobserve()メソッド RoomのsteUpdateLevels()メソッド RoomManagerのjoinRoom()メソッド RoomManagerのobserveRoom()メソッド 例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観戦者のルームをスコープとした共有属性の更新を有効化します: var updateLevels:UpdateLevels = new UpdateLevels(); updateLevels.sharedObserverAttributesRoom = true; theRoom.setUpdateLevels(updateLevels); | RoomEvent | ||
| RoomEvent | () | コンストラクタ |
public function RoomEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, client:IClient = null, clientID:String = null, status:String = null, changedAttr:Attribute = null, numClients:int = 0, roomID:String = null)コンストラクタ
パラメータtype:String | |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
client:IClient (default = null) | |
clientID:String (default = null) | |
status:String (default = null) | |
changedAttr:Attribute (default = null) | |
numClients:int (default = 0) | |
roomID:String (default = null) |
| clone | () | メソッド |
override public function clone():Event 戻り値 Event |
| getChangedAttr | () | メソッド |
public function getChangedAttr():Attribute| バージョン : | Reactor 1.0.0 |
変更されたルームかクライアントの属性情報を含む属性オブジェクトを返します。 このメソッドは次のイベントに適用されます。
Attribute |
| getClient | () | メソッド |
public function getClient():IClient| バージョン : | Reactor 1.0.0 |
このイベントに関連するClientオブジェクトの参照を返します。 このメソッドは次のイベントに適用されます。
IClient |
| getClientID | () | メソッド |
public function getClientID():String| バージョン : | Reactor 1.0.0 |
このイベントに関連するクライアントのIDを返します。 このメソッドは次のイベントに適用されます。
String |
| getNumClients | () | メソッド |
public function getNumClients():Number| バージョン : | Reactor 1.0.0 |
現在このルームに入室中のクライアント数を返します。 このメソッドは次のイベントに適用されます。
Number |
| getRoomID | () | メソッド |
public function getRoomID():String| バージョン : | Reactor 1.0.0 |
このイベントに関係するルームのルームIDを返します。 例えば、RoomEvent.JOINイベントにおいては、入室したルームのroomIDを返します。
戻り値String |
| getStatus | () | メソッド |
public function getStatus():String| バージョン : | Reactor 1.0.0 |
このイベントに関係する操作のステータスを返します。 getStatus()メソッドの戻り値は常にStatusクラスの定数のどれかになります。 例えば、もしRoomEvent.JOIN_RESULTイベントがルームへの入室試行に成功した結果として発生した場合、getStatus()はStatus.SUCCESS値を返します。 ステータスに対応するには、getStatus()の値とStatus定数とを比較します。 例えば、
if (e.getStatus() != Status.SUCCESS) {
showJoinFailedScreen();
}
String |
| toString | () | メソッド |
override public function toString():String 戻り値 String |
| ADD_OBSERVER | 定数 |
public static const ADD_OBSERVER:String = ADD_OBSERVER| バージョン : | Reactor 1.0.0 |
クライアントがルームの観戦を開始し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"観戦者リスト"更新が有効になっている(観戦者リスト更新はデフォルトでは無効です)。 ルームの観戦者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにobserverList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観戦者リストの更新を有効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.observerList = true;
theRoom.setUpdateLevels(updateLevels);
関連項目
| ADD_OCCUPANT | 定数 |
public static const ADD_OCCUPANT:String = ADD_OCCUPANT| バージョン : | Reactor 1.0.0 |
クライアントがルームに入室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"入室者リスト"更新が有効になっている(入室者リスト更新はデフォルトでは有効です)。 ルームの入室者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにoccupantList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける入室者リストの更新を無効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.occupantList = false;
theRoom.setUpdateLevels(updateLevels);
関連項目
| DELETE_CLIENT_ATTRIBUTE | 定数 |
public static const DELETE_CLIENT_ATTRIBUTE:String = DELETE_CLIENT_ATTRIBUTE| バージョン : | Reactor 1.0.0 |
現クライアントがルームに入室するか、観戦を開始するときに送出され、次のいずれかが発生します:
ルームの入室者または観戦者の属性更新を有効化あるいは無効化するには、最初に、UpdateLevelsオブジェクト上の次の変数のいずれかをセットします:
例えば、次のコードはtheRoomによって参照されるルームの入室者の全ての共有属性の更新を無効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.sharedOccupantAttributesRoom = false;
updateLevels.sharedOccupantAttributesGlobal = false;
theRoom.setUpdateLevels(updateLevels);
関連項目
| JOIN | 定数 |
public static const JOIN:String = JOIN| バージョン : | Reactor 1.0.0 |
サーバー側のコードか、先にルームへの入室要求を行った結果として、現クライアントがルームへの入室に成功したときに送出されます。
RoomEvent.JOINイベントは現クライアントにのみ適用される点に留意してください。 全てのクライアントがルームに入室するときに通知を受けるには、RoomEvent.ADD_OCCUPANTイベントを登録してください。
関連項目
| JOIN_RESULT | 定数 |
public static const JOIN_RESULT:String = JOIN_RESULT| バージョン : | Reactor 1.0.0 |
先に行われたルーム入室要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
もしルーム入室要求が成功した場合、RoomEvent.JOINイベントもトリガーされます。
関連項目
| LEAVE | 定数 |
public static const LEAVE:String = LEAVE| バージョン : | Reactor 1.0.0 |
サーバー側のコードか、先にルームからの退室要求を行った結果として、現クライアントがルームからの退室に成功したときに送出されます。
RoomEvent.LEAVEイベントは現クライアントにのみ適用される点に留意してください。 ルームから退室するのがどのクライアントでも通知をうけるには、RoomEvent.REMOVE_OCCUPANTイベントを登録します。
| LEAVE_RESULT | 定数 |
public static const LEAVE_RESULT:String = LEAVE_RESULT| バージョン : | Reactor 1.0.0 |
先に行われたルーム退室要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
もしその入退室要求が成功した場合、RoomEvent.LEAVEイベントもトリガーされます。
関連項目
| OBSERVE | 定数 |
public static const OBSERVE:String = OBSERVE| バージョン : | Reactor 1.0.0 |
サーバー側のコードか、先にルームの観察要求を行った結果として、現クライアントがルームの観察に成功したときに送出されます。 RoomEvent.OBSERVEは現クライアントにしか適用されない点に留意してください。他のクライアントがルームを観戦するときに通知を受けるには、RoomEvent.ADD_OBSERVERイベントを登録してください。
関連項目
| OBSERVE_RESULT | 定数 |
public static const OBSERVE_RESULT:String = OBSERVE_RESULT| バージョン : | Reactor 1.0.0 |
先に行われたルーム観察要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
関連項目
| OBSERVER_COUNT | 定数 |
public static const OBSERVER_COUNT:String = OBSERVER_COUNT| バージョン : | Reactor 1.0.0 |
現クライアントが入室しているか観戦しているルームの観戦者数が変化し、現クライアントがそのルームについて"観戦者リスト"更新か"観戦者カウント"更新を有効にしているときに送出されます(どちらもデフォルトでは無効になっています)。 ルームの観戦者リストの更新か観戦者数の更新を有効化あるいは無効化するには、(それぞれ)observerList変数かobserverCount変数をUpdateLevelsオブジェクトにセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観戦者数の更新を有効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.observerCount = true;
theRoom.setUpdateLevels(updateLevels);
関連項目
| OCCUPANT_COUNT | 定数 |
public static const OCCUPANT_COUNT:String = OCCUPANT_COUNT| バージョン : | Reactor 1.0.0 |
現クライアントが入室しているか観戦しているルームの入室者数が変化し、現クライアントがそのルームについて"入室者リスト"更新か"入室者カウント"更新を有効にしているときに送出されます(入室者リスト更新はデフォルトで有効になっています)。 ルームの入室者リストの更新か入室者数の更新を有効化あるいは無効化するには、(それぞれ)occupantList変数かoccupantCount変数をUpdateLevelsオブジェクトにセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける入室者リストの更新を無効化し、入室者数の更新を有効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.occupantList = false;
updateLevels.occupantCount = true;
theRoom.setUpdateLevels(updateLevels);
関連項目
| REMOVE_OBSERVER | 定数 |
public static const REMOVE_OBSERVER:String = REMOVE_OBSERVER| バージョン : | Reactor 1.0.0 |
クライアントがルームの観戦を停止し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"観戦者リスト"更新が有効になっている(観戦者リスト更新はデフォルトでは無効です)。 ルームの観戦者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにobserverList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観戦者リストの更新を有効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.observerList = true;
theRoom.setUpdateLevels(updateLevels);
関連項目
| REMOVE_OCCUPANT | 定数 |
public static const REMOVE_OCCUPANT:String = REMOVE_OCCUPANT| バージョン : | Reactor 1.0.0 |
クライアントがルームから退室し、次の二つの条件を満たすときに送出されます: 1) 現クライアントがそのルームに入室または観戦している。2) 現クライアントがそのルームについて"入室者リスト"更新が有効になっている(入室者リスト更新はデフォルトでは有効です)。 ルームの入室者リストを有効化あるいは無効化するには、UpdateLevelsオブジェクトにoccupantList変数をセットし、そのオブジェクトを次のいずれかのメソッドに渡してください:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける入室者リストの更新を無効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.occupantList = false;
theRoom.setUpdateLevels(updateLevels);
関連項目
| REMOVED | 定数 |
public static const REMOVED:String = REMOVED| バージョン : | Reactor 1.0.0 |
それまで現クライアントによって把握されていたルームが把握できなくなったときに送出されます。 ルームはキャッシュされたか、入室したか、観戦を開始したか、または監視されたときに現クライアントによって把握されます。 現クライアントのルームキャッシュについての情報については、RoomManagerのdisposeChachedRooms()メソッドを参照してください。
関連項目
| STOP_OBSERVING | 定数 |
public static const STOP_OBSERVING:String = STOP_OBSERVING| バージョン : | Reactor 1.0.0 |
サーバー側のコードか、先にルームの観察停止要求を行った結果として、現クライアントがルームの観察停止に成功したときに送出されます。
関連項目
| STOP_OBSERVING_RESULT | 定数 |
public static const STOP_OBSERVING_RESULT:String = STOP_OBSERVING_RESULT| バージョン : | Reactor 1.0.0 |
先に行われた観察停止要求の結果を取得したときに送出されます。 要求の結果を究明するためには、getStatus()を使用してください。これは次の戻り値のうちどれかになります:
関連項目
| SYNCHRONIZE | 定数 |
public static const SYNCHRONIZE:String = SYNCHRONIZE| バージョン : | Reactor 1.0.0 |
ルームがサーバーの状態と同期したときに送出されます。 ルームは現クライアントが入室か観戦を開始するときに同期されます。
関連項目
| UPDATE_CLIENT_ATTRIBUTE | 定数 |
public static const UPDATE_CLIENT_ATTRIBUTE:String = UPDATE_CLIENT_ATTRIBUTE| バージョン : | Reactor 1.0.0 |
現クライアントがルームに入室するか、観戦を開始するときに送出され、次のいずれかが発生します:
ルームの入室者または観戦者の属性更新を有効化あるいは無効化するには、最初に、UpdateLevelsオブジェクト上の次の変数のいずれかをセットします:
例えば、次のコードはtheRoomによって参照されるRoomオブジェクトにおける観戦者のルームをスコープとした共有属性の更新を有効化します:
var updateLevels:UpdateLevels = new UpdateLevels();
updateLevels.sharedObserverAttributesRoom = true;
theRoom.setUpdateLevels(updateLevels);
関連項目