Michael Bayne
357 lines
14 KiB
HTML
357 lines
14 KiB
HTML
<!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>TurnGameManager (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="TurnGameManager (Vilya Core 1.6 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TurnGameManager.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>Prev Class</li>
|
|
<li><a href="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/threerings/parlor/turn/server/TurnGameManager.html" target="_top">Frames</a></li>
|
|
<li><a href="TurnGameManager.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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.server</div>
|
|
<h2 title="Interface TurnGameManager" class="title">Interface TurnGameManager</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../../../../../com/threerings/parlor/card/server/CardGameManager.html" title="class in com.threerings.parlor.card.server">CardGameManager</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">TurnGameManager</span></pre>
|
|
<div class="block">A game manager that wishes to make use of the turn game services should
|
|
implement this interface and create a <a href="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server"><code>TurnGameManagerDelegate</code></a>
|
|
which will perform the basic turn game processing and call back to the
|
|
main manager via this interface.
|
|
|
|
<p> The basic flow of a turn-based game is as follows:
|
|
<pre>
|
|
GameManager.gameWillStart()
|
|
GameManager.gameDidStart()
|
|
TurnGameManagerDelegate.setFirstTurnHolder()
|
|
TurnGameManagerDelegate.startTurn()
|
|
TurnGameManager.turnWillStart()
|
|
TurnGameManagerDelegate.endTurn()
|
|
TurnGameManager.turnDidEnd()
|
|
TurnGameManagerDelegate.setNextTurnHolder()
|
|
TurnGameManagerDelegate.startTurn()
|
|
...
|
|
GameManager.endGame()
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#getPlayerCount--">getPlayerCount</a></span>()</code>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#getPlayerIndex-com.threerings.util.Name-">getPlayerIndex</a></span>(com.threerings.util.Name username)</code>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>com.threerings.util.Name</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#getPlayerName-int-">getPlayerName</a></span>(int index)</code>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#isActivePlayer-int-">isActivePlayer</a></span>(int pidx)</code>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</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/parlor/turn/server/TurnGameManager.html#turnDidEnd--">turnDidEnd</a></span>()</code>
|
|
<div class="block">Called when the turn was ended.</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/server/TurnGameManager.html#turnDidStart--">turnDidStart</a></span>()</code>
|
|
<div class="block">Called when we have started the next turn.</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/parlor/turn/server/TurnGameManager.html#turnWillStart--">turnWillStart</a></span>()</code>
|
|
<div class="block">Called when we are about to start the next turn.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getPlayerName-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPlayerName</h4>
|
|
<pre>com.threerings.util.Name getPlayerName(int index)</pre>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getPlayerIndex-com.threerings.util.Name-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPlayerIndex</h4>
|
|
<pre>int getPlayerIndex(com.threerings.util.Name username)</pre>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getPlayerCount--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPlayerCount</h4>
|
|
<pre>int getPlayerCount()</pre>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="isActivePlayer-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isActivePlayer</h4>
|
|
<pre>boolean isActivePlayer(int pidx)</pre>
|
|
<div class="block">Extending <a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><code>GameManager</code></a> should automatically handle
|
|
implementing this method.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="turnWillStart--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>turnWillStart</h4>
|
|
<pre>void turnWillStart()</pre>
|
|
<div class="block">Called when we are about to start the next turn. Implementations
|
|
can do whatever pre-start turn activities need to be done.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="turnDidStart--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>turnDidStart</h4>
|
|
<pre>void turnDidStart()</pre>
|
|
<div class="block">Called when we have started the next turn. Implementations can do
|
|
whatever post-start turn activities need to be done.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="turnDidEnd--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>turnDidEnd</h4>
|
|
<pre>void turnDidEnd()</pre>
|
|
<div class="block">Called when the turn was ended. Implementations can perform any
|
|
post-turn processing (like updating scores, etc.).</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/TurnGameManager.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>Prev Class</li>
|
|
<li><a href="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/threerings/parlor/turn/server/TurnGameManager.html" target="_top">Frames</a></li>
|
|
<li><a href="TurnGameManager.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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 © 2015. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|