| Package | com.myflashlab.air.extensions.googleGames |
| Class | public class Room |
| Inheritance | Room  Object |
| Property | Defined By | ||
|---|---|---|---|
| autoMatchWaitEstimateSeconds : int [read-only]
Retrieves the estimated wait time for automatching to finish for players who are not automatched immediately,
as measured from the time that the room entered the automatching pool. | Room | ||
| creationTimestamp : Number [read-only]
The server timestamp at which the room was created. | Room | ||
| creatorId : String [read-only]
The ID of the participant who created this Room. | Room | ||
| description : String [read-only]
Description of this room. | Room | ||
| exclusive_bit_mask : int [read-only] | Room | ||
| max_automatch_players : int [read-only] | Room | ||
| min_automatch_players : int [read-only] | Room | ||
| participantIds : Array [read-only]
The IDs of the participants in this room. | Room | ||
| roomId : String [read-only]
The ID of this Room. | Room | ||
| variant : int [read-only]
Variant specified for this room, if any. | Room | ||
| Method | Defined By | ||
|---|---|---|---|
getParticipant($participantId:String):Participant
Get a participant in a room by its ID. | Room | ||
getParticipantId($playerId:String):String
returns the participant ID corresponding to given player, or null if none found. | Room | ||
getParticipantStatus($participantId:String):int
Get the status of a participant in a room. | Room | ||
getStatus():int
The current status of the room. | Room | ||
| Constant | Defined By | ||
|---|---|---|---|
| ROOM_EVENT_AUTO_MATCHING : String = onRoomAutoMatching [static] | Room | ||
| ROOM_EVENT_CONNECTED : String = onConnectedToRoom [static] | Room | ||
| ROOM_EVENT_CONNECTING : String = onRoomConnecting [static] | Room | ||
| ROOM_EVENT_DISCONNECTED : String = onDisconnectedFromRoom [static] | Room | ||
| ROOM_EVENT_P2P_CONNECTED : String = onP2PConnected [static] | Room | ||
| ROOM_EVENT_P2P_DISCONNECTED : String = onP2PDisconnected [static] | Room | ||
| ROOM_EVENT_PEER_DECLINED : String = onPeerDeclined [static] | Room | ||
| ROOM_EVENT_PEER_INVITED : String = onPeerInvitedToRoom [static] | Room | ||
| ROOM_EVENT_PEER_JOINED : String = onPeerJoined [static] | Room | ||
| ROOM_EVENT_PEER_LEFT : String = onPeerLeft [static] | Room | ||
| ROOM_EVENT_PEERS_CONNECTED : String = onPeersConnected [static] | Room | ||
| ROOM_EVENT_PEERS_DISCONNECTED : String = onPeersDisconnected [static] | Room | ||
| ROOM_STATUS_ACTIVE : int = 3 [static]
Constant returned by getStatus() indicating that the room is active and connections are established. | Room | ||
| ROOM_STATUS_AUTO_MATCHING : int = 1 [static]
Constant returned by getStatus() indicating that one or more slots are waiting to be filled by auto-matching. | Room | ||
| ROOM_STATUS_CONNECTING : int = 2 [static]
Constant returned by getStatus() indicating that this room is waiting for clients to connect to each other. | Room | ||
| ROOM_STATUS_INVITING : int = 0 [static]
Constant returned by getStatus() indicating that the room has one or more players that have been invited and
have not responded yet. | Room | ||
| ROOM_VARIANT_DEFAULT : int = -1 [static]
Constant used to indicate that the variant for a room is unspecified. | Room | ||
| autoMatchWaitEstimateSeconds | property |
autoMatchWaitEstimateSeconds:int [read-only] Retrieves the estimated wait time for automatching to finish for players who are not automatched immediately, as measured from the time that the room entered the automatching pool.
public function get autoMatchWaitEstimateSeconds():int| creationTimestamp | property |
creationTimestamp:Number [read-only] The server timestamp at which the room was created.
public function get creationTimestamp():Number| creatorId | property |
creatorId:String [read-only] The ID of the participant who created this Room. Note that not all participants will see the same value for the creator. In the case of an automatch, this value may differ for each participant.
public function get creatorId():String| description | property |
description:String [read-only] Description of this room.
public function get description():String| exclusive_bit_mask | property |
exclusive_bit_mask:int [read-only] public function get exclusive_bit_mask():int| max_automatch_players | property |
max_automatch_players:int [read-only] public function get max_automatch_players():int| min_automatch_players | property |
min_automatch_players:int [read-only] public function get min_automatch_players():int| participantIds | property |
participantIds:Array [read-only] The IDs of the participants in this room. These are returned in the participant order of the room. Note that these are not stable across rooms.
public function get participantIds():Array| roomId | property |
roomId:String [read-only] The ID of this Room.
public function get roomId():String| variant | property |
variant:int [read-only] Variant specified for this room, if any.
public function get variant():int| getParticipant | () | method |
public function getParticipant($participantId:String):ParticipantGet a participant in a room by its ID. Note that the participant ID must correspond to a participant in this match.
Parameters
$participantId:String |
Participant — |
| getParticipantId | () | method |
public function getParticipantId($playerId:String):Stringreturns the participant ID corresponding to given player, or null if none found.
Parameters
$playerId:String |
String — |
| getParticipantStatus | () | method |
public function getParticipantStatus($participantId:String):intGet the status of a participant in a room. Note that the participant ID must correspond to a participant in this room
Parameters
$participantId:String |
int — |
| getStatus | () | method |
public function getStatus():intThe current status of the room.
Returnsint — |
| ROOM_EVENT_AUTO_MATCHING | Constant |
public static const ROOM_EVENT_AUTO_MATCHING:String = onRoomAutoMatching| ROOM_EVENT_CONNECTED | Constant |
public static const ROOM_EVENT_CONNECTED:String = onConnectedToRoom| ROOM_EVENT_CONNECTING | Constant |
public static const ROOM_EVENT_CONNECTING:String = onRoomConnecting| ROOM_EVENT_DISCONNECTED | Constant |
public static const ROOM_EVENT_DISCONNECTED:String = onDisconnectedFromRoom| ROOM_EVENT_P2P_CONNECTED | Constant |
public static const ROOM_EVENT_P2P_CONNECTED:String = onP2PConnected| ROOM_EVENT_P2P_DISCONNECTED | Constant |
public static const ROOM_EVENT_P2P_DISCONNECTED:String = onP2PDisconnected| ROOM_EVENT_PEER_DECLINED | Constant |
public static const ROOM_EVENT_PEER_DECLINED:String = onPeerDeclined| ROOM_EVENT_PEER_INVITED | Constant |
public static const ROOM_EVENT_PEER_INVITED:String = onPeerInvitedToRoom| ROOM_EVENT_PEER_JOINED | Constant |
public static const ROOM_EVENT_PEER_JOINED:String = onPeerJoined| ROOM_EVENT_PEER_LEFT | Constant |
public static const ROOM_EVENT_PEER_LEFT:String = onPeerLeft| ROOM_EVENT_PEERS_CONNECTED | Constant |
public static const ROOM_EVENT_PEERS_CONNECTED:String = onPeersConnected| ROOM_EVENT_PEERS_DISCONNECTED | Constant |
public static const ROOM_EVENT_PEERS_DISCONNECTED:String = onPeersDisconnected| ROOM_STATUS_ACTIVE | Constant |
public static const ROOM_STATUS_ACTIVE:int = 3Constant returned by getStatus() indicating that the room is active and connections are established.
| ROOM_STATUS_AUTO_MATCHING | Constant |
public static const ROOM_STATUS_AUTO_MATCHING:int = 1Constant returned by getStatus() indicating that one or more slots are waiting to be filled by auto-matching.
| ROOM_STATUS_CONNECTING | Constant |
public static const ROOM_STATUS_CONNECTING:int = 2Constant returned by getStatus() indicating that this room is waiting for clients to connect to each other.
| ROOM_STATUS_INVITING | Constant |
public static const ROOM_STATUS_INVITING:int = 0Constant returned by getStatus() indicating that the room has one or more players that have been invited and have not responded yet.
| ROOM_VARIANT_DEFAULT | Constant |
public static const ROOM_VARIANT_DEFAULT:int = -1Constant used to indicate that the variant for a room is unspecified.