AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/puzzle/server/PuzzleManager.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

485 lines
30 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 lang="en">
<head>
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 14 10:07:09 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PuzzleManager (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PuzzleManager (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PuzzleManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/puzzle/server/PuzzleManagerDelegate.html" title="class in com.threerings.puzzle.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/puzzle/server/PuzzleManager.html" target="_top">Frames</a></li>
<li><a href="PuzzleManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.com.threerings.crowd.server.PlaceManager">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.puzzle.server</div>
<h2 title="Class PuzzleManager" class="title">Class PuzzleManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.crowd.server.PlaceManager</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">com.threerings.parlor.game.server.GameManager</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.puzzle.server.PuzzleManager</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<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>
<br>
<pre>public abstract class <span class="typeNameLabel">PuzzleManager</span>
extends <a href="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">GameManager</a>
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></pre>
<div class="block">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.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.crowd.server.PlaceManager">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.threerings.crowd.server.PlaceManager</h3>
<code>com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.puzzle.data.PuzzleCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.puzzle.data.<a href="../../../../com/threerings/puzzle/data/PuzzleCodes.html" title="interface in com.threerings.puzzle.data">PuzzleCodes</a></h3>
<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.presents.data.InvocationCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.presents.data.InvocationCodes</h3>
<code>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.parlor.data.ParlorCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.parlor.data.<a href="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</a></h3>
<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.parlor.game.data.GameCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.parlor.game.data.<a href="../../../../com/threerings/parlor/game/data/GameCodes.html" title="interface in com.threerings.parlor.game.data">GameCodes</a></h3>
<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></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#PuzzleManager--">PuzzleManager</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#getBoards--">getBoards</a></span>()</code>
<div class="block">Returns the boards for all players.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/threerings/puzzle/data/BoardSummary.html" title="class in com.threerings.puzzle.data">BoardSummary</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#getBoardSummary-int-">getBoardSummary</a></span>(int&nbsp;pidx)</code>
<div class="block">Returns the board summary for the given player index.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#needsBoardSummaries--">needsBoardSummaries</a></span>()</code>
<div class="block">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>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#updateBoardSummaries--">updateBoardSummaries</a></span>()</code>
<div class="block">Applies updateBoardSummary on all the players' boards.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#updateBoardSummary-int-">updateBoardSummary</a></span>(int&nbsp;pidx)</code>
<div class="block">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).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#updateProgress-com.threerings.presents.data.ClientObject-int-int:A-">updateProgress</a></span>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;sessionId,
int[]&nbsp;events)</code>
<div class="block">Handles a <a href="../../../../com/threerings/puzzle/client/PuzzleGameService.html#updateProgress-int-int:A-"><code>PuzzleGameService.updateProgress(int, int[])</code></a> request.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/server/PuzzleManager.html#updateProgressSync-com.threerings.presents.data.ClientObject-int-int:A-com.threerings.puzzle.data.Board:A-">updateProgressSync</a></span>(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>
<div class="block">Called when the puzzle manager receives a progress update.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.parlor.game.server.GameManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.parlor.game.server.<a href="../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">GameManager</a></h3>
<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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.crowd.server.PlaceManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.crowd.server.PlaceManager</h3>
<code>addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getLocation, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo, where</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PuzzleManager--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PuzzleManager</h4>
<pre>public&nbsp;PuzzleManager()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getBoards--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoards</h4>
<pre>public&nbsp;<a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>[]&nbsp;getBoards()</pre>
<div class="block">Returns the boards for all players.</div>
</li>
</ul>
<a name="getBoardSummary-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoardSummary</h4>
<pre>public&nbsp;<a href="../../../../com/threerings/puzzle/data/BoardSummary.html" title="class in com.threerings.puzzle.data">BoardSummary</a>&nbsp;getBoardSummary(int&nbsp;pidx)</pre>
<div class="block">Returns the board summary for the given player index.</div>
</li>
</ul>
<a name="needsBoardSummaries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>needsBoardSummaries</h4>
<pre>public&nbsp;boolean&nbsp;needsBoardSummaries()</pre>
<div class="block">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>.</div>
</li>
</ul>
<a name="updateBoardSummary-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateBoardSummary</h4>
<pre>public&nbsp;void&nbsp;updateBoardSummary(int&nbsp;pidx)</pre>
<div class="block">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).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pidx</code> - the player index of the player whose board is to be summarized.</dd>
</dl>
</li>
</ul>
<a name="updateBoardSummaries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateBoardSummaries</h4>
<pre>public&nbsp;void&nbsp;updateBoardSummaries()</pre>
<div class="block">Applies updateBoardSummary on all the players' boards. AI board summaries should be updated
by the AI logic.</div>
</li>
</ul>
<a name="updateProgress-com.threerings.presents.data.ClientObject-int-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateProgress</h4>
<pre>public&nbsp;void&nbsp;updateProgress(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;sessionId,
int[]&nbsp;events)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html#updateProgress-com.threerings.presents.data.ClientObject-int-int:A-">PuzzleGameProvider</a></code></span></div>
<div class="block">Handles a <a href="../../../../com/threerings/puzzle/client/PuzzleGameService.html#updateProgress-int-int:A-"><code>PuzzleGameService.updateProgress(int, int[])</code></a> request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html#updateProgress-com.threerings.presents.data.ClientObject-int-int:A-">updateProgress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server">PuzzleGameProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="updateProgressSync-com.threerings.presents.data.ClientObject-int-int:A-com.threerings.puzzle.data.Board:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>updateProgressSync</h4>
<pre>public&nbsp;void&nbsp;updateProgressSync(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>
<div class="block">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:A-com.threerings.puzzle.data.Board:A-"><code>applyProgressEvents(int, int[], com.threerings.puzzle.data.Board[])</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html#updateProgressSync-com.threerings.presents.data.ClientObject-int-int:A-com.threerings.puzzle.data.Board:A-">updateProgressSync</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server">PuzzleGameProvider</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PuzzleManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/puzzle/server/PuzzleGameProvider.html" title="interface in com.threerings.puzzle.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/puzzle/server/PuzzleManagerDelegate.html" title="class in com.threerings.puzzle.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/puzzle/server/PuzzleManager.html" target="_top">Frames</a></li>
<li><a href="PuzzleManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.com.threerings.crowd.server.PlaceManager">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink