Games\GamesByEmail.js
GamesByEmail
Object
All Implemented Interfaces:
GamesByEmail.Team
implementsFoundation.Class
Information about a team.
Constructor Summary |
|
Field Summary | |
| color
The color of this team. Not set directly by data, but by processing.
|
| game
The game object this team belongs to.
|
| id
The unique ID for this team, or 0 if the current user is not a player on this team.
|
| index
The index of this team in the parent collection.
|
| info
The team specific state data.
|
| isUs
If the current user is a direct player on this team.
|
| message
The message visible only to players in of this team or its child teams.
|
| notify
The notification types of the team.
|
| players
The players of this team.
|
| status
Varius status flags of the team.
|
| team
The parent team object this team belongs to, or
null . |
| teams
The sub teams of this team.
|
| title
The title of this team. Not set directly by data, but by processing.
|
Method Summary | |
|
Clears the notification flags of this team and every sub team.
|
|
Clears the turn flag of this team and every sub team.
|
|
|
|
|
|
Determines if it is this teams turn.
|
|
Determines of this team is playing. In play, not won, not drew, not resigned, not non-playing.
|
|
Finds the next sibling team.
|
|
Sets this team to have the exclusive turn in the game.
|
|
Finds the sibling team at an offset.
|
Methods inherited from Foundation.Class |
getTypePath , isInstanceOf |
Constructor Detail |
GamesByEmail.Team()
Field Detail |
Number
color
The color of this team. Not set directly by data, but by processing.
Game
game
The game object this team belongs to.
Number
id
The unique ID for this team, or 0 if the current user is not a player on this team.
Number
index
The index of this team in the parent collection.
Info
info
The team specific state data.
Boolean
isUs
If the current user is a direct player on this team.
String
message
The message visible only to players in of this team or its child teams.
TeamNotify
notify
The notification types of the team.
Players
players
The players of this team.
TeamStatus
status
Varius status flags of the team.
Team
team
The parent team object this team belongs to, or null
.
Teams
teams
The sub teams of this team.
String
title
The title of this team. Not set directly by data, but by processing.
Method Detail |
void
clearNotifications()
Clears the notification flags of this team and every sub team.
void
clearTurns()
Clears the turn flag of this team and every sub team.
dispose()
dispose
in class Class
hasSecure(infoData)
infoData -
Boolean
isMyTurn()
Determines if it is this teams turn.
Returns:
Boolean
isPlaying()
Determines of this team is playing. In play, not won, not drew, not resigned, not non-playing.
Returns:true
if this team is playing.
Team
nextTeam(/*Boolean
*/ playing)
Finds the next sibling team.
Parameters:playing -(Optional) Skip turns that are not playing. Defaults to
false
.
void
setExclusiveTurn()
Sets this team to have the exclusive turn in the game.
Team
teamAtOffset(/*Number
*/ offset)
Finds the sibling team at an offset.
Parameters:offset -The offset, positive for next teams, negative for previous teams.