987 lines
40 KiB
HTML
987 lines
40 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>
|
|
Table (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="Table (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> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Table.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../com/threerings/parlor/data/RangeParameter.html" title="class in com.threerings.parlor.data"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?com/threerings/parlor/data/Table.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Table.html" target="_top"><B>NO FRAMES</B></A>
|
|
<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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.data</FONT>
|
|
<BR>
|
|
Class Table</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 "><B>com.threerings.parlor.data.Table</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD>com.threerings.io.Streamable, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A>, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.DSet.Entry</DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>Table</B><DT>extends <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><DT>implements com.threerings.presents.dobj.DSet.Entry, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
This class represents a table that is being used to matchmake a game by the Parlor services.
|
|
<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>
|
|
<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>
|
|
|
|
<!-- =========== 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 int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#ANY_POSITION">ANY_POSITION</A></B></CODE>
|
|
|
|
<BR>
|
|
Used to request any position at a table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int[]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#bodyOids">bodyOids</A></B></CODE>
|
|
|
|
<BR>
|
|
The body oids of the players of this table, or null if a party game.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#config">config</A></B></CODE>
|
|
|
|
<BR>
|
|
The game config for the game that is being matchmade.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#gameOid">gameOid</A></B></CODE>
|
|
|
|
<BR>
|
|
The oid of the game that was created from this table or -1 if the table is still in
|
|
matchmaking mode.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#lobbyOid">lobbyOid</A></B></CODE>
|
|
|
|
<BR>
|
|
The object id of the lobby object with which this table is associated.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> com.threerings.util.Name[]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#players">players</A></B></CODE>
|
|
|
|
<BR>
|
|
An array of the usernames of the players of this table (some slots may not be filled), or
|
|
null if a party game.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#tableId">tableId</A></B></CODE>
|
|
|
|
<BR>
|
|
The unique identifier for this table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data">TableConfig</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#tconfig">tconfig</A></B></CODE>
|
|
|
|
<BR>
|
|
The table configuration object.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> com.threerings.util.Name[]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#watchers">watchers</A></B></CODE>
|
|
|
|
<BR>
|
|
An array of the usernames of the non-player occupants of this game.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="fields_inherited_from_class_com.threerings.parlor.data.ParlorCodes"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Fields inherited from interface com.threerings.parlor.data.<A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#ALREADY_AT_TABLE">ALREADY_AT_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#BANNED_FROM_TABLE">BANNED_FROM_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#GAME_ALREADY_STARTED">GAME_ALREADY_STARTED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVALID_TABLE_POSITION">INVALID_TABLE_POSITION</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_ACCEPTED">INVITATION_ACCEPTED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_COUNTERED">INVITATION_COUNTERED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_REFUSED">INVITATION_REFUSED</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITEE_NOT_ONLINE">INVITEE_NOT_ONLINE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#MUST_BE_CREATOR">MUST_BE_CREATOR</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#NO_SELF_BOOT">NO_SELF_BOOT</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#NO_SUCH_TABLE">NO_SUCH_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#NOT_AT_TABLE">NOT_AT_TABLE</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#PARLOR_GROUP">PARLOR_GROUP</A>, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html#TABLE_POSITION_OCCUPIED">TABLE_POSITION_OCCUPIED</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="fields_inherited_from_class_com.threerings.presents.data.InvocationCodes"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Fields inherited from interface com.threerings.presents.data.InvocationCodes</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== 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/data/Table.html#Table()">Table</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Constructs a blank table instance, suitable for unserialization.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== 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> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#addBannedUser(com.threerings.util.Name)">addBannedUser</A></B>(com.threerings.util.Name player)</CODE>
|
|
|
|
<BR>
|
|
Indicate to this table that a user was booted and should
|
|
be prevented from rejoining.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#clearPlayer(com.threerings.util.Name)">clearPlayer</A></B>(com.threerings.util.Name username)</CODE>
|
|
|
|
<BR>
|
|
Requests that the specified user be removed from their seat at this table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#clearPlayerByOid(int)">clearPlayerByOid</A></B>(int bodyOid)</CODE>
|
|
|
|
<BR>
|
|
Requests that the user identified by the specified body object id be removed from their seat
|
|
at this table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#clearPlayerPos(int)">clearPlayerPos</A></B>(int position)</CODE>
|
|
|
|
<BR>
|
|
Called to clear a player at the specified position.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#containsPlayer(com.threerings.util.Name)">containsPlayer</A></B>(com.threerings.util.Name player)</CODE>
|
|
|
|
<BR>
|
|
Returns true if this table contains the specified player.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#equals(java.lang.Object)">equals</A></B>(<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> other)</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A><?></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#getKey()">getKey</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#getOccupiedCount()">getOccupiedCount</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Count the number of players currently occupying this table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> com.threerings.util.Name[]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#getPlayers()">getPlayers</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Once a table is ready to play (see <A HREF="../../../../com/threerings/parlor/data/Table.html#mayBeStarted()"><CODE>mayBeStarted()</CODE></A> and <A HREF="../../../../com/threerings/parlor/data/Table.html#shouldBeStarted()"><CODE>shouldBeStarted()</CODE></A>), the
|
|
players array can be fetched using this method.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int[][]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#getTeamMemberIndices()">getTeamMemberIndices</A></B>()</CODE>
|
|
|
|
<BR>
|
|
For a team game, get the team member indices of the compressed players array returned by
|
|
<A HREF="../../../../com/threerings/parlor/data/Table.html#getPlayers()"><CODE>getPlayers()</CODE></A>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#hashCode()">hashCode</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#init(int, com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig)">init</A></B>(int lobbyOid,
|
|
<A HREF="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data">TableConfig</A> tconfig,
|
|
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A> config)</CODE>
|
|
|
|
<BR>
|
|
Initializes a new table instance, and assigns it the next monotonically increasing table id.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#inPlay()">inPlay</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if this table is in play, false if it is still being matchmade.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#isEmpty()">isEmpty</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if there is no one sitting at this table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#mayBeStarted()">mayBeStarted</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if this table has a sufficient number of players that the game can be
|
|
started.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <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/data/Table.html#setPlayer(int, com.threerings.crowd.data.BodyObject)">setPlayer</A></B>(int position,
|
|
com.threerings.crowd.data.BodyObject player)</CODE>
|
|
|
|
<BR>
|
|
Requests to seat the specified user at the specified position in this table.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#setPlayerPos(int, com.threerings.crowd.data.BodyObject)">setPlayerPos</A></B>(int position,
|
|
com.threerings.crowd.data.BodyObject player)</CODE>
|
|
|
|
<BR>
|
|
This method is used for party games, it does no bounds checking or verification of the
|
|
player's ability to join, if you are unsure you should call 'setPlayer'.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#shouldBeStarted()">shouldBeStarted</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if sufficient seats are occupied that the game should be automatically started.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <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/data/Table.html#toString()">toString</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../com/threerings/parlor/data/Table.html#updateOccupants(com.threerings.parlor.game.data.GameObject)">updateOccupants</A></B>(<A HREF="../../../../com/threerings/parlor/game/data/GameObject.html" title="class in com.threerings.parlor.game.data">GameObject</A> gameobj)</CODE>
|
|
|
|
<BR>
|
|
Called by the table manager when the game object's players have changed.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<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#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#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>
|
|
|
|
<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="ANY_POSITION"><!-- --></A><H3>
|
|
ANY_POSITION</H3>
|
|
<PRE>
|
|
public static final int <B>ANY_POSITION</B></PRE>
|
|
<DL>
|
|
<DD>Used to request any position at a table.
|
|
<P>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.threerings.parlor.data.Table.ANY_POSITION">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="tableId"><!-- --></A><H3>
|
|
tableId</H3>
|
|
<PRE>
|
|
public int <B>tableId</B></PRE>
|
|
<DL>
|
|
<DD>The unique identifier for this table.
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="lobbyOid"><!-- --></A><H3>
|
|
lobbyOid</H3>
|
|
<PRE>
|
|
public int <B>lobbyOid</B></PRE>
|
|
<DL>
|
|
<DD>The object id of the lobby object with which this table is associated.
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="gameOid"><!-- --></A><H3>
|
|
gameOid</H3>
|
|
<PRE>
|
|
public int <B>gameOid</B></PRE>
|
|
<DL>
|
|
<DD>The oid of the game that was created from this table or -1 if the table is still in
|
|
matchmaking mode.
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="players"><!-- --></A><H3>
|
|
players</H3>
|
|
<PRE>
|
|
public com.threerings.util.Name[] <B>players</B></PRE>
|
|
<DL>
|
|
<DD>An array of the usernames of the players of this table (some slots may not be filled), or
|
|
null if a party game.
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="watchers"><!-- --></A><H3>
|
|
watchers</H3>
|
|
<PRE>
|
|
public com.threerings.util.Name[] <B>watchers</B></PRE>
|
|
<DL>
|
|
<DD>An array of the usernames of the non-player occupants of this game. For FFA party games
|
|
this is all of a room's occupants and they are in fact players.
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="bodyOids"><!-- --></A><H3>
|
|
bodyOids</H3>
|
|
<PRE>
|
|
public transient int[] <B>bodyOids</B></PRE>
|
|
<DL>
|
|
<DD>The body oids of the players of this table, or null if a party game. (This is not
|
|
propagated to remote instances.)
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="config"><!-- --></A><H3>
|
|
config</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A> <B>config</B></PRE>
|
|
<DL>
|
|
<DD>The game config for the game that is being matchmade.
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="tconfig"><!-- --></A><H3>
|
|
tconfig</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data">TableConfig</A> <B>tconfig</B></PRE>
|
|
<DL>
|
|
<DD>The table configuration object.
|
|
<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="Table()"><!-- --></A><H3>
|
|
Table</H3>
|
|
<PRE>
|
|
public <B>Table</B>()</PRE>
|
|
<DL>
|
|
<DD>Constructs a blank table instance, suitable for unserialization.
|
|
<P>
|
|
</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="init(int, com.threerings.parlor.data.TableConfig, com.threerings.parlor.game.data.GameConfig)"><!-- --></A><H3>
|
|
init</H3>
|
|
<PRE>
|
|
public void <B>init</B>(int lobbyOid,
|
|
<A HREF="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data">TableConfig</A> tconfig,
|
|
<A HREF="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</A> config)</PRE>
|
|
<DL>
|
|
<DD>Initializes a new table instance, and assigns it the next monotonically increasing table id.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lobbyOid</CODE> - the object id of the lobby in which this table is to live.<DD><CODE>tconfig</CODE> - the table configuration for this table.<DD><CODE>config</CODE> - the configuration of the game being matchmade by this table.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isEmpty()"><!-- --></A><H3>
|
|
isEmpty</H3>
|
|
<PRE>
|
|
public boolean <B>isEmpty</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if there is no one sitting at this table.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getOccupiedCount()"><!-- --></A><H3>
|
|
getOccupiedCount</H3>
|
|
<PRE>
|
|
public int <B>getOccupiedCount</B>()</PRE>
|
|
<DL>
|
|
<DD>Count the number of players currently occupying this table.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPlayers()"><!-- --></A><H3>
|
|
getPlayers</H3>
|
|
<PRE>
|
|
public com.threerings.util.Name[] <B>getPlayers</B>()</PRE>
|
|
<DL>
|
|
<DD>Once a table is ready to play (see <A HREF="../../../../com/threerings/parlor/data/Table.html#mayBeStarted()"><CODE>mayBeStarted()</CODE></A> and <A HREF="../../../../com/threerings/parlor/data/Table.html#shouldBeStarted()"><CODE>shouldBeStarted()</CODE></A>), the
|
|
players array can be fetched using this method. It will return an array containing the
|
|
usernames of all of the players in the game, sized properly and with each player in the
|
|
appropriate position.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTeamMemberIndices()"><!-- --></A><H3>
|
|
getTeamMemberIndices</H3>
|
|
<PRE>
|
|
public int[][] <B>getTeamMemberIndices</B>()</PRE>
|
|
<DL>
|
|
<DD>For a team game, get the team member indices of the compressed players array returned by
|
|
<A HREF="../../../../com/threerings/parlor/data/Table.html#getPlayers()"><CODE>getPlayers()</CODE></A>.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPlayer(int, com.threerings.crowd.data.BodyObject)"><!-- --></A><H3>
|
|
setPlayer</H3>
|
|
<PRE>
|
|
public <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>setPlayer</B>(int position,
|
|
com.threerings.crowd.data.BodyObject player)</PRE>
|
|
<DL>
|
|
<DD>Requests to seat the specified user at the specified position in this table.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>position</CODE> - the position in which to seat the user.<DD><CODE>player</CODE> - the player to set.
|
|
<DT><B>Returns:</B><DD>null if the user was successfully seated, a string error code explaining the failure
|
|
if the user was not able to be seated at that position.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPlayerPos(int, com.threerings.crowd.data.BodyObject)"><!-- --></A><H3>
|
|
setPlayerPos</H3>
|
|
<PRE>
|
|
public void <B>setPlayerPos</B>(int position,
|
|
com.threerings.crowd.data.BodyObject player)</PRE>
|
|
<DL>
|
|
<DD>This method is used for party games, it does no bounds checking or verification of the
|
|
player's ability to join, if you are unsure you should call 'setPlayer'.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addBannedUser(com.threerings.util.Name)"><!-- --></A><H3>
|
|
addBannedUser</H3>
|
|
<PRE>
|
|
public void <B>addBannedUser</B>(com.threerings.util.Name player)</PRE>
|
|
<DL>
|
|
<DD>Indicate to this table that a user was booted and should
|
|
be prevented from rejoining.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="clearPlayer(com.threerings.util.Name)"><!-- --></A><H3>
|
|
clearPlayer</H3>
|
|
<PRE>
|
|
public boolean <B>clearPlayer</B>(com.threerings.util.Name username)</PRE>
|
|
<DL>
|
|
<DD>Requests that the specified user be removed from their seat at this table.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>true if the user was seated at the table and has now been removed, false if the user
|
|
was never seated at the table in the first place.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="clearPlayerByOid(int)"><!-- --></A><H3>
|
|
clearPlayerByOid</H3>
|
|
<PRE>
|
|
public boolean <B>clearPlayerByOid</B>(int bodyOid)</PRE>
|
|
<DL>
|
|
<DD>Requests that the user identified by the specified body object id be removed from their seat
|
|
at this table.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>true if the user was seated at the table and has now been removed, false if the user
|
|
was never seated at the table in the first place.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="clearPlayerPos(int)"><!-- --></A><H3>
|
|
clearPlayerPos</H3>
|
|
<PRE>
|
|
public void <B>clearPlayerPos</B>(int position)</PRE>
|
|
<DL>
|
|
<DD>Called to clear a player at the specified position. Only call this method if you know what
|
|
you're doing.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="containsPlayer(com.threerings.util.Name)"><!-- --></A><H3>
|
|
containsPlayer</H3>
|
|
<PRE>
|
|
public boolean <B>containsPlayer</B>(com.threerings.util.Name player)</PRE>
|
|
<DL>
|
|
<DD>Returns true if this table contains the specified player.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="updateOccupants(com.threerings.parlor.game.data.GameObject)"><!-- --></A><H3>
|
|
updateOccupants</H3>
|
|
<PRE>
|
|
public void <B>updateOccupants</B>(<A HREF="../../../../com/threerings/parlor/game/data/GameObject.html" title="class in com.threerings.parlor.game.data">GameObject</A> gameobj)</PRE>
|
|
<DL>
|
|
<DD>Called by the table manager when the game object's players have changed. Regenerates the
|
|
<A HREF="../../../../com/threerings/parlor/data/Table.html#watchers"><CODE>watchers</CODE></A> array.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="mayBeStarted()"><!-- --></A><H3>
|
|
mayBeStarted</H3>
|
|
<PRE>
|
|
public boolean <B>mayBeStarted</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if this table has a sufficient number of players that the game can be
|
|
started.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="shouldBeStarted()"><!-- --></A><H3>
|
|
shouldBeStarted</H3>
|
|
<PRE>
|
|
public boolean <B>shouldBeStarted</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if sufficient seats are occupied that the game should be automatically started.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="inPlay()"><!-- --></A><H3>
|
|
inPlay</H3>
|
|
<PRE>
|
|
public boolean <B>inPlay</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if this table is in play, false if it is still being matchmade.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getKey()"><!-- --></A><H3>
|
|
getKey</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A><?> <B>getKey</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>getKey</CODE> in interface <CODE>com.threerings.presents.dobj.DSet.Entry</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
|
|
equals</H3>
|
|
<PRE>
|
|
public boolean <B>equals</B>(<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> other)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><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></CODE> in class <CODE><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></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="hashCode()"><!-- --></A><H3>
|
|
hashCode</H3>
|
|
<PRE>
|
|
public int <B>hashCode</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="toString()"><!-- --></A><H3>
|
|
toString</H3>
|
|
<PRE>
|
|
public <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>toString</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><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></CODE></DL>
|
|
</DD>
|
|
<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> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Table.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../com/threerings/parlor/data/RangeParameter.html" title="class in com.threerings.parlor.data"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?com/threerings/parlor/data/Table.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Table.html" target="_top"><B>NO FRAMES</B></A>
|
|
<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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
Copyright © 2011. All Rights Reserved.
|
|
</BODY>
|
|
</HTML>
|