File: Games\GamesByEmail.js

GamesByEmail
Class Team

Object
  
 
 
GamesByEmail.Team

All Implemented Interfaces:

Class


GamesByEmail.Team

implements Foundation.Class

Information about a team.


Constructor Summary
GamesByEmail.Team()

Field Summary
Numbercolor
The color of this team. Not set directly by data, but by processing.
Gamegame
The game object this team belongs to.
Numberid
The unique ID for this team, or 0 if the current user is not a player on this team.
Numberindex
The index of this team in the parent collection.
Infoinfo
The team specific state data.
BooleanisUs
If the current user is a direct player on this team.
Stringmessage
The message visible only to players in of this team or its child teams.
TeamNotifynotify
The notification types of the team.
Playersplayers
The players of this team.
TeamStatusstatus
Varius status flags of the team.
Teamteam
The parent team object this team belongs to, or null.
Teamsteams
The sub teams of this team.
Stringtitle
The title of this team. Not set directly by data, but by processing.

Method Summary
voidclearNotifications()
Clears the notification flags of this team and every sub team.
voidclearTurns()
Clears the turn flag of this team and every sub team.
 dispose()
 hasSecure(infoData)
BooleanisMyTurn()
Determines if it is this teams turn.
BooleanisPlaying()
Determines of this team is playing. In play, not won, not drew, not resigned, not non-playing.
TeamnextTeam(/*Boolean*/ playing)
Finds the next sibling team.
voidsetExclusiveTurn()
Sets this team to have the exclusive turn in the game.
TeamteamAtOffset(/*Number*/ offset)
Finds the sibling team at an offset.

Methods inherited from Foundation.Class
getTypePath, isInstanceOf

Constructor Detail

Team

GamesByEmail.Team()

Field Detail

color

Number color

The color of this team. Not set directly by data, but by processing.


game

Game game

The game object this team belongs to.


id

Number id

The unique ID for this team, or 0 if the current user is not a player on this team.


index

Number index

The index of this team in the parent collection.


info

Info info

The team specific state data.


isUs

Boolean isUs

If the current user is a direct player on this team.


message

String message

The message visible only to players in of this team or its child teams.


notify

TeamNotify notify

The notification types of the team.


players

Players players

The players of this team.


status

TeamStatus status

Varius status flags of the team.


team

Team team

The parent team object this team belongs to, or null.


teams

Teams teams

The sub teams of this team.


title

String title

The title of this team. Not set directly by data, but by processing.

Method Detail

clearNotifications

void clearNotifications()

Clears the notification flags of this team and every sub team.


clearTurns

void clearTurns()

Clears the turn flag of this team and every sub team.


dispose

dispose()
Overrides:
dispose in class Class

hasSecure

hasSecure(infoData)
Parameters:
infoData - 


isMyTurn

Boolean isMyTurn()

Determines if it is this teams turn.

Returns:
The whether it is this teams turn.

isPlaying

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.

nextTeam

Team nextTeam(/*Boolean*/ playing)

Finds the next sibling team.

Parameters:
playing - 
(Optional) Skip turns that are not playing. Defaults to false.
Returns:
The next sibling team.
See Also:
isPlaying

setExclusiveTurn

void setExclusiveTurn()

Sets this team to have the exclusive turn in the game.


teamAtOffset

Team teamAtOffset(/*Number*/ offset)

Finds the sibling team at an offset.

Parameters:
offset - 
The offset, positive for next teams, negative for previous teams.
Returns:
The sibling team at the offset. Wraps.