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

559 lines
30 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>SpotMarshaller (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="SpotMarshaller (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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/SpotMarshaller.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/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html" title="class in com.threerings.whirled.spot.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/spot/data/SpotMarshaller.html" target="_top">Frames</a></li>
<li><a href="SpotMarshaller.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.data</div>
<h2 title="Class SpotMarshaller" class="title">Class SpotMarshaller</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.data.InvocationMarshaller</li>
<li>
<ul class="inheritance">
<li>com.threerings.whirled.spot.data.SpotMarshaller</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.io.Streamable, com.threerings.presents.client.InvocationService, <a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></dd>
</dl>
<hr>
<br>
<pre>@Generated(value="com.threerings.presents.tools.GenServiceTask",
comments="Derived from SpotService.java.")
public class <span class="typeNameLabel">SpotMarshaller</span>
extends com.threerings.presents.data.InvocationMarshaller
implements <a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></pre>
<div class="block">Provides the implementation of the <a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client"><code>SpotService</code></a> interface
that marshalls the arguments and delivers the request to the provider
on the server. Also provides an implementation of the response listener
interfaces that marshall the response arguments and deliver them back
to the requesting 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">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html" title="class in com.threerings.whirled.spot.data">SpotMarshaller.SpotSceneMoveMarshaller</a></span></code>
<div class="block">Marshalls results to implementations of <code>SpotService.SpotSceneMoveListener</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.presents.data.InvocationMarshaller">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.threerings.presents.data.InvocationMarshaller</h3>
<code>com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.whirled.spot.client.SpotService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.whirled.spot.client.<a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></h3>
<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.presents.client.InvocationService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.presents.client.InvocationService</h3>
<code>com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.io.Streamable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.io.Streamable</h3>
<code>com.threerings.io.Streamable.Closure</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#CHANGE_LOCATION">CHANGE_LOCATION</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#CLUSTER_SPEAK">CLUSTER_SPEAK</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#clusterSpeak-java.lang.String-byte-"><code>clusterSpeak(java.lang.String, byte)</code></a> requests.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#JOIN_CLUSTER">JOIN_CLUSTER</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#TRAVERSE_PORTAL">TRAVERSE_PORTAL</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-"><code>traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener)</code></a> requests.</div>
</td>
</tr>
</table>
</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/data/SpotMarshaller.html#SpotMarshaller--">SpotMarshaller</a></span>()</code>&nbsp;</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/data/SpotMarshaller.html#changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-">changeLocation</a></span>(int&nbsp;arg1,
<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;arg2,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;arg3)</code>
<div class="block">Requests that this client's body be made to move to the specified
location.</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/spot/data/SpotMarshaller.html#clusterSpeak-java.lang.String-byte-">clusterSpeak</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;arg1,
byte&nbsp;arg2)</code>
<div class="block">Requests that the supplied message be delivered to listeners in the
cluster to which the specified location belongs.</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/data/SpotMarshaller.html#joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-">joinCluster</a></span>(int&nbsp;arg1,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;arg2)</code>
<div class="block">Requests that this client start or join the specified cluster.</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/spot/data/SpotMarshaller.html#traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-">traversePortal</a></span>(int&nbsp;arg1,
int&nbsp;arg2,
int&nbsp;arg3,
<a href="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</a>&nbsp;arg4)</code>
<div class="block">Requests to traverse the specified portal.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.presents.data.InvocationMarshaller">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.presents.data.InvocationMarshaller</h3>
<code>getInvocationCode, init, readObject, setInvocationOid, setNoResponse, toString</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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CHANGE_LOCATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CHANGE_LOCATION</h4>
<pre>public static final&nbsp;int CHANGE_LOCATION</pre>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotMarshaller.CHANGE_LOCATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLUSTER_SPEAK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLUSTER_SPEAK</h4>
<pre>public static final&nbsp;int CLUSTER_SPEAK</pre>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#clusterSpeak-java.lang.String-byte-"><code>clusterSpeak(java.lang.String, byte)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotMarshaller.CLUSTER_SPEAK">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="JOIN_CLUSTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOIN_CLUSTER</h4>
<pre>public static final&nbsp;int JOIN_CLUSTER</pre>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotMarshaller.JOIN_CLUSTER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TRAVERSE_PORTAL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TRAVERSE_PORTAL</h4>
<pre>public static final&nbsp;int TRAVERSE_PORTAL</pre>
<div class="block">The method id used to dispatch <a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html#traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-"><code>traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotMarshaller.TRAVERSE_PORTAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SpotMarshaller--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SpotMarshaller</h4>
<pre>public&nbsp;SpotMarshaller()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeLocation</h4>
<pre>public&nbsp;void&nbsp;changeLocation(int&nbsp;arg1,
<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;arg2,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;arg3)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-">SpotService</a></code></span></div>
<div class="block">Requests that this client's body be made to move to the specified
location. The user will be removed from any cluster from which they
are an occupant.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-">changeLocation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the id of the scene in which to change location.</dd>
<dd><code>arg2</code> - the location to which to move.</dd>
</dl>
</li>
</ul>
<a name="clusterSpeak-java.lang.String-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clusterSpeak</h4>
<pre>public&nbsp;void&nbsp;clusterSpeak(<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;arg1,
byte&nbsp;arg2)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#clusterSpeak-java.lang.String-byte-">SpotService</a></code></span></div>
<div class="block">Requests that the supplied message be delivered to listeners in the
cluster to which the specified location belongs.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#clusterSpeak-java.lang.String-byte-">clusterSpeak</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the text of the message to be spoken.</dd>
<dd><code>arg2</code> - an associated mode constant that can be used to
identify different kinds of "speech" (emote, thought bubble, etc.).</dd>
</dl>
</li>
</ul>
<a name="joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinCluster</h4>
<pre>public&nbsp;void&nbsp;joinCluster(int&nbsp;arg1,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;arg2)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-">SpotService</a></code></span></div>
<div class="block">Requests that this client start or join the specified cluster. They
will be relocated appropriately by the scene manager.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-">joinCluster</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the bodyOid of another user or the oid of an
existing cluster; the calling user will be made to join the cluster
or target user's cluster, or create a cluster with the target user
if they are not already in one.</dd>
</dl>
</li>
</ul>
<a name="traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>traversePortal</h4>
<pre>public&nbsp;void&nbsp;traversePortal(int&nbsp;arg1,
int&nbsp;arg2,
int&nbsp;arg3,
<a href="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</a>&nbsp;arg4)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-">SpotService</a></code></span></div>
<div class="block">Requests to traverse the specified portal.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-">traversePortal</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client">SpotService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the player's current scene which is used to sanity
check things when the request actually arrives.</dd>
<dd><code>arg2</code> - the portal to be traversed.</dd>
<dd><code>arg3</code> - the version of the destination scene data that
the client has in its local repository.</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/SpotMarshaller.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/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.SpotSceneMoveMarshaller.html" title="class in com.threerings.whirled.spot.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/whirled/spot/data/SpotMarshaller.html" target="_top">Frames</a></li>
<li><a href="SpotMarshaller.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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