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

687 lines
38 KiB
HTML
Raw Permalink 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:08 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PuzzleController (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="PuzzleController (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":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/PuzzleController.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/client/PuzzleBoardView.html" title="class in com.threerings.puzzle.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/puzzle/client/PuzzleController.ClearPender.html" title="interface in com.threerings.puzzle.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/puzzle/client/PuzzleController.html" target="_top">Frames</a></li>
<li><a href="PuzzleController.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.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.client</div>
<h2 title="Class PuzzleController" class="title">Class PuzzleController</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><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true" title="class or interface in com.samskivert.swing">com.samskivert.swing.Controller</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.crowd.client.PlaceController</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">com.threerings.parlor.game.client.GameController</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.puzzle.client.PuzzleController</li>
</ul>
</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.presents.data.InvocationCodes, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, <a href="../../../../com/threerings/puzzle/data/PuzzleCodes.html" title="interface in com.threerings.puzzle.data">PuzzleCodes</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/event/ActionListener.html?is-external=true" title="class or interface in java.awt.event">ActionListener</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">PuzzleController</span>
extends <a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a>
implements <a href="../../../../com/threerings/puzzle/data/PuzzleCodes.html" title="interface in com.threerings.puzzle.data">PuzzleCodes</a></pre>
<div class="block">The puzzle game controller handles logical actions for a puzzle game.</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.ClearPender.html" title="interface in com.threerings.puzzle.client">PuzzleController.ClearPender</a></span></code>
<div class="block">Used by <a href="../../../../com/threerings/puzzle/client/PuzzleController.html#fireWhenActionCleared-com.threerings.puzzle.client.PuzzleController.ClearPender-"><code>fireWhenActionCleared(com.threerings.puzzle.client.PuzzleController.ClearPender)</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.crowd.client.PlaceController">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.threerings.crowd.client.PlaceController</h3>
<code>com.threerings.crowd.client.PlaceController.DelegateOp</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#TOGGLE_CHATTING">TOGGLE_CHATTING</a></span></code>
<div class="block">The action command to toggle chatting mode.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.samskivert.swing.Controller">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.samskivert.swing.<a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true" title="class or interface in com.samskivert.swing">Controller</a></h3>
<code><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#DISPATCHER" title="class or interface in com.samskivert.swing">DISPATCHER</a></code></li>
</ul>
<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>
</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/client/PuzzleController.html#PuzzleController--">PuzzleController</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#addProgressEvent-int-com.threerings.puzzle.data.Board-">addProgressEvent</a></span>(int&nbsp;event,
<a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>&nbsp;board)</code>
<div class="block">Adds the given progress event and a snapshot of the supplied board state to the set of
progress events and associated board states for later transmission to the server.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#attributeChanged-com.threerings.presents.dobj.AttributeChangedEvent-">attributeChanged</a></span>(com.threerings.presents.dobj.AttributeChangedEvent&nbsp;event)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#didLeavePlace-com.threerings.crowd.data.PlaceObject-">didLeavePlace</a></span>(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</code>
<div class="block">Removes our listener registration from the game object and cleans house.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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/client/PuzzleController.html#getBoard--">getBoard</a></span>()</code>
<div class="block">Returns the board associated with the puzzle.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#getEventCount--">getEventCount</a></span>()</code>
<div class="block">Returns the number of progress events currently queued up for sending to the server with
the next progress update.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#getPauseString--">getPauseString</a></span>()</code>
<div class="block">Get the (untranslated) string to display when the puzzle is paused.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#getPlayerIndex--">getPlayerIndex</a></span>()</code>
<div class="block">Returns the player's index in the list of players for the game.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#handleAction-java.awt.event.ActionEvent-">handleAction</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/event/ActionEvent.html?is-external=true" title="class or interface in java.awt.event">ActionEvent</a>&nbsp;action)</code>
<div class="block">Handles basic game controller action events.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#hasAction--">hasAction</a></span>()</code>
<div class="block">Returns true if the puzzle has action, false if the action is cleared or it is suspended.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#isChatting--">isChatting</a></span>()</code>
<div class="block">Returns true if the puzzle has been defocused because the player is doing some chatting.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#mayLeavePlace-com.threerings.crowd.data.PlaceObject-">mayLeavePlace</a></span>(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#sendProgressUpdate--">sendProgressUpdate</a></span>()</code>
<div class="block">Sends the server a game progress update with the list of events, as well as board states if
<a href="../../../../com/threerings/puzzle/client/PuzzlePanel.html#isSyncingBoards--"><code>PuzzlePanel.isSyncingBoards()</code></a> is true.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#setBoard-com.threerings.puzzle.data.Board-">setBoard</a></span>(<a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>&nbsp;board)</code>
<div class="block">Called when a new board is set.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#setChatting-boolean-">setChatting</a></span>(boolean&nbsp;chatting)</code>
<div class="block">Sets whether we're focusing on the chat window rather than the puzzle.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#setGameOver-boolean-">setGameOver</a></span>(boolean&nbsp;gameOver)</code>
<div class="block">Sets the client game over override.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/puzzle/client/PuzzleController.html#willEnterPlace-com.threerings.crowd.data.PlaceObject-">willEnterPlace</a></span>(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</code>
<div class="block">Adds this controller as a listener to the game object (thus derived classes need not do so)
and lets the game manager know that we are now ready to go.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.parlor.game.client.GameController">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.parlor.game.client.<a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a></h3>
<code><a href="../../../../com/threerings/parlor/game/client/GameController.html#getMatchType--">getMatchType</a>, <a href="../../../../com/threerings/parlor/game/client/GameController.html#getSessionId--">getSessionId</a>, <a href="../../../../com/threerings/parlor/game/client/GameController.html#init-com.threerings.crowd.util.CrowdContext-com.threerings.crowd.data.PlaceConfig-">init</a>, <a href="../../../../com/threerings/parlor/game/client/GameController.html#isGameOver--">isGameOver</a>, <a href="../../../../com/threerings/parlor/game/client/GameController.html#resetGame--">resetGame</a>, <a href="../../../../com/threerings/parlor/game/client/GameController.html#systemMessage-java.lang.String-java.lang.String-">systemMessage</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.crowd.client.PlaceController">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.crowd.client.PlaceController</h3>
<code>getPlaceConfig, getPlaceView</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.samskivert.swing.Controller">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.samskivert.swing.<a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true" title="class or interface in com.samskivert.swing">Controller</a></h3>
<code><a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#actionPerformed-java.awt.event.ActionEvent-" title="class or interface in com.samskivert.swing">actionPerformed</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#configureAction-javax.swing.AbstractButton-java.lang.String-" title="class or interface in com.samskivert.swing">configureAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#createActionButton-java.lang.String-java.lang.String-" title="class or interface in com.samskivert.swing">createActionButton</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#handleAction-java.awt.Component-java.lang.String-" title="class or interface in com.samskivert.swing">handleAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#handleAction-java.awt.Component-java.lang.String-java.lang.Object-" title="class or interface in com.samskivert.swing">handleAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#handleAction-java.lang.Object-java.lang.String-java.lang.Object-" title="class or interface in com.samskivert.swing">handleAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#postAction-java.awt.event.ActionEvent-" title="class or interface in com.samskivert.swing">postAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#postAction-java.awt.Component-java.lang.String-" title="class or interface in com.samskivert.swing">postAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#postAction-java.awt.Component-java.lang.String-java.lang.Object-" title="class or interface in com.samskivert.swing">postAction</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#setControlledPanel-javax.swing.JComponent-" title="class or interface in com.samskivert.swing">setControlledPanel</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#wasAdded--" title="class or interface in com.samskivert.swing">wasAdded</a>, <a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/swing/Controller.html?is-external=true#wasRemoved--" title="class or interface in com.samskivert.swing">wasRemoved</a></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#toString--" title="class or interface in java.lang">toString</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TOGGLE_CHATTING">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TOGGLE_CHATTING</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TOGGLE_CHATTING</pre>
<div class="block">The action command to toggle chatting mode.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.puzzle.client.PuzzleController.TOGGLE_CHATTING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PuzzleController--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PuzzleController</h4>
<pre>public&nbsp;PuzzleController()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getBoard--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoard</h4>
<pre>public&nbsp;<a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>&nbsp;getBoard()</pre>
<div class="block">Returns the board associated with the puzzle.</div>
</li>
</ul>
<a name="getPlayerIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerIndex</h4>
<pre>public&nbsp;int&nbsp;getPlayerIndex()</pre>
<div class="block">Returns the player's index in the list of players for the game.</div>
</li>
</ul>
<a name="setGameOver-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGameOver</h4>
<pre>public&nbsp;void&nbsp;setGameOver(boolean&nbsp;gameOver)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html#setGameOver-boolean-">GameController</a></code></span></div>
<div class="block">Sets the client game over override. This is used in situations where we determine that the
game is over before the server has informed us of such.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/game/client/GameController.html#setGameOver-boolean-">setGameOver</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a></code></dd>
</dl>
</li>
</ul>
<a name="hasAction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasAction</h4>
<pre>public&nbsp;boolean&nbsp;hasAction()</pre>
<div class="block">Returns true if the puzzle has action, false if the action is cleared or it is suspended.</div>
</li>
</ul>
<a name="setChatting-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChatting</h4>
<pre>public&nbsp;void&nbsp;setChatting(boolean&nbsp;chatting)</pre>
<div class="block">Sets whether we're focusing on the chat window rather than the puzzle.</div>
</li>
</ul>
<a name="getPauseString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPauseString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPauseString()</pre>
<div class="block">Get the (untranslated) string to display when the puzzle is paused.</div>
</li>
</ul>
<a name="isChatting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isChatting</h4>
<pre>public&nbsp;boolean&nbsp;isChatting()</pre>
<div class="block">Returns true if the puzzle has been defocused because the player is doing some chatting.</div>
</li>
</ul>
<a name="willEnterPlace-com.threerings.crowd.data.PlaceObject-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>willEnterPlace</h4>
<pre>public&nbsp;void&nbsp;willEnterPlace(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html#willEnterPlace-com.threerings.crowd.data.PlaceObject-">GameController</a></code></span></div>
<div class="block">Adds this controller as a listener to the game object (thus derived classes need not do so)
and lets the game manager know that we are now ready to go.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/game/client/GameController.html#willEnterPlace-com.threerings.crowd.data.PlaceObject-">willEnterPlace</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a></code></dd>
</dl>
</li>
</ul>
<a name="mayLeavePlace-com.threerings.crowd.data.PlaceObject-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mayLeavePlace</h4>
<pre>public&nbsp;void&nbsp;mayLeavePlace(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>mayLeavePlace</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceController</code></dd>
</dl>
</li>
</ul>
<a name="didLeavePlace-com.threerings.crowd.data.PlaceObject-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>didLeavePlace</h4>
<pre>public&nbsp;void&nbsp;didLeavePlace(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html#didLeavePlace-com.threerings.crowd.data.PlaceObject-">GameController</a></code></span></div>
<div class="block">Removes our listener registration from the game object and cleans house.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/game/client/GameController.html#didLeavePlace-com.threerings.crowd.data.PlaceObject-">didLeavePlace</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a></code></dd>
</dl>
</li>
</ul>
<a name="attributeChanged-com.threerings.presents.dobj.AttributeChangedEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attributeChanged</h4>
<pre>public&nbsp;void&nbsp;attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent&nbsp;event)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>attributeChanged</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.dobj.AttributeChangeListener</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/game/client/GameController.html#attributeChanged-com.threerings.presents.dobj.AttributeChangedEvent-">attributeChanged</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a></code></dd>
</dl>
</li>
</ul>
<a name="setBoard-com.threerings.puzzle.data.Board-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBoard</h4>
<pre>public&nbsp;void&nbsp;setBoard(<a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>&nbsp;board)</pre>
<div class="block">Called when a new board is set.</div>
</li>
</ul>
<a name="handleAction-java.awt.event.ActionEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleAction</h4>
<pre>public&nbsp;boolean&nbsp;handleAction(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/event/ActionEvent.html?is-external=true" title="class or interface in java.awt.event">ActionEvent</a>&nbsp;action)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html#handleAction-java.awt.event.ActionEvent-">GameController</a></code></span></div>
<div class="block">Handles basic game controller action events. Derived classes should be sure to call
<code>super.handleAction</code> for events they don't specifically handle.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/game/client/GameController.html#handleAction-java.awt.event.ActionEvent-">handleAction</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/threerings/parlor/game/client/GameController.html" title="class in com.threerings.parlor.game.client">GameController</a></code></dd>
</dl>
</li>
</ul>
<a name="getEventCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventCount</h4>
<pre>public&nbsp;int&nbsp;getEventCount()</pre>
<div class="block">Returns the number of progress events currently queued up for sending to the server with
the next progress update.</div>
</li>
</ul>
<a name="addProgressEvent-int-com.threerings.puzzle.data.Board-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProgressEvent</h4>
<pre>public&nbsp;void&nbsp;addProgressEvent(int&nbsp;event,
<a href="../../../../com/threerings/puzzle/data/Board.html" title="class in com.threerings.puzzle.data">Board</a>&nbsp;board)</pre>
<div class="block">Adds the given progress event and a snapshot of the supplied board state to the set of
progress events and associated board states for later transmission to the server.</div>
</li>
</ul>
<a name="sendProgressUpdate--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sendProgressUpdate</h4>
<pre>public&nbsp;void&nbsp;sendProgressUpdate()</pre>
<div class="block">Sends the server a game progress update with the list of events, as well as board states if
<a href="../../../../com/threerings/puzzle/client/PuzzlePanel.html#isSyncingBoards--"><code>PuzzlePanel.isSyncingBoards()</code></a> is true.</div>
</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/PuzzleController.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/client/PuzzleBoardView.html" title="class in com.threerings.puzzle.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/puzzle/client/PuzzleController.ClearPender.html" title="interface in com.threerings.puzzle.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/puzzle/client/PuzzleController.html" target="_top">Frames</a></li>
<li><a href="PuzzleController.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.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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