AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ccf127a3bbec367664de38da118dbb6f2fd1d465
vilya/apidocs/com/threerings/puzzle/server/PuzzleManager.html
T
Michael Bayne ccf127a3bb API docs for 1.3 release.
2011-04-06 17:01:15 -07:00

513 lines
32 KiB
HTML
Raw Blame History

<!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:12 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PuzzleManager (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="PuzzleManager (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/PuzzleManager.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/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/threerings/puzzle/server/PuzzleManagerDelegate.html" title="class in com.threerings.puzzle.server"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/threerings/puzzle/server/PuzzleManager.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="PuzzleManager.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.server.PlaceManager">NESTED</A>&nbsp;|&nbsp;FIELD&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;FIELD&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.puzzle.server</FONT>
<BR>
Class PuzzleManager</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.crowd.server.PlaceManager
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">com.threerings.parlor.game.server.GameManager</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.puzzle.server.PuzzleManager</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, <A HREF="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</A>, <A HREF="../../../../com/threerings/parlor/game/data/GameCodes.html" title="interface in com.threerings.parlor.game.data">GameCodes</A>, <A HREF="../../../../com/threerings/parlor/server/PlayManager.html" title="interface in com.threerings.parlor.server">PlayManager</A>, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener, com.threerings.presents.server.InvocationProvider, <A HREF="../../../../com/threerings/puzzle/data/PuzzleCodes.html" title="interface in com.threerings.puzzle.data">PuzzleCodes</A>, <A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server">PuzzleGameProvider</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>PuzzleManager</B><DT>extends <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">GameManager</A><DT>implements <A HREF="../../../../com/threerings/puzzle/data/PuzzleCodes.html" title="interface in com.threerings.puzzle.data">PuzzleCodes</A>, <A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server">PuzzleGameProvider</A></DL>
</PRE>
<P>
Extends the <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> with facilities for puzzle games.
<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.server.PlaceManager"><!-- --></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.server.PlaceManager</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler</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>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.puzzle.data.PuzzleCodes"><!-- --></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.puzzle.data.<A HREF="../../../../com/threerings/puzzle/data/PuzzleCodes.html" title="interface in com.threerings.puzzle.data">PuzzleCodes</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/threerings/puzzle/data/PuzzleCodes.html#DEBUG_PUZZLE">DEBUG_PUZZLE</A>, <A HREF="../../../../com/threerings/puzzle/data/PuzzleCodes.html#DEFAULT_DIFFICULTY">DEFAULT_DIFFICULTY</A>, <A HREF="../../../../com/threerings/puzzle/data/PuzzleCodes.html#PUZZLE_MESSAGE_BUNDLE">PUZZLE_MESSAGE_BUNDLE</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;<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>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.parlor.game.data.GameCodes"><!-- --></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.game.data.<A HREF="../../../../com/threerings/parlor/game/data/GameCodes.html" title="interface in com.threerings.parlor.game.data">GameCodes</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/threerings/parlor/game/data/GameCodes.html#GAME_CHAT_TYPE">GAME_CHAT_TYPE</A>, <A HREF="../../../../com/threerings/parlor/game/data/GameCodes.html#GAME_MESSAGE_BUNDLE">GAME_MESSAGE_BUNDLE</A>, <A HREF="../../../../com/threerings/parlor/game/data/GameCodes.html#PLAYER_KNOCKED_OUT">PLAYER_KNOCKED_OUT</A>, <A HREF="../../../../com/threerings/parlor/game/data/GameCodes.html#WINNERS_AND_LOSERS">WINNERS_AND_LOSERS</A></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/puzzle/server/PuzzleManager.html#PuzzleManager()">PuzzleManager</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;<A HREF="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/puzzle/server/PuzzleManager.html#getBoards()">getBoards</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the boards for all players.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/threerings/puzzle/data/BoardSummary.html" title="class in com.threerings.puzzle.data">BoardSummary</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/threerings/puzzle/server/PuzzleManager.html#getBoardSummary(int)">getBoardSummary</A></B>(int&nbsp;pidx)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the board summary for the given player index.</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/puzzle/server/PuzzleManager.html#needsBoardSummaries()">needsBoardSummaries</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether this puzzle cares to make use of per-player board summaries that are sent
periodically to all users in the puzzle via <A HREF="../../../../com/threerings/puzzle/server/PuzzleManager.html#sendStatusUpdate()"><CODE>sendStatusUpdate()</CODE></A>.</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/puzzle/server/PuzzleManager.html#updateBoardSummaries()">updateBoardSummaries</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Applies updateBoardSummary on all the players' boards.</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/puzzle/server/PuzzleManager.html#updateBoardSummary(int)">updateBoardSummary</A></B>(int&nbsp;pidx)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls <A HREF="../../../../com/threerings/puzzle/data/BoardSummary.html#summarize()"><CODE>BoardSummary.summarize()</CODE></A> on the given player's board summary to refresh the
summary information in preparation for sending along to the client(s).</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/puzzle/server/PuzzleManager.html#updateProgress(com.threerings.presents.data.ClientObject, int, int[])">updateProgress</A></B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;sessionId,
int[]&nbsp;events)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a <A HREF="../../../../com/threerings/puzzle/client/PuzzleGameService.html#updateProgress(int, int[])"><CODE>PuzzleGameService.updateProgress(int, int[])</CODE></A> request.</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/puzzle/server/PuzzleManager.html#updateProgressSync(com.threerings.presents.data.ClientObject, int, int[], com.threerings.puzzle.data.Board[])">updateProgressSync</A></B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;sessionId,
int[]&nbsp;events,
<A HREF="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</A>[]&nbsp;states)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when the puzzle manager receives a progress update.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.threerings.parlor.game.server.GameManager"><!-- --></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.parlor.game.server.<A HREF="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">GameManager</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#addPlayer(com.threerings.util.Name)">addPlayer</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#addPlayerAt(com.threerings.util.Name, int)">addPlayerAt</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#allPlayersReady()">allPlayersReady</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#cancelGame()">cancelGame</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#checkWritePermission(com.threerings.presents.data.ClientObject, int)">checkWritePermission</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#endGame()">endGame</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#endPlayerGame(int)">endPlayerGame</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getGameConfig()">getGameConfig</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getGameId()">getGameId</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getMatchType()">getMatchType</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayer(int)">getPlayer</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerCount()">getPlayerCount</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerDisplayName(int)">getPlayerDisplayName</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerIndex(com.threerings.util.Name)">getPlayerIndex</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerName(int)">getPlayerName</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerOid(int)">getPlayerOid</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerPersistentId(com.threerings.crowd.data.BodyObject)">getPlayerPersistentId</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerPersistentId(com.threerings.util.Name)">getPlayerPersistentId</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPlayerSlots()">getPlayerSlots</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getPresentPlayerIndex(int)">getPresentPlayerIndex</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#getSessionId()">getSessionId</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#isActivePlayer(int)">isActivePlayer</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#isAgent(com.threerings.presents.data.ClientObject)">isAgent</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#isAI(int)">isAI</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#isPlayer(com.threerings.presents.data.ClientObject)">isPlayer</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#occupantInRoom(com.threerings.crowd.data.BodyObject)">occupantInRoom</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#playerIsReady(int)">playerIsReady</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#playerReady(com.threerings.crowd.data.BodyObject)">playerReady</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#removePlayer(com.threerings.util.Name)">removePlayer</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#replacePlayer(int, com.threerings.util.Name)">replacePlayer</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#resetGame()">resetGame</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#setAI(int, com.threerings.parlor.game.data.GameAI)">setAI</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#shouldConcludeGame()">shouldConcludeGame</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#startGame()">startGame</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#systemMessage(java.lang.String, java.lang.String)">systemMessage</A>, <A HREF="../../../../com/threerings/parlor/game/server/GameManager.html#systemMessage(java.lang.String, java.lang.String, boolean)">systemMessage</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.threerings.crowd.server.PlaceManager"><!-- --></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.server.PlaceManager</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where</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>
<!-- ========= 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="PuzzleManager()"><!-- --></A><H3>
PuzzleManager</H3>
<PRE>
public <B>PuzzleManager</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="getBoards()"><!-- --></A><H3>
getBoards</H3>
<PRE>
public <A HREF="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</A>[] <B>getBoards</B>()</PRE>
<DL>
<DD>Returns the boards for all players.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBoardSummary(int)"><!-- --></A><H3>
getBoardSummary</H3>
<PRE>
public <A HREF="../../../../com/threerings/puzzle/data/BoardSummary.html" title="class in com.threerings.puzzle.data">BoardSummary</A> <B>getBoardSummary</B>(int&nbsp;pidx)</PRE>
<DL>
<DD>Returns the board summary for the given player index.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="needsBoardSummaries()"><!-- --></A><H3>
needsBoardSummaries</H3>
<PRE>
public boolean <B>needsBoardSummaries</B>()</PRE>
<DL>
<DD>Returns whether this puzzle cares to make use of per-player board summaries that are sent
periodically to all users in the puzzle via <A HREF="../../../../com/threerings/puzzle/server/PuzzleManager.html#sendStatusUpdate()"><CODE>sendStatusUpdate()</CODE></A>. The default
implementation returns <code>false</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="updateBoardSummary(int)"><!-- --></A><H3>
updateBoardSummary</H3>
<PRE>
public void <B>updateBoardSummary</B>(int&nbsp;pidx)</PRE>
<DL>
<DD>Calls <A HREF="../../../../com/threerings/puzzle/data/BoardSummary.html#summarize()"><CODE>BoardSummary.summarize()</CODE></A> on the given player's board summary to refresh the
summary information in preparation for sending along to the client(s).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pidx</CODE> - the player index of the player whose board is to be summarized.</DL>
</DD>
</DL>
<HR>
<A NAME="updateBoardSummaries()"><!-- --></A><H3>
updateBoardSummaries</H3>
<PRE>
public void <B>updateBoardSummaries</B>()</PRE>
<DL>
<DD>Applies updateBoardSummary on all the players' boards. AI board summaries should be updated
by the AI logic.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="updateProgress(com.threerings.presents.data.ClientObject, int, int[])"><!-- --></A><H3>
updateProgress</H3>
<PRE>
public void <B>updateProgress</B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;sessionId,
int[]&nbsp;events)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html#updateProgress(com.threerings.presents.data.ClientObject, int, int[])">PuzzleGameProvider</A></CODE></B></DD>
<DD>Handles a <A HREF="../../../../com/threerings/puzzle/client/PuzzleGameService.html#updateProgress(int, int[])"><CODE>PuzzleGameService.updateProgress(int, int[])</CODE></A> request.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html#updateProgress(com.threerings.presents.data.ClientObject, int, int[])">updateProgress</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server">PuzzleGameProvider</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="updateProgressSync(com.threerings.presents.data.ClientObject, int, int[], com.threerings.puzzle.data.Board[])"><!-- --></A><H3>
updateProgressSync</H3>
<PRE>
public void <B>updateProgressSync</B>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;sessionId,
int[]&nbsp;events,
<A HREF="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</A>[]&nbsp;states)</PRE>
<DL>
<DD>Called when the puzzle manager receives a progress update. It checks to make sure that the
progress update is valid and the puzzle is still in play and then applies the updates via
<A HREF="../../../../com/threerings/puzzle/server/PuzzleManager.html#applyProgressEvents(int, int[], com.threerings.puzzle.data.Board[])"><CODE>applyProgressEvents(int, int[], com.threerings.puzzle.data.Board[])</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html#updateProgressSync(com.threerings.presents.data.ClientObject, int, int[], com.threerings.puzzle.data.Board[])">updateProgressSync</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server">PuzzleGameProvider</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>&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/PuzzleManager.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/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/threerings/puzzle/server/PuzzleManagerDelegate.html" title="class in com.threerings.puzzle.server"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/threerings/puzzle/server/PuzzleManager.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="PuzzleManager.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.server.PlaceManager">NESTED</A>&nbsp;|&nbsp;FIELD&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;FIELD&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>
Reference in New Issue View Git Blame Copy Permalink