| Package | com.myflashlab.air.extensions.googleGames |
| Class | public class Participant |
| Inheritance | Participant  Object |
| Property | Defined By | ||
|---|---|---|---|
| displayName : String [read-only]
Return the name to display for this participant. | Participant | ||
| id : String [read-only]
Returns the ID of this participant. | Participant | ||
| isConnectedToRoom : Boolean [read-only]
Retrieves the connected status of the participant. | Participant | ||
| player : Player [read-only]
Returns the Player that this participant represents. | Participant | ||
| result : String [read-only]
Returns the ParticipantResult associated with this participant, if any. | Participant | ||
| Method | Defined By | ||
|---|---|---|---|
loadHiResImage($forceReload:Boolean, $callback:Function):void | Participant | ||
loadIconImage($forceReload:Boolean, $callback:Function):void | Participant | ||
| Constant | Defined By | ||
|---|---|---|---|
| STATUS_DECLINED : int = 3 [static]
Constant indicating that this participant has declined the invitation. | Participant | ||
| STATUS_FINISHED : int = 5 [static]
Constant indicating that this participant is finished with this match. | Participant | ||
| STATUS_INVITED : int = 1 [static]
Constant indicating that this participant has been sent an invitation. | Participant | ||
| STATUS_JOINED : int = 2 [static]
Constant indicating that this participant has accepted the invitation and is joined. | Participant | ||
| STATUS_LEFT : int = 4 [static]
Constant indicating that this participant joined a multiplayer game and subsequently left. | Participant | ||
| STATUS_NOT_INVITED_YET : int = 0 [static]
Constant indicating that this participant has not yet been sent an invitation. | Participant | ||
| STATUS_UNRESPONSIVE : int = 6 [static]
Constant indicating that this participant did not respond to the match in the alloted time. | Participant | ||
| displayName | property |
displayName:String [read-only] Return the name to display for this participant. If the identity of the player is unknown, this will be a generic handle to describe the player.
public function get displayName():String| id | property |
id:String [read-only] Returns the ID of this participant. Note that this is only valid for use in the current multiplayer room or match: a participant will not have the same ID across multiple rooms or matches.
public function get id():String| isConnectedToRoom | property |
isConnectedToRoom:Boolean [read-only] Retrieves the connected status of the participant. If true indicates that participant is in the connected set of the room. Only applies to room participants.
public function get isConnectedToRoom():Boolean| player | property |
player:Player [read-only] Returns the Player that this participant represents. Note that this may be null if the identity of the player is unknown. This occurs in automatching scenarios where some players are not permitted to see the real identity of others.
public function get player():Player| result | property |
result:String [read-only] Returns the ParticipantResult associated with this participant, if any. Only applies to turn-based match participants.
public function get result():String| loadHiResImage | () | method |
public function loadHiResImage($forceReload:Boolean, $callback:Function):void
Parameters
$forceReload:Boolean | |
$callback:Function — expects one param as File object to the image file.
|
| loadIconImage | () | method |
public function loadIconImage($forceReload:Boolean, $callback:Function):void
Parameters
$forceReload:Boolean | |
$callback:Function — expects one param as File object to the image file.
|
| STATUS_DECLINED | Constant |
public static const STATUS_DECLINED:int = 3Constant indicating that this participant has declined the invitation.
| STATUS_FINISHED | Constant |
public static const STATUS_FINISHED:int = 5Constant indicating that this participant is finished with this match. Only applies to turn-based match participants.
| STATUS_INVITED | Constant |
public static const STATUS_INVITED:int = 1Constant indicating that this participant has been sent an invitation.
| STATUS_JOINED | Constant |
public static const STATUS_JOINED:int = 2Constant indicating that this participant has accepted the invitation and is joined.
| STATUS_LEFT | Constant |
public static const STATUS_LEFT:int = 4Constant indicating that this participant joined a multiplayer game and subsequently left.
| STATUS_NOT_INVITED_YET | Constant |
public static const STATUS_NOT_INVITED_YET:int = 0Constant indicating that this participant has not yet been sent an invitation. Only applies to turn-based match participants.
| STATUS_UNRESPONSIVE | Constant |
public static const STATUS_UNRESPONSIVE:int = 6Constant indicating that this participant did not respond to the match in the alloted time. Only applies to turn-based match participants.