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

592 lines
36 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>ZoneDirector (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="ZoneDirector (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,"i11":10,"i12":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/ZoneDirector.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/whirled/zone/client/ZoneDecoder.html" title="class in com.threerings.whirled.zone.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/zone/client/ZoneObserver.html" title="interface in com.threerings.whirled.zone.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/zone/client/ZoneDirector.html" target="_top">Frames</a></li>
<li><a href="ZoneDirector.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.whirled.zone.client</div>
<h2 title="Class ZoneDirector" class="title">Class ZoneDirector</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.presents.client.BasicDirector</li>
<li>
<ul class="inheritance">
<li>com.threerings.whirled.zone.client.ZoneDirector</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.client.InvocationReceiver, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.SessionObserver, <a href="../../../../../com/threerings/whirled/client/SceneDirector.MoveHandler.html" title="interface in com.threerings.whirled.client">SceneDirector.MoveHandler</a>, <a href="../../../../../com/threerings/whirled/zone/client/ZoneReceiver.html" title="interface in com.threerings.whirled.zone.client">ZoneReceiver</a>, <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html" title="interface in com.threerings.whirled.zone.client">ZoneService.ZoneMoveListener</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ZoneDirector</span>
extends com.threerings.presents.client.BasicDirector
implements <a href="../../../../../com/threerings/whirled/zone/client/ZoneReceiver.html" title="interface in com.threerings.whirled.zone.client">ZoneReceiver</a>, <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html" title="interface in com.threerings.whirled.zone.client">ZoneService.ZoneMoveListener</a>, <a href="../../../../../com/threerings/whirled/client/SceneDirector.MoveHandler.html" title="interface in com.threerings.whirled.client">SceneDirector.MoveHandler</a></pre>
<div class="block">The zone director augments the scene services with the notion of zones. Zones are
self-contained, connected groups of scenes. The normal scene director services can be used to
move from scene to scene, but moving to a new zone requires a special move request which can be
accomplished via the zone director. The zone director also makes available the zone summary
which provides information on the zone which can be used to generate an overview map or similar.</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.presents.client.InvocationReceiver">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.presents.client.InvocationReceiver</h3>
<code>com.threerings.presents.client.InvocationReceiver.Registration</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/whirled/zone/client/ZoneDirector.html#ZoneDirector-com.threerings.whirled.util.WhirledContext-com.threerings.whirled.client.SceneDirector-">ZoneDirector</a></span>(<a href="../../../../../com/threerings/whirled/util/WhirledContext.html" title="interface in com.threerings.whirled.util">WhirledContext</a>&nbsp;ctx,
<a href="../../../../../com/threerings/whirled/client/SceneDirector.html" title="class in com.threerings.whirled.client">SceneDirector</a>&nbsp;scdir)</code>
<div class="block">Constructs a zone director with the supplied context, and delegate scene director (which the
zone director will coordinate with when moving from scene to scene).</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/whirled/zone/client/ZoneDirector.html#addZoneObserver-com.threerings.whirled.zone.client.ZoneObserver-">addZoneObserver</a></span>(<a href="../../../../../com/threerings/whirled/zone/client/ZoneObserver.html" title="interface in com.threerings.whirled.zone.client">ZoneObserver</a>&nbsp;observer)</code>
<div class="block">Adds a zone observer to the list.</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/whirled/zone/client/ZoneDirector.html#clientDidLogoff-com.threerings.presents.client.Client-">clientDidLogoff</a></span>(com.threerings.presents.client.Client&nbsp;client)</code>&nbsp;</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/whirled/zone/client/ZoneDirector.html#forcedMove-int-int-">forcedMove</a></span>(int&nbsp;zoneId,
int&nbsp;sceneId)</code>
<div class="block">Used to communicate a required move notification to the client.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/zone/client/ZoneDirector.html#getZoneSummary--">getZoneSummary</a></span>()</code>
<div class="block">Returns the summary for the zone currently occupied by the client or null if the client does
not currently occupy a zone (not a normal situation).</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/whirled/zone/client/ZoneDirector.html#moveRequiresServerSwitch-java.lang.String-int:A-">moveRequiresServerSwitch</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;hostname,
int[]&nbsp;ports)</code>
<div class="block">Indicates that the client must switch to the specified server and reissue its move
request in order to relocate to its desired zone.</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/whirled/zone/client/ZoneDirector.html#moveSucceeded-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-">moveSucceeded</a></span>(int&nbsp;placeId,
com.threerings.crowd.data.PlaceConfig&nbsp;config,
<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;summary)</code>
<div class="block">Called in response to a successful <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request.</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/whirled/zone/client/ZoneDirector.html#moveSucceededWithScene-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneModel-">moveSucceededWithScene</a></span>(int&nbsp;placeId,
com.threerings.crowd.data.PlaceConfig&nbsp;config,
<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;summary,
<a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;model)</code>
<div class="block">Called in response to a successful <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request when our cached
scene was out of date and the server determined that we needed an updated copy.</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/whirled/zone/client/ZoneDirector.html#moveSucceededWithUpdates-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneUpdate:A-">moveSucceededWithUpdates</a></span>(int&nbsp;placeId,
com.threerings.crowd.data.PlaceConfig&nbsp;config,
<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;summary,
<a href="../../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</a>[]&nbsp;updates)</code>
<div class="block">Called in response to a successful <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request when our cached
scene was out of date and the server determined that we needed some updates.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/zone/client/ZoneDirector.html#moveTo-int-int-">moveTo</a></span>(int&nbsp;zoneId,
int&nbsp;sceneId)</code>
<div class="block">Requests that this client move the specified scene in the specified zone.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/zone/client/ZoneDirector.html#moveTo-int-int-com.samskivert.util.ResultListener-">moveTo</a></span>(int&nbsp;zoneId,
int&nbsp;sceneId,
<a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</a>&lt;com.threerings.crowd.data.PlaceConfig&gt;&nbsp;rl)</code>
<div class="block">Requests that this client move the specified scene in the specified zone.</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/whirled/zone/client/ZoneDirector.html#recoverMoveTo-int-">recoverMoveTo</a></span>(int&nbsp;previousSceneId)</code>
<div class="block">Should instruct the client to move the last known working location (as well as clean up
after the failed moveTo request).</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/zone/client/ZoneDirector.html#removeZoneObserver-com.threerings.whirled.zone.client.ZoneObserver-">removeZoneObserver</a></span>(<a href="../../../../../com/threerings/whirled/zone/client/ZoneObserver.html" title="interface in com.threerings.whirled.zone.client">ZoneObserver</a>&nbsp;observer)</code>
<div class="block">Removes a zone observer from the list.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/zone/client/ZoneDirector.html#requestFailed-java.lang.String-">requestFailed</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;reason)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.presents.client.BasicDirector">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.presents.client.BasicDirector</h3>
<code>clientDidLogon, clientObjectDidChange, clientWillLogon, isAvailableInStandalone, setAvailableInStandalone</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="ZoneDirector-com.threerings.whirled.util.WhirledContext-com.threerings.whirled.client.SceneDirector-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZoneDirector</h4>
<pre>public&nbsp;ZoneDirector(<a href="../../../../../com/threerings/whirled/util/WhirledContext.html" title="interface in com.threerings.whirled.util">WhirledContext</a>&nbsp;ctx,
<a href="../../../../../com/threerings/whirled/client/SceneDirector.html" title="class in com.threerings.whirled.client">SceneDirector</a>&nbsp;scdir)</pre>
<div class="block">Constructs a zone director with the supplied context, and delegate scene director (which the
zone director will coordinate with when moving from scene to scene). A zone director is
required on the client side for systems that wish to use the zone services.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getZoneSummary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZoneSummary</h4>
<pre>public&nbsp;<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;getZoneSummary()</pre>
<div class="block">Returns the summary for the zone currently occupied by the client or null if the client does
not currently occupy a zone (not a normal situation).</div>
</li>
</ul>
<a name="addZoneObserver-com.threerings.whirled.zone.client.ZoneObserver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addZoneObserver</h4>
<pre>public&nbsp;void&nbsp;addZoneObserver(<a href="../../../../../com/threerings/whirled/zone/client/ZoneObserver.html" title="interface in com.threerings.whirled.zone.client">ZoneObserver</a>&nbsp;observer)</pre>
<div class="block">Adds a zone observer to the list. This observer will subsequently be notified of effected
and failed zone changes.</div>
</li>
</ul>
<a name="removeZoneObserver-com.threerings.whirled.zone.client.ZoneObserver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeZoneObserver</h4>
<pre>public&nbsp;void&nbsp;removeZoneObserver(<a href="../../../../../com/threerings/whirled/zone/client/ZoneObserver.html" title="interface in com.threerings.whirled.zone.client">ZoneObserver</a>&nbsp;observer)</pre>
<div class="block">Removes a zone observer from the list.</div>
</li>
</ul>
<a name="moveTo-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveTo</h4>
<pre>public&nbsp;boolean&nbsp;moveTo(int&nbsp;zoneId,
int&nbsp;sceneId)</pre>
<div class="block">Requests that this client move the specified scene in the specified zone. A request will be
made and when the response is received, the location observers will be notified of success
or failure.</div>
</li>
</ul>
<a name="moveTo-int-int-com.samskivert.util.ResultListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveTo</h4>
<pre>public&nbsp;boolean&nbsp;moveTo(int&nbsp;zoneId,
int&nbsp;sceneId,
<a href="http://samskivert.github.com/samskivert/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</a>&lt;com.threerings.crowd.data.PlaceConfig&gt;&nbsp;rl)</pre>
<div class="block">Requests that this client move the specified scene in the specified zone. A request will be
made and when the response is received, the location observers will be notified of success
or failure.</div>
</li>
</ul>
<a name="clientDidLogoff-com.threerings.presents.client.Client-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientDidLogoff</h4>
<pre>public&nbsp;void&nbsp;clientDidLogoff(com.threerings.presents.client.Client&nbsp;client)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>clientDidLogoff</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.client.SessionObserver</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clientDidLogoff</code>&nbsp;in class&nbsp;<code>com.threerings.presents.client.BasicDirector</code></dd>
</dl>
</li>
</ul>
<a name="moveRequiresServerSwitch-java.lang.String-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveRequiresServerSwitch</h4>
<pre>public&nbsp;void&nbsp;moveRequiresServerSwitch(<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;hostname,
int[]&nbsp;ports)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveRequiresServerSwitch-java.lang.String-int:A-">ZoneService.ZoneMoveListener</a></code></span></div>
<div class="block">Indicates that the client must switch to the specified server and reissue its move
request in order to relocate to its desired zone.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveRequiresServerSwitch-java.lang.String-int:A-">moveRequiresServerSwitch</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html" title="interface in com.threerings.whirled.zone.client">ZoneService.ZoneMoveListener</a></code></dd>
</dl>
</li>
</ul>
<a name="moveSucceeded-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveSucceeded</h4>
<pre>public&nbsp;void&nbsp;moveSucceeded(int&nbsp;placeId,
com.threerings.crowd.data.PlaceConfig&nbsp;config,
<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;summary)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveSucceeded-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-">ZoneService.ZoneMoveListener</a></code></span></div>
<div class="block">Called in response to a successful <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveSucceeded-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-">moveSucceeded</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html" title="interface in com.threerings.whirled.zone.client">ZoneService.ZoneMoveListener</a></code></dd>
</dl>
</li>
</ul>
<a name="moveSucceededWithUpdates-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneUpdate:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveSucceededWithUpdates</h4>
<pre>public&nbsp;void&nbsp;moveSucceededWithUpdates(int&nbsp;placeId,
com.threerings.crowd.data.PlaceConfig&nbsp;config,
<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;summary,
<a href="../../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</a>[]&nbsp;updates)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveSucceededWithUpdates-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneUpdate:A-">ZoneService.ZoneMoveListener</a></code></span></div>
<div class="block">Called in response to a successful <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request when our cached
scene was out of date and the server determined that we needed some updates.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveSucceededWithUpdates-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneUpdate:A-">moveSucceededWithUpdates</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html" title="interface in com.threerings.whirled.zone.client">ZoneService.ZoneMoveListener</a></code></dd>
</dl>
</li>
</ul>
<a name="moveSucceededWithScene-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveSucceededWithScene</h4>
<pre>public&nbsp;void&nbsp;moveSucceededWithScene(int&nbsp;placeId,
com.threerings.crowd.data.PlaceConfig&nbsp;config,
<a href="../../../../../com/threerings/whirled/zone/data/ZoneSummary.html" title="class in com.threerings.whirled.zone.data">ZoneSummary</a>&nbsp;summary,
<a href="../../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a>&nbsp;model)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveSucceededWithScene-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneModel-">ZoneService.ZoneMoveListener</a></code></span></div>
<div class="block">Called in response to a successful <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request when our cached
scene was out of date and the server determined that we needed an updated copy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html#moveSucceededWithScene-int-com.threerings.crowd.data.PlaceConfig-com.threerings.whirled.zone.data.ZoneSummary-com.threerings.whirled.data.SceneModel-">moveSucceededWithScene</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneService.ZoneMoveListener.html" title="interface in com.threerings.whirled.zone.client">ZoneService.ZoneMoveListener</a></code></dd>
</dl>
</li>
</ul>
<a name="requestFailed-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestFailed</h4>
<pre>public&nbsp;void&nbsp;requestFailed(<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;reason)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>requestFailed</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.client.InvocationService.InvocationListener</code></dd>
</dl>
</li>
</ul>
<a name="forcedMove-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forcedMove</h4>
<pre>public&nbsp;void&nbsp;forcedMove(int&nbsp;zoneId,
int&nbsp;sceneId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneReceiver.html#forcedMove-int-int-">ZoneReceiver</a></code></span></div>
<div class="block">Used to communicate a required move notification to the client. The server will have
removed the client from their existing scene and the client is then responsible for
generating a <a href="../../../../../com/threerings/whirled/zone/client/ZoneService.html#moveTo-int-int-int-com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener-"><code>ZoneService.moveTo(int, int, int, com.threerings.whirled.zone.client.ZoneService.ZoneMoveListener)</code></a> request to move to the new scene in the specified
zone.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/zone/client/ZoneReceiver.html#forcedMove-int-int-">forcedMove</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/zone/client/ZoneReceiver.html" title="interface in com.threerings.whirled.zone.client">ZoneReceiver</a></code></dd>
</dl>
</li>
</ul>
<a name="recoverMoveTo-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>recoverMoveTo</h4>
<pre>public&nbsp;void&nbsp;recoverMoveTo(int&nbsp;previousSceneId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/client/SceneDirector.MoveHandler.html#recoverMoveTo-int-">SceneDirector.MoveHandler</a></code></span></div>
<div class="block">Should instruct the client to move the last known working location (as well as clean up
after the failed moveTo request).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/client/SceneDirector.MoveHandler.html#recoverMoveTo-int-">recoverMoveTo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/client/SceneDirector.MoveHandler.html" title="interface in com.threerings.whirled.client">SceneDirector.MoveHandler</a></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/ZoneDirector.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/whirled/zone/client/ZoneDecoder.html" title="class in com.threerings.whirled.zone.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/zone/client/ZoneObserver.html" title="interface in com.threerings.whirled.zone.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/zone/client/ZoneDirector.html" target="_top">Frames</a></li>
<li><a href="ZoneDirector.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