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

416 lines
19 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>TurnGameControllerDelegate (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="TurnGameControllerDelegate (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/TurnGameControllerDelegate.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/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/turn/client/TurnGameControllerDelegate.html" target="_top">Frames</a></li>
<li><a href="TurnGameControllerDelegate.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>Nested&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.parlor.turn.client</div>
<h2 title="Class TurnGameControllerDelegate" class="title">Class TurnGameControllerDelegate</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.client.PlaceControllerDelegate</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html" title="class in com.threerings.parlor.game.client">com.threerings.parlor.game.client.GameControllerDelegate</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.turn.client.TurnGameControllerDelegate</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</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/threerings/parlor/card/trick/client/TrickCardGameControllerDelegate.html" title="class in com.threerings.parlor.card.trick.client">TrickCardGameControllerDelegate</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TurnGameControllerDelegate</span>
extends <a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html" title="class in com.threerings.parlor.game.client">GameControllerDelegate</a>
implements com.threerings.presents.dobj.AttributeChangeListener</pre>
<div class="block">Performs the client-side processing for a turn-based game. Games which
wish to make use of these services must construct a delegate and call
out to it at the appropriate times (see the method documentation for
which methods should be called when). The game's controller must also
implement the <a href="../../../../../com/threerings/parlor/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client"><code>TurnGameController</code></a> interface so that it can be
notified when turn-based game events take place.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/turn/client/TurnGameControllerDelegate.html#TurnGameControllerDelegate-com.threerings.parlor.turn.client.TurnGameController-">TurnGameControllerDelegate</a></span>(<a href="../../../../../com/threerings/parlor/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client">TurnGameController</a>&nbsp;tgctrl)</code>
<div class="block">Constructs a delegate which will call back to the supplied <a href="../../../../../com/threerings/parlor/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client"><code>TurnGameController</code></a> implementation wen turn-based game related
things happen.</div>
</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/turn/client/TurnGameControllerDelegate.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/turn/client/TurnGameControllerDelegate.html#didLeavePlace-com.threerings.crowd.data.PlaceObject-">didLeavePlace</a></span>(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</code>&nbsp;</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/turn/client/TurnGameControllerDelegate.html#getTurnHolderIndex--">getTurnHolderIndex</a></span>()</code>
<div class="block">Returns the index of the current turn holder as configured in the
game object.</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/parlor/turn/client/TurnGameControllerDelegate.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>&nbsp;</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/turn/client/TurnGameControllerDelegate.html#isOurTurn--">isOurTurn</a></span>()</code>
<div class="block">Returns true if the game is in progress and it is our turn; false
otherwise.</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/turn/client/TurnGameControllerDelegate.html#willEnterPlace-com.threerings.crowd.data.PlaceObject-">willEnterPlace</a></span>(com.threerings.crowd.data.PlaceObject&nbsp;plobj)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.parlor.game.client.GameControllerDelegate">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.parlor.game.client.<a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html" title="class in com.threerings.parlor.game.client">GameControllerDelegate</a></h3>
<code><a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html#gameDidEnd--">gameDidEnd</a>, <a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html#gameDidStart--">gameDidStart</a>, <a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html#gameWasCancelled--">gameWasCancelled</a>, <a href="../../../../../com/threerings/parlor/game/client/GameControllerDelegate.html#gameWillReset--">gameWillReset</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.crowd.client.PlaceControllerDelegate">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.crowd.client.PlaceControllerDelegate</h3>
<code>handleAction, mayLeavePlace</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="TurnGameControllerDelegate-com.threerings.parlor.turn.client.TurnGameController-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TurnGameControllerDelegate</h4>
<pre>public&nbsp;TurnGameControllerDelegate(<a href="../../../../../com/threerings/parlor/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client">TurnGameController</a>&nbsp;tgctrl)</pre>
<div class="block">Constructs a delegate which will call back to the supplied <a href="../../../../../com/threerings/parlor/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client"><code>TurnGameController</code></a> implementation wen turn-based game related
things happen.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isOurTurn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOurTurn</h4>
<pre>public&nbsp;boolean&nbsp;isOurTurn()</pre>
<div class="block">Returns true if the game is in progress and it is our turn; false
otherwise.</div>
</li>
</ul>
<a name="getTurnHolderIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTurnHolderIndex</h4>
<pre>public&nbsp;int&nbsp;getTurnHolderIndex()</pre>
<div class="block">Returns the index of the current turn holder as configured in the
game object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index into the players array of the current turn holder
or -1 if there is no current turn holder.</dd>
</dl>
</li>
</ul>
<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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>init</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceControllerDelegate</code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>willEnterPlace</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceControllerDelegate</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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>didLeavePlace</code>&nbsp;in class&nbsp;<code>com.threerings.crowd.client.PlaceControllerDelegate</code></dd>
</dl>
</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/TurnGameControllerDelegate.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/turn/client/TurnGameController.html" title="interface in com.threerings.parlor.turn.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/turn/client/TurnGameControllerDelegate.html" target="_top">Frames</a></li>
<li><a href="TurnGameControllerDelegate.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>Nested&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