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

351 lines
15 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:12 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ZoneManager (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="ZoneManager (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/ZoneManager.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&nbsp;Class</li>
<li><a href="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/zone/server/ZoneManager.html" target="_top">Frames</a></li>
<li><a href="ZoneManager.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.whirled.zone.server</div>
<h2 title="Interface ZoneManager" class="title">Interface ZoneManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../com/threerings/whirled/zone/peer/server/PeeredZoneManager.html" title="interface in com.threerings.whirled.zone.peer.server">PeeredZoneManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ZoneManager</span></pre>
<div class="block">A zone is a collection of scenes organized into a connected group. A
user can wander around within a zone, moving from scene to scene via
the standard mechanisms. To move between zones, they must use a special
mechanism (like at the dock, they can move from an island zone into
their ship zone; or they can move from an island zone into their house
zone). A zone provides scene summary information that can be used to
display a map of the zone to the client.</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">Interface 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/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server">ZoneManager.ResolutionListener</a></span></code>
<div class="block">Used to notify requesters when an asynchronous zone load has
completed (successfully or not).</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/whirled/zone/server/ZoneManager.html#bodyDidEnterZone-com.threerings.crowd.data.BodyObject-int-">bodyDidEnterZone</a></span>(com.threerings.crowd.data.BodyObject&nbsp;body,
int&nbsp;zoneId)</code>
<div class="block">Called when a body has been granted access to a zone.</div>
</td>
</tr>
<tr id="i1" 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/whirled/zone/server/ZoneManager.html#ratifyBodyEntry-com.threerings.crowd.data.BodyObject-int-">ratifyBodyEntry</a></span>(com.threerings.crowd.data.BodyObject&nbsp;body,
int&nbsp;zoneId)</code>
<div class="block">Called when a body has requested to enter a zone.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/whirled/zone/server/ZoneManager.html#ratifyBodyExit-com.threerings.crowd.data.BodyObject-">ratifyBodyExit</a></span>(com.threerings.crowd.data.BodyObject&nbsp;body)</code>
<div class="block">Called when a body has requested to leave a zone.</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/whirled/zone/server/ZoneManager.html#resolveZone-int-com.threerings.whirled.zone.server.ZoneManager.ResolutionListener-">resolveZone</a></span>(int&nbsp;zoneId,
<a href="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server">ZoneManager.ResolutionListener</a>&nbsp;listener)</code>
<div class="block">Resolves and delivers the scene summary information for the
requested zone.</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="resolveZone-int-com.threerings.whirled.zone.server.ZoneManager.ResolutionListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveZone</h4>
<pre>void&nbsp;resolveZone(int&nbsp;zoneId,
<a href="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server">ZoneManager.ResolutionListener</a>&nbsp;listener)</pre>
<div class="block">Resolves and delivers the scene summary information for the
requested zone. Zone resolution is an asynchronous process, which
necessitates this callback-style interface.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>zoneId</code> - the qualified zone id of the zone to resolve.</dd>
<dd><code>listener</code> - the listener that should be notified when the zone
is successfully resolved or is known to have failed to resolve.</dd>
</dl>
</li>
</ul>
<a name="ratifyBodyExit-com.threerings.crowd.data.BodyObject-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ratifyBodyExit</h4>
<pre><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;ratifyBodyExit(com.threerings.crowd.data.BodyObject&nbsp;body)</pre>
<div class="block">Called when a body has requested to leave a zone. The zone manager
may return null to indicate that the body is allowed to leave the
current zone or a string error code indicating the reason for
denial of access (which will be propagated back to the requesting
client).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - the body object of the user that desires to depart
their current zone (which can be obtained by casting the <code>BodyObject</code> to a <a href="../../../../../com/threerings/whirled/zone/data/ZonedBodyObject.html" title="interface in com.threerings.whirled.zone.data"><code>ZonedBodyObject</code></a>).</dd>
</dl>
</li>
</ul>
<a name="ratifyBodyEntry-com.threerings.crowd.data.BodyObject-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ratifyBodyEntry</h4>
<pre><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;ratifyBodyEntry(com.threerings.crowd.data.BodyObject&nbsp;body,
int&nbsp;zoneId)</pre>
<div class="block">Called when a body has requested to enter a zone. The zone manager
may return null to indicate that the body is allowed access to the
zone or a string error code indicating the reason for denial of
access (which will be propagated back to the requesting client).
This method is called <em>after</em> the zone is resolved so that
the zone manager may complete the ratification process without
blocking (which it must do).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - the body object of the user that desires access to the
specified zone.</dd>
<dd><code>zoneId</code> - the id of the zone to which the user desires access.</dd>
</dl>
</li>
</ul>
<a name="bodyDidEnterZone-com.threerings.crowd.data.BodyObject-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>bodyDidEnterZone</h4>
<pre>void&nbsp;bodyDidEnterZone(com.threerings.crowd.data.BodyObject&nbsp;body,
int&nbsp;zoneId)</pre>
<div class="block">Called when a body has been granted access to a zone. This method
must not block.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - the body object of the user that was just granted
access to a zone.</dd>
<dd><code>zoneId</code> - the id of the zone to which they were granted access.</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/ZoneManager.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&nbsp;Class</li>
<li><a href="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/zone/server/ZoneManager.html" target="_top">Frames</a></li>
<li><a href="ZoneManager.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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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