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

545 lines
28 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:08 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GameController (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="GameController (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};
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/GameController.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/parlor/game/client/GameConfigurator.html" title="class in com.threerings.parlor.game.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html" title="class in com.threerings.parlor.game.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/game/client/GameController.html" target="_top">Frames</a></li>
<li><a href="GameController.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.client.PlaceController">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.samskivert.swing.Controller">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>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.parlor.game.client</div>
<h2 title="Class GameController" class="title">Class GameController</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>com.threerings.parlor.game.client.GameController</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.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, <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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/threerings/parlor/card/client/CardGameController.html" title="class in com.threerings.parlor.card.client">CardGameController</a>, <a href="../../../../../com/threerings/puzzle/client/PuzzleController.html" title="class in com.threerings.puzzle.client">PuzzleController</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">GameController</span>
extends com.threerings.crowd.client.PlaceController
implements com.threerings.presents.dobj.AttributeChangeListener</pre>
<div class="block">The game controller manages the flow and control of a game on the client side. This class serves
as the root of a hierarchy of controller classes that aim to provide functionality shared
between various similar games. The base controller provides functionality for starting and
ending the game and for calculating ratings adjustments when a game ends normally. It also
handles the basic house keeping like subscription to the game object and dispatch of commands
and distributed object events.</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.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>
<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>
</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/parlor/game/client/GameController.html#GameController--">GameController</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/parlor/game/client/GameController.html#attributeChanged-com.threerings.presents.dobj.AttributeChangedEvent-">attributeChanged</a></span>(com.threerings.presents.dobj.AttributeChangedEvent&nbsp;event)</code>&nbsp;</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/parlor/game/client/GameController.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="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#getMatchType--">getMatchType</a></span>()</code>
<div class="block">Convenience method to determine the type of game.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#getSessionId--">getSessionId</a></span>()</code>
<div class="block">Returns the unique session identifier for the current gameplay session.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.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="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#init-com.threerings.crowd.util.CrowdContext-com.threerings.crowd.data.PlaceConfig-">init</a></span>(com.threerings.crowd.util.CrowdContext&nbsp;ctx,
com.threerings.crowd.data.PlaceConfig&nbsp;config)</code>
<div class="block">Initializes this game controller with the game configuration that was established during the
match making process.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#isGameOver--">isGameOver</a></span>()</code>
<div class="block">Returns whether the game is over.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#resetGame--">resetGame</a></span>()</code>
<div class="block">Calls <a href="../../../../../com/threerings/parlor/game/client/GameController.html#gameWillReset--"><code>gameWillReset()</code></a>, ends the current game (locally, it does not tell the server to
end the game), and waits to receive a reset notification (which is simply an event setting
the game state to <code>IN_PLAY</code> even though it's already set to <code>IN_PLAY</code>)
from the server which will start up a new game.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#setGameOver-boolean-">setGameOver</a></span>(boolean&nbsp;gameOver)</code>
<div class="block">Sets the client game over override.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/client/GameController.html#systemMessage-java.lang.String-java.lang.String-">systemMessage</a></span>(<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;bundle,
<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;msg)</code>
<div class="block">A way for controllers to display a game-related system message.</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/parlor/game/client/GameController.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.crowd.client.PlaceController">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.crowd.client.PlaceController</h3>
<code>getPlaceConfig, getPlaceView, mayLeavePlace</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GameController--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GameController</h4>
<pre>public&nbsp;GameController()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-com.threerings.crowd.util.CrowdContext-com.threerings.crowd.data.PlaceConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(com.threerings.crowd.util.CrowdContext&nbsp;ctx,
com.threerings.crowd.data.PlaceConfig&nbsp;config)</pre>
<div class="block">Initializes this game controller with the game configuration that was established during the
match making process. Derived classes may want to override this method to initialize
themselves with game-specific configuration parameters but they should be sure to call
<code>super.init</code> in such cases.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>init</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceController</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the client context.</dd>
<dd><code>config</code> - the configuration of the game we are intended to
control.</dd>
</dl>
</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">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>willEnterPlace</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">Removes our listener registration from the game object and cleans house.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>didLeavePlace</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceController</code></dd>
</dl>
</li>
</ul>
<a name="getMatchType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatchType</h4>
<pre>public&nbsp;int&nbsp;getMatchType()</pre>
<div class="block">Convenience method to determine the type of game.</div>
</li>
</ul>
<a name="isGameOver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGameOver</h4>
<pre>public&nbsp;boolean&nbsp;isGameOver()</pre>
<div class="block">Returns whether the game is over.</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">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>
</li>
</ul>
<a name="resetGame--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetGame</h4>
<pre>public&nbsp;void&nbsp;resetGame()</pre>
<div class="block">Calls <a href="../../../../../com/threerings/parlor/game/client/GameController.html#gameWillReset--"><code>gameWillReset()</code></a>, ends the current game (locally, it does not tell the server to
end the game), and waits to receive a reset notification (which is simply an event setting
the game state to <code>IN_PLAY</code> even though it's already set to <code>IN_PLAY</code>)
from the server which will start up a new game. Derived classes should override <a href="../../../../../com/threerings/parlor/game/client/GameController.html#gameWillReset--"><code>gameWillReset()</code></a> to perform any game-specific animations.</div>
</li>
</ul>
<a name="getSessionId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionId</h4>
<pre>public&nbsp;int&nbsp;getSessionId()</pre>
<div class="block">Returns the unique session identifier for the current gameplay session.</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">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>handleAction</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceController</code></dd>
</dl>
</li>
</ul>
<a name="systemMessage-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>systemMessage</h4>
<pre>public&nbsp;void&nbsp;systemMessage(<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;bundle,
<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;msg)</pre>
<div class="block">A way for controllers to display a game-related system message.</div>
</li>
</ul>
<a name="attributeChanged-com.threerings.presents.dobj.AttributeChangedEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<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>
</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/GameController.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/parlor/game/client/GameConfigurator.html" title="class in com.threerings.parlor.game.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html" title="class in com.threerings.parlor.game.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/game/client/GameController.html" target="_top">Frames</a></li>
<li><a href="GameController.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.client.PlaceController">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.samskivert.swing.Controller">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>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