Files
vilya/apidocs/com/threerings/parlor/game/data/GameObject.html
T
2011-04-06 17:01:15 -07:00

1264 lines
52 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Wed Apr 06 17:00:09 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
GameObject (vilya 1.3 API)
</TITLE>
<META NAME="date" CONTENT="2011-04-06">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GameObject (vilya 1.3 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GameObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/threerings/parlor/game/data/UserIdentifier.html" title="class in com.threerings.parlor.game.data"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/threerings/parlor/game/data/GameObject.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="GameObject.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_com.threerings.crowd.data.PlaceObject">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.threerings.parlor.game.data</FONT>
<BR>
Class GameObject</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">com.threerings.presents.dobj.DObject
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">com.threerings.crowd.data.PlaceObject
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.parlor.game.data.GameObject</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable</DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/threerings/parlor/card/data/CardGameObject.html" title="class in com.threerings.parlor.card.data">CardGameObject</A>, <A HREF="../../../../../com/threerings/puzzle/data/PuzzleObject.html" title="class in com.threerings.puzzle.data">PuzzleObject</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>GameObject</B><DT>extends com.threerings.crowd.data.PlaceObject</DL>
</PRE>
<P>
A game object hosts the shared data associated with a game played by one or more players. The
game object extends the place object so that the game can act as a place where players actually
go when playing the game. Only very basic information is maintained in the base game object. It
serves as the base for a hierarchy of game object derivatives that handle basic gameplay for a
suite of different game types (ie. turn based games, party games, board games, card games,
etc.).
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="nested_classes_inherited_from_class_com.threerings.crowd.data.PlaceObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from class com.threerings.crowd.data.PlaceObject</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>com.threerings.crowd.data.PlaceObject.ManagerCaller</CODE></TD>
</TR>
</TABLE>
&nbsp;
<A NAME="nested_classes_inherited_from_class_com.threerings.crowd.chat.data.SpeakObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface com.threerings.crowd.chat.data.SpeakObject</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>com.threerings.crowd.chat.data.SpeakObject.ListenerOp</CODE></TD>
</TR>
</TABLE>
&nbsp;
<A NAME="nested_classes_inherited_from_class_com.threerings.io.Streamable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface com.threerings.io.Streamable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>com.threerings.io.Streamable.Closure</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#CANCELLED">CANCELLED</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A game state constant indicating that the game was cancelled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#GAME_OVER">GAME_OVER</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A game state constant indicating that the game ended normally.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#IN_PLAY">IN_PLAY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A game state constant indicating that the game is in play.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#IS_PRIVATE">IS_PRIVATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>isPrivate</code> field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#IS_RATED">IS_RATED</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>isRated</code> field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isPrivate">isPrivate</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the game is "private".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isRated">isRated</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether or not this game is rated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_IN_PLAY">PLAYER_IN_PLAY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The player status constant for a player whose game is in play.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_LEFT_GAME">PLAYER_LEFT_GAME</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The player status constant for a player whose has been knocked out of the game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_STATUS">PLAYER_STATUS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>playerStatus</code> field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;com.threerings.util.Name[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#players">players</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The usernames of the players involved in this game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYERS">PLAYERS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>players</code> field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#playerStatus">playerStatus</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If null, indicates that all present players are active, or for more complex games can be
non-null to indicate the current status of each player in the game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PRE_GAME">PRE_GAME</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A game state constant indicating that the game has not yet started and is still awaiting
the arrival of all of the players.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#SESSION_ID">SESSION_ID</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>sessionId</code> field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#sessionId">sessionId</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A unique identifier for each game session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#state">state</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The game state, one of <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PRE_GAME"><CODE>PRE_GAME</CODE></A>, <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#IN_PLAY"><CODE>IN_PLAY</CODE></A>, <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#GAME_OVER"><CODE>GAME_OVER</CODE></A>, or
<A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#CANCELLED"><CODE>CANCELLED</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#STATE">STATE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>state</code> field.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#winners">winners</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Whether each player in the game is a winner, or null if the game is not yet over.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#WINNERS">WINNERS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The field name of the <code>winners</code> field.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.crowd.data.PlaceObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class com.threerings.crowd.data.PlaceObject</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#GameObject()">GameObject</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#getActivePlayerCount()">getActivePlayerCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of active players in the game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#getPlayerCount()">getPlayerCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of players in the game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#getPlayerIndex(com.threerings.util.Name)">getPlayerIndex</A></B>(com.threerings.util.Name&nbsp;username)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the player index of the given user in the game, or <code>-1</code> if the player is
not involved in the game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#getWinnerCount()">getWinnerCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of winners for this game, or <code>0</code> if the winners array is not
populated, e.g., the game is not yet over.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#getWinnerIndex()">getWinnerIndex</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the winner index of the first winning player for this game, or <code>-1</code> if
there are no winners or the winners array is not yet assigned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isActivePlayer(int)">isActivePlayer</A></B>(int&nbsp;pidx)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the given player is still an active player in the game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isDraw()">isDraw</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the game is ended in a draw.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isInPlay()">isInPlay</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the game is in play.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isOccupiedPlayer(int)">isOccupiedPlayer</A></B>(int&nbsp;pidx)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the given player index in the game is occupied.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isWinner(int)">isWinner</A></B>(int&nbsp;pidx)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the given player index is a winner, or false if the winners are not yet
assigned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setIsPrivate(boolean)">setIsPrivate</A></B>(boolean&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>isPrivate</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setIsRated(boolean)">setIsRated</A></B>(boolean&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>isRated</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayers(com.threerings.util.Name[])">setPlayers</A></B>(com.threerings.util.Name[]&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>players</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayersAt(com.threerings.util.Name, int)">setPlayersAt</A></B>(com.threerings.util.Name&nbsp;value,
int&nbsp;index)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>index</code>th element of
<code>players</code> field be set to the specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayerStatus(int[])">setPlayerStatus</A></B>(int[]&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>playerStatus</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayerStatusAt(int, int)">setPlayerStatusAt</A></B>(int&nbsp;value,
int&nbsp;index)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>index</code>th element of
<code>playerStatus</code> field be set to the specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setSessionId(int)">setSessionId</A></B>(int&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>sessionId</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setState(int)">setState</A></B>(int&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>state</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setWinners(boolean[])">setWinners</A></B>(boolean[]&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>winners</code> field be set to the
specified value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#setWinnersAt(boolean, int)">setWinnersAt</A></B>(boolean&nbsp;value,
int&nbsp;index)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the <code>index</code>th element of
<code>winners</code> field be set to the specified value.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.threerings.crowd.data.PlaceObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.threerings.crowd.data.PlaceObject</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>addToOccupantInfo, addToOccupants, applyToListeners, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.threerings.presents.dobj.DObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.threerings.presents.dobj.DObject</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, readField__oid, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which, writeField__oid</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="STATE"><!-- --></A><H3>
STATE</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>STATE</B></PRE>
<DL>
<DD>The field name of the <code>state</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.STATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="IS_RATED"><!-- --></A><H3>
IS_RATED</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>IS_RATED</B></PRE>
<DL>
<DD>The field name of the <code>isRated</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.IS_RATED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="IS_PRIVATE"><!-- --></A><H3>
IS_PRIVATE</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>IS_PRIVATE</B></PRE>
<DL>
<DD>The field name of the <code>isPrivate</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.IS_PRIVATE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PLAYERS"><!-- --></A><H3>
PLAYERS</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>PLAYERS</B></PRE>
<DL>
<DD>The field name of the <code>players</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.PLAYERS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="WINNERS"><!-- --></A><H3>
WINNERS</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>WINNERS</B></PRE>
<DL>
<DD>The field name of the <code>winners</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.WINNERS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SESSION_ID"><!-- --></A><H3>
SESSION_ID</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>SESSION_ID</B></PRE>
<DL>
<DD>The field name of the <code>sessionId</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.SESSION_ID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PLAYER_STATUS"><!-- --></A><H3>
PLAYER_STATUS</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>PLAYER_STATUS</B></PRE>
<DL>
<DD>The field name of the <code>playerStatus</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.PLAYER_STATUS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRE_GAME"><!-- --></A><H3>
PRE_GAME</H3>
<PRE>
public static final int <B>PRE_GAME</B></PRE>
<DL>
<DD>A game state constant indicating that the game has not yet started and is still awaiting
the arrival of all of the players.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.PRE_GAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="IN_PLAY"><!-- --></A><H3>
IN_PLAY</H3>
<PRE>
public static final int <B>IN_PLAY</B></PRE>
<DL>
<DD>A game state constant indicating that the game is in play.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.IN_PLAY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="GAME_OVER"><!-- --></A><H3>
GAME_OVER</H3>
<PRE>
public static final int <B>GAME_OVER</B></PRE>
<DL>
<DD>A game state constant indicating that the game ended normally.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.GAME_OVER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CANCELLED"><!-- --></A><H3>
CANCELLED</H3>
<PRE>
public static final int <B>CANCELLED</B></PRE>
<DL>
<DD>A game state constant indicating that the game was cancelled.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.CANCELLED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PLAYER_IN_PLAY"><!-- --></A><H3>
PLAYER_IN_PLAY</H3>
<PRE>
public static final int <B>PLAYER_IN_PLAY</B></PRE>
<DL>
<DD>The player status constant for a player whose game is in play.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.PLAYER_IN_PLAY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PLAYER_LEFT_GAME"><!-- --></A><H3>
PLAYER_LEFT_GAME</H3>
<PRE>
public static final int <B>PLAYER_LEFT_GAME</B></PRE>
<DL>
<DD>The player status constant for a player whose has been knocked out of the game. NOTE: This
can include a player choosing to leave a game prematurely.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.threerings.parlor.game.data.GameObject.PLAYER_LEFT_GAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="state"><!-- --></A><H3>
state</H3>
<PRE>
public int <B>state</B></PRE>
<DL>
<DD>The game state, one of <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PRE_GAME"><CODE>PRE_GAME</CODE></A>, <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#IN_PLAY"><CODE>IN_PLAY</CODE></A>, <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#GAME_OVER"><CODE>GAME_OVER</CODE></A>, or
<A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#CANCELLED"><CODE>CANCELLED</CODE></A>.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="isRated"><!-- --></A><H3>
isRated</H3>
<PRE>
public boolean <B>isRated</B></PRE>
<DL>
<DD>Indicates whether or not this game is rated.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="isPrivate"><!-- --></A><H3>
isPrivate</H3>
<PRE>
public boolean <B>isPrivate</B></PRE>
<DL>
<DD>Indicates whether the game is "private".
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="players"><!-- --></A><H3>
players</H3>
<PRE>
public com.threerings.util.Name[] <B>players</B></PRE>
<DL>
<DD>The usernames of the players involved in this game.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="winners"><!-- --></A><H3>
winners</H3>
<PRE>
public boolean[] <B>winners</B></PRE>
<DL>
<DD>Whether each player in the game is a winner, or null if the game is not yet over.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="sessionId"><!-- --></A><H3>
sessionId</H3>
<PRE>
public int <B>sessionId</B></PRE>
<DL>
<DD>A unique identifier for each game session. Every time the game is started, this value will
be incremented to provide a unique identifier for that particular session.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="playerStatus"><!-- --></A><H3>
playerStatus</H3>
<PRE>
public int[] <B>playerStatus</B></PRE>
<DL>
<DD>If null, indicates that all present players are active, or for more complex games can be
non-null to indicate the current status of each player in the game. The status value is one
of <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_LEFT_GAME"><CODE>PLAYER_LEFT_GAME</CODE></A> or <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_IN_PLAY"><CODE>PLAYER_IN_PLAY</CODE></A>.<p> Subclasses of GameObject may use
other means to determine a player's status in the game, so call <A HREF="../../../../../com/threerings/parlor/game/data/GameObject.html#isActivePlayer(int)"><CODE>isActivePlayer(int)</CODE></A>
to see if a player is still participating in a game.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="GameObject()"><!-- --></A><H3>
GameObject</H3>
<PRE>
public <B>GameObject</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getPlayerCount()"><!-- --></A><H3>
getPlayerCount</H3>
<PRE>
public int <B>getPlayerCount</B>()</PRE>
<DL>
<DD>Returns the number of players in the game.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getActivePlayerCount()"><!-- --></A><H3>
getActivePlayerCount</H3>
<PRE>
public int <B>getActivePlayerCount</B>()</PRE>
<DL>
<DD>Returns the number of active players in the game.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isActivePlayer(int)"><!-- --></A><H3>
isActivePlayer</H3>
<PRE>
public boolean <B>isActivePlayer</B>(int&nbsp;pidx)</PRE>
<DL>
<DD>Returns whether the given player is still an active player in the game. (Ie. whether or not
they are still participating.)
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPlayerIndex(com.threerings.util.Name)"><!-- --></A><H3>
getPlayerIndex</H3>
<PRE>
public int <B>getPlayerIndex</B>(com.threerings.util.Name&nbsp;username)</PRE>
<DL>
<DD>Returns the player index of the given user in the game, or <code>-1</code> if the player is
not involved in the game.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isInPlay()"><!-- --></A><H3>
isInPlay</H3>
<PRE>
public boolean <B>isInPlay</B>()</PRE>
<DL>
<DD>Returns whether the game is in play. A game that is not in play could either be awaiting
players, ended, or cancelled.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isOccupiedPlayer(int)"><!-- --></A><H3>
isOccupiedPlayer</H3>
<PRE>
public boolean <B>isOccupiedPlayer</B>(int&nbsp;pidx)</PRE>
<DL>
<DD>Returns whether the given player index in the game is occupied.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isWinner(int)"><!-- --></A><H3>
isWinner</H3>
<PRE>
public boolean <B>isWinner</B>(int&nbsp;pidx)</PRE>
<DL>
<DD>Returns whether the given player index is a winner, or false if the winners are not yet
assigned.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWinnerCount()"><!-- --></A><H3>
getWinnerCount</H3>
<PRE>
public int <B>getWinnerCount</B>()</PRE>
<DL>
<DD>Returns the number of winners for this game, or <code>0</code> if the winners array is not
populated, e.g., the game is not yet over.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isDraw()"><!-- --></A><H3>
isDraw</H3>
<PRE>
public boolean <B>isDraw</B>()</PRE>
<DL>
<DD>Returns true if the game is ended in a draw.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWinnerIndex()"><!-- --></A><H3>
getWinnerIndex</H3>
<PRE>
public int <B>getWinnerIndex</B>()</PRE>
<DL>
<DD>Returns the winner index of the first winning player for this game, or <code>-1</code> if
there are no winners or the winners array is not yet assigned. This is only likely to be
useful for games that are known to have a single winner.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setState(int)"><!-- --></A><H3>
setState</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setState</B>(int&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>state</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setIsRated(boolean)"><!-- --></A><H3>
setIsRated</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setIsRated</B>(boolean&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>isRated</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setIsPrivate(boolean)"><!-- --></A><H3>
setIsPrivate</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setIsPrivate</B>(boolean&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>isPrivate</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPlayers(com.threerings.util.Name[])"><!-- --></A><H3>
setPlayers</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setPlayers</B>(com.threerings.util.Name[]&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>players</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPlayersAt(com.threerings.util.Name, int)"><!-- --></A><H3>
setPlayersAt</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setPlayersAt</B>(com.threerings.util.Name&nbsp;value,
int&nbsp;index)</PRE>
<DL>
<DD>Requests that the <code>index</code>th element of
<code>players</code> field be set to the specified value.
The local value will be updated immediately and an event will be
propagated through the system to notify all listeners that the
attribute did change. Proxied copies of this object (on clients)
will apply the value change when they received the attribute
changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setWinners(boolean[])"><!-- --></A><H3>
setWinners</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setWinners</B>(boolean[]&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>winners</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setWinnersAt(boolean, int)"><!-- --></A><H3>
setWinnersAt</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setWinnersAt</B>(boolean&nbsp;value,
int&nbsp;index)</PRE>
<DL>
<DD>Requests that the <code>index</code>th element of
<code>winners</code> field be set to the specified value.
The local value will be updated immediately and an event will be
propagated through the system to notify all listeners that the
attribute did change. Proxied copies of this object (on clients)
will apply the value change when they received the attribute
changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSessionId(int)"><!-- --></A><H3>
setSessionId</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setSessionId</B>(int&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>sessionId</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPlayerStatus(int[])"><!-- --></A><H3>
setPlayerStatus</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setPlayerStatus</B>(int[]&nbsp;value)</PRE>
<DL>
<DD>Requests that the <code>playerStatus</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPlayerStatusAt(int, int)"><!-- --></A><H3>
setPlayerStatusAt</H3>
<PRE>
<FONT SIZE="-1">@Generated(value="com.threerings.presents.tools.GenDObjectTask")
</FONT>public void <B>setPlayerStatusAt</B>(int&nbsp;value,
int&nbsp;index)</PRE>
<DL>
<DD>Requests that the <code>index</code>th element of
<code>playerStatus</code> field be set to the specified value.
The local value will be updated immediately and an event will be
propagated through the system to notify all listeners that the
attribute did change. Proxied copies of this object (on clients)
will apply the value change when they received the attribute
changed notification.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GameObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/threerings/parlor/game/data/UserIdentifier.html" title="class in com.threerings.parlor.game.data"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/threerings/parlor/game/data/GameObject.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="GameObject.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_com.threerings.crowd.data.PlaceObject">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2011. All Rights Reserved.
</BODY>
</HTML>