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

627 lines
33 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:12 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SpotSceneDirector (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="SpotSceneDirector (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,"i13":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/SpotSceneDirector.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/spot/client/SpotSceneController.html" title="class in com.threerings.whirled.spot.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/spot/client/SpotSceneDirector.html" target="_top">Frames</a></li>
<li><a href="SpotSceneDirector.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.spot.client</div>
<h2 title="Class SpotSceneDirector" class="title">Class SpotSceneDirector</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.spot.client.SpotSceneDirector</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.crowd.chat.data.ChatCodes, com.threerings.crowd.data.LocationCodes, com.threerings.presents.client.SessionObserver, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;, <a href="../../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SpotSceneDirector</span>
extends com.threerings.presents.client.BasicDirector
implements <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</a>, com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;, com.threerings.presents.dobj.AttributeChangeListener</pre>
<div class="block">Extends the standard scene director with facilities to move between locations within a scene.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.whirled.spot.data.SpotCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.whirled.spot.data.<a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</a></h3>
<code><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#CLUSTER_CHAT_TYPE">CLUSTER_CHAT_TYPE</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#CLUSTER_FULL">CLUSTER_FULL</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#INVALID_LOCATION">INVALID_LOCATION</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#LOCATION_OCCUPIED">LOCATION_OCCUPIED</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#NO_SUCH_CLUSTER">NO_SUCH_CLUSTER</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#NO_SUCH_PORTAL">NO_SUCH_PORTAL</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.crowd.chat.data.ChatCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.crowd.chat.data.ChatCodes</h3>
<code>BROADCAST_ACCESS, BROADCAST_MODE, CHAT_ACCESS, CHAT_CHANNEL_NOTIFICATION, CHAT_NOTIFICATION, DEFAULT_IDLE_TIME, DEFAULT_MODE, EMOTE_MODE, IDLE_TIME_KEY, LAST_MODE, PLACE_CHAT_TYPE, SHOUT_MODE, SUCCESS, THINK_MODE, USER_CHAT_TYPE, USER_DISCONNECTED, USER_NOT_ONLINE, XLATE_MODES</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.whirled.data.SceneCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.whirled.data.<a href="../../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a></h3>
<code><a href="../../../../../com/threerings/whirled/data/SceneCodes.html#SCENE_UPDATE">SCENE_UPDATE</a>, <a href="../../../../../com/threerings/whirled/data/SceneCodes.html#WHIRLED_GROUP">WHIRLED_GROUP</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.crowd.data.LocationCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.crowd.data.LocationCodes</h3>
<code>ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.presents.data.InvocationCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.presents.data.InvocationCodes</h3>
<code>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</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/spot/client/SpotSceneDirector.html#SpotSceneDirector-com.threerings.whirled.util.WhirledContext-com.threerings.crowd.client.LocationDirector-com.threerings.whirled.client.SceneDirector-">SpotSceneDirector</a></span>(<a href="../../../../../com/threerings/whirled/util/WhirledContext.html" title="interface in com.threerings.whirled.util">WhirledContext</a>&nbsp;ctx,
com.threerings.crowd.client.LocationDirector&nbsp;locdir,
<a href="../../../../../com/threerings/whirled/client/SceneDirector.html" title="class in com.threerings.whirled.client">SceneDirector</a>&nbsp;scdir)</code>
<div class="block">Creates a new spot scene director with the specified context and which will cooperate with
the supplied scene director.</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/spot/client/SpotSceneDirector.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/whirled/spot/client/SpotSceneDirector.html#changeLocation-com.threerings.whirled.spot.data.Location-com.samskivert.util.ResultListener-">changeLocation</a></span>(<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;loc,
<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;<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&gt;&nbsp;listener)</code>
<div class="block">Issues a request to change our location within the scene to the specified location.</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/whirled/spot/client/SpotSceneDirector.html#clientDidLogoff-com.threerings.presents.client.Client-">clientDidLogoff</a></span>(com.threerings.presents.client.Client&nbsp;client)</code>&nbsp;</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/spot/client/SpotSceneDirector.html#clientDidLogon-com.threerings.presents.client.Client-">clientDidLogon</a></span>(com.threerings.presents.client.Client&nbsp;client)</code>&nbsp;</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/spot/client/SpotSceneDirector.html#clientObjectDidChange-com.threerings.presents.client.Client-">clientObjectDidChange</a></span>(com.threerings.presents.client.Client&nbsp;client)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#getIntendedLocation--">getIntendedLocation</a></span>()</code>
<div class="block">Returns our current location unless we have a location change pending, in which case our
pending location is returned.</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/spot/client/SpotSceneDirector.html#joinCluster-int-com.samskivert.util.ResultListener-">joinCluster</a></span>(int&nbsp;froid,
<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;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&nbsp;listener)</code>
<div class="block">Issues a request to join the cluster associated with the specified user (starting one if
necessary).</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/spot/client/SpotSceneDirector.html#objectAvailable-com.threerings.presents.dobj.DObject-">objectAvailable</a></span>(com.threerings.presents.dobj.DObject&nbsp;object)</code>&nbsp;</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/spot/client/SpotSceneDirector.html#requestClusterSpeak-java.lang.String-">requestClusterSpeak</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;message)</code>
<div class="block">Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.</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/spot/client/SpotSceneDirector.html#requestClusterSpeak-java.lang.String-byte-">requestClusterSpeak</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;message,
byte&nbsp;mode)</code>
<div class="block">Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.</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/spot/client/SpotSceneDirector.html#requestFailed-int-com.threerings.presents.dobj.ObjectAccessException-">requestFailed</a></span>(int&nbsp;oid,
com.threerings.presents.dobj.ObjectAccessException&nbsp;cause)</code>&nbsp;</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/spot/client/SpotSceneDirector.html#setChatDirector-com.threerings.crowd.chat.client.ChatDirector-">setChatDirector</a></span>(com.threerings.crowd.chat.client.ChatDirector&nbsp;chatdir)</code>
<div class="block">Configures this spot scene director with a chat director, with which it will coordinate to
implement cluster chatting.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#traversePortal-int-">traversePortal</a></span>(int&nbsp;portalId)</code>
<div class="block">Requests that this client move to the location specified by the supplied portal id.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#traversePortal-int-com.samskivert.util.ResultListener-">traversePortal</a></span>(int&nbsp;portalId,
<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 to the location specified by the supplied portal id.</div>
</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>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="SpotSceneDirector-com.threerings.whirled.util.WhirledContext-com.threerings.crowd.client.LocationDirector-com.threerings.whirled.client.SceneDirector-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SpotSceneDirector</h4>
<pre>public&nbsp;SpotSceneDirector(<a href="../../../../../com/threerings/whirled/util/WhirledContext.html" title="interface in com.threerings.whirled.util">WhirledContext</a>&nbsp;ctx,
com.threerings.crowd.client.LocationDirector&nbsp;locdir,
<a href="../../../../../com/threerings/whirled/client/SceneDirector.html" title="class in com.threerings.whirled.client">SceneDirector</a>&nbsp;scdir)</pre>
<div class="block">Creates a new spot scene director with the specified context and which will cooperate with
the supplied scene director.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - the active client context.</dd>
<dd><code>locdir</code> - the location director with which we will be cooperating.</dd>
<dd><code>scdir</code> - the scene director with which we will be cooperating.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setChatDirector-com.threerings.crowd.chat.client.ChatDirector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChatDirector</h4>
<pre>public&nbsp;void&nbsp;setChatDirector(com.threerings.crowd.chat.client.ChatDirector&nbsp;chatdir)</pre>
<div class="block">Configures this spot scene director with a chat director, with which it will coordinate to
implement cluster chatting.</div>
</li>
</ul>
<a name="getIntendedLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntendedLocation</h4>
<pre>public&nbsp;<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;getIntendedLocation()</pre>
<div class="block">Returns our current location unless we have a location change pending, in which case our
pending location is returned.</div>
</li>
</ul>
<a name="traversePortal-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traversePortal</h4>
<pre>public&nbsp;boolean&nbsp;traversePortal(int&nbsp;portalId)</pre>
<div class="block">Requests that this client move to the location specified by the supplied portal id. A
request will be made and when the response is received, the location observers will be
notified of success or failure.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the request was issued, false if it was rejected by a location observer or
because we have another request outstanding.</dd>
</dl>
</li>
</ul>
<a name="traversePortal-int-com.samskivert.util.ResultListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traversePortal</h4>
<pre>public&nbsp;boolean&nbsp;traversePortal(int&nbsp;portalId,
<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 to the location specified by the supplied portal id. 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="changeLocation-com.threerings.whirled.spot.data.Location-com.samskivert.util.ResultListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeLocation</h4>
<pre>public&nbsp;void&nbsp;changeLocation(<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;loc,
<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;<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&gt;&nbsp;listener)</pre>
<div class="block">Issues a request to change our location within the scene to the specified location.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loc</code> - the new location to which to move.</dd>
<dd><code>listener</code> - will be notified of success or failure. Most client entities find out about
location changes via changes to the occupant info data, but the initiator of a location
change request can be notified of its success or failure, primarily so that it can act in
anticipation of a successful location change (like by starting a sprite moving toward the
new location), but backtrack if it finds out that the location change failed.</dd>
</dl>
</li>
</ul>
<a name="joinCluster-int-com.samskivert.util.ResultListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinCluster</h4>
<pre>public&nbsp;void&nbsp;joinCluster(int&nbsp;froid,
<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;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&nbsp;listener)</pre>
<div class="block">Issues a request to join the cluster associated with the specified user (starting one if
necessary).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>froid</code> - the bodyOid of another user; the calling user will be made to join the target
user's cluster.</dd>
<dd><code>listener</code> - will be notified of success or failure.</dd>
</dl>
</li>
</ul>
<a name="requestClusterSpeak-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestClusterSpeak</h4>
<pre>public&nbsp;boolean&nbsp;requestClusterSpeak(<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;message)</pre>
<div class="block">Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a cluster speak message was delivered, false if we are not in a valid
cluster and refused to deliver the request.</dd>
</dl>
</li>
</ul>
<a name="requestClusterSpeak-java.lang.String-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestClusterSpeak</h4>
<pre>public&nbsp;boolean&nbsp;requestClusterSpeak(<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;message,
byte&nbsp;mode)</pre>
<div class="block">Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a cluster speak message was delivered, false if we are not in a valid
cluster and refused to deliver the request.</dd>
</dl>
</li>
</ul>
<a name="objectAvailable-com.threerings.presents.dobj.DObject-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>objectAvailable</h4>
<pre>public&nbsp;void&nbsp;objectAvailable(com.threerings.presents.dobj.DObject&nbsp;object)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>objectAvailable</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;</code></dd>
</dl>
</li>
</ul>
<a name="requestFailed-int-com.threerings.presents.dobj.ObjectAccessException-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestFailed</h4>
<pre>public&nbsp;void&nbsp;requestFailed(int&nbsp;oid,
com.threerings.presents.dobj.ObjectAccessException&nbsp;cause)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>requestFailed</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;</code></dd>
</dl>
</li>
</ul>
<a name="attributeChanged-com.threerings.presents.dobj.AttributeChangedEvent-">
<!-- -->
</a>
<ul class="blockList">
<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>
<a name="clientDidLogon-com.threerings.presents.client.Client-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientDidLogon</h4>
<pre>public&nbsp;void&nbsp;clientDidLogon(com.threerings.presents.client.Client&nbsp;client)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>clientDidLogon</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.client.SessionObserver</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clientDidLogon</code>&nbsp;in class&nbsp;<code>com.threerings.presents.client.BasicDirector</code></dd>
</dl>
</li>
</ul>
<a name="clientObjectDidChange-com.threerings.presents.client.Client-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientObjectDidChange</h4>
<pre>public&nbsp;void&nbsp;clientObjectDidChange(com.threerings.presents.client.Client&nbsp;client)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>clientObjectDidChange</code>&nbsp;in interface&nbsp;<code>com.threerings.presents.client.SessionObserver</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clientObjectDidChange</code>&nbsp;in class&nbsp;<code>com.threerings.presents.client.BasicDirector</code></dd>
</dl>
</li>
</ul>
<a name="clientDidLogoff-com.threerings.presents.client.Client-">
<!-- -->
</a>
<ul class="blockListLast">
<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>
</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/SpotSceneDirector.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/spot/client/SpotSceneController.html" title="class in com.threerings.whirled.spot.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/spot/client/SpotSceneDirector.html" target="_top">Frames</a></li>
<li><a href="SpotSceneDirector.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