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

452 lines
21 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>GameManagerDelegate (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="GameManagerDelegate (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};
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/GameManagerDelegate.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/server/GameManager.html" title="class in com.threerings.parlor.game.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/game/server/GameWatcher.html" title="class in com.threerings.parlor.game.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/game/server/GameManagerDelegate.html" target="_top">Frames</a></li>
<li><a href="GameManagerDelegate.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.game.server</div>
<h2 title="Class GameManagerDelegate" class="title">Class GameManagerDelegate</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.crowd.server.PlaceManagerDelegate</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html" title="class in com.threerings.parlor.server">com.threerings.parlor.server.PlayManagerDelegate</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.game.server.GameManagerDelegate</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/threerings/puzzle/server/PuzzleManagerDelegate.html" title="class in com.threerings.puzzle.server">PuzzleManagerDelegate</a>, <a href="../../../../../com/threerings/parlor/rating/server/RatingDelegate.html" title="class in com.threerings.parlor.rating.server">RatingDelegate</a>, <a href="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server">TurnGameManagerDelegate</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">GameManagerDelegate</span>
extends <a href="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html" title="class in com.threerings.parlor.server">PlayManagerDelegate</a></pre>
<div class="block">Extends the <a href="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html" title="class in com.threerings.parlor.server"><code>PlayManagerDelegate</code></a> mechanism with game manager specific methods.</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/game/server/GameManagerDelegate.html#GameManagerDelegate--">GameManagerDelegate</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#GameManagerDelegate-com.threerings.parlor.game.server.GameManager-">GameManagerDelegate</a></span>(<a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">GameManager</a>&nbsp;gmgr)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use the zero-argument constructor.</span></div>
</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/game/server/GameManagerDelegate.html#gameDidEnd--">gameDidEnd</a></span>()</code>
<div class="block">Called by the game manager after the game ended.</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/parlor/game/server/GameManagerDelegate.html#gameDidStart--">gameDidStart</a></span>()</code>
<div class="block">Called by the game manager after the game was started.</div>
</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/parlor/game/server/GameManagerDelegate.html#gameWillEnd--">gameWillEnd</a></span>()</code>
<div class="block">Called by the game manager when the game is about to end.</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/game/server/GameManagerDelegate.html#gameWillReset--">gameWillReset</a></span>()</code>
<div class="block">Called when the game is about to reset, but before any other clearing out of game data has
taken place.</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/game/server/GameManagerDelegate.html#gameWillStart--">gameWillStart</a></span>()</code>
<div class="block">Called by the game manager when the game is about to start.</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/server/GameManagerDelegate.html#playerWasReplaced-int-com.threerings.util.Name-com.threerings.util.Name-">playerWasReplaced</a></span>(int&nbsp;pidx,
com.threerings.util.Name&nbsp;oldPlayer,
com.threerings.util.Name&nbsp;newPlayer)</code>
<div class="block">Called when a player in the game has been replaced by a call to <a href="../../../../../com/threerings/parlor/game/server/GameManager.html#replacePlayer-int-com.threerings.util.Name-"><code>GameManager.replacePlayer(int, com.threerings.util.Name)</code></a>.</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/game/server/GameManagerDelegate.html#setAI-int-com.threerings.parlor.game.data.GameAI-">setAI</a></span>(int&nbsp;pidx,
<a href="../../../../../com/threerings/parlor/game/data/GameAI.html" title="class in com.threerings.parlor.game.data">GameAI</a>&nbsp;ai)</code>
<div class="block">Called when the specified player has been set as an AI with the supplied AI configuration.</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/server/GameManagerDelegate.html#tickAI-int-com.threerings.parlor.game.data.GameAI-">tickAI</a></span>(int&nbsp;pidx,
<a href="../../../../../com/threerings/parlor/game/data/GameAI.html" title="class in com.threerings.parlor.game.data">GameAI</a>&nbsp;ai)</code>
<div class="block">Called by the manager when we should do some AI.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.parlor.server.PlayManagerDelegate">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.parlor.server.<a href="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html" title="class in com.threerings.parlor.server">PlayManagerDelegate</a></h3>
<code><a href="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html#didInit-com.threerings.crowd.data.PlaceConfig-">didInit</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.crowd.server.PlaceManagerDelegate">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.crowd.server.PlaceManagerDelegate</h3>
<code>bodyEntered, bodyLeft, bodyUpdated, didShutdown, didStartup, init, placeBecameEmpty, where</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#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="GameManagerDelegate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GameManagerDelegate</h4>
<pre>public&nbsp;GameManagerDelegate()</pre>
</li>
</ul>
<a name="GameManagerDelegate-com.threerings.parlor.game.server.GameManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GameManagerDelegate</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;GameManagerDelegate(<a href="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server">GameManager</a>&nbsp;gmgr)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use the zero-argument constructor.</span></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="gameWillStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gameWillStart</h4>
<pre>public&nbsp;void&nbsp;gameWillStart()</pre>
<div class="block">Called by the game manager when the game is about to start.</div>
</li>
</ul>
<a name="gameDidStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gameDidStart</h4>
<pre>public&nbsp;void&nbsp;gameDidStart()</pre>
<div class="block">Called by the game manager after the game was started.</div>
</li>
</ul>
<a name="playerWasReplaced-int-com.threerings.util.Name-com.threerings.util.Name-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>playerWasReplaced</h4>
<pre>public&nbsp;void&nbsp;playerWasReplaced(int&nbsp;pidx,
com.threerings.util.Name&nbsp;oldPlayer,
com.threerings.util.Name&nbsp;newPlayer)</pre>
<div class="block">Called when a player in the game has been replaced by a call to <a href="../../../../../com/threerings/parlor/game/server/GameManager.html#replacePlayer-int-com.threerings.util.Name-"><code>GameManager.replacePlayer(int, com.threerings.util.Name)</code></a>.</div>
</li>
</ul>
<a name="tickAI-int-com.threerings.parlor.game.data.GameAI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tickAI</h4>
<pre>public&nbsp;void&nbsp;tickAI(int&nbsp;pidx,
<a href="../../../../../com/threerings/parlor/game/data/GameAI.html" title="class in com.threerings.parlor.game.data">GameAI</a>&nbsp;ai)</pre>
<div class="block">Called by the manager when we should do some AI. Only called while the game is IN_PLAY.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pidx</code> - the player index to fake some gameplay for.</dd>
<dd><code>ai</code> - a record indicating the AI's configuration.</dd>
</dl>
</li>
</ul>
<a name="gameWillEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gameWillEnd</h4>
<pre>public&nbsp;void&nbsp;gameWillEnd()</pre>
<div class="block">Called by the game manager when the game is about to end.</div>
</li>
</ul>
<a name="gameDidEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gameDidEnd</h4>
<pre>public&nbsp;void&nbsp;gameDidEnd()</pre>
<div class="block">Called by the game manager after the game ended.</div>
</li>
</ul>
<a name="gameWillReset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gameWillReset</h4>
<pre>public&nbsp;void&nbsp;gameWillReset()</pre>
<div class="block">Called when the game is about to reset, but before any other clearing out of game data has
taken place. Derived classes should override this if they need to perform some pre-reset
activities.</div>
</li>
</ul>
<a name="setAI-int-com.threerings.parlor.game.data.GameAI-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setAI</h4>
<pre>public&nbsp;void&nbsp;setAI(int&nbsp;pidx,
<a href="../../../../../com/threerings/parlor/game/data/GameAI.html" title="class in com.threerings.parlor.game.data">GameAI</a>&nbsp;ai)</pre>
<div class="block">Called when the specified player has been set as an AI with the supplied AI configuration.</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/GameManagerDelegate.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/server/GameManager.html" title="class in com.threerings.parlor.game.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/game/server/GameWatcher.html" title="class in com.threerings.parlor.game.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/game/server/GameManagerDelegate.html" target="_top">Frames</a></li>
<li><a href="GameManagerDelegate.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