AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated docs for 1.6 release.

Browse Source
This commit is contained in:
Michael Bayne
2015-03-14 10:44:30 -07:00
parent ccf127a3bb
commit 907eaa7014
1099 changed files with 266256 additions and 276770 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apidocs/com/threerings/whirled/spot/client/SpotService.html
+337 -326
View File
@@ -1,350 +1,361 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Wed Apr 06 17:00:16 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
SpotService (vilya 1.3 API)
</TITLE>
<META NAME="date" CONTENT="2011-04-06">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SpotService (vilya 1.3 API)";
<!-- 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>SpotService (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="SpotService (Vilya Core 1.6 API)";
}
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpotService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html" title="class in com.threerings.whirled.spot.client"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/threerings/whirled/spot/client/SpotService.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SpotService.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
<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/SpotService.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/SpotSceneDirector.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.SpotSceneMoveListener.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/SpotService.html" target="_top">Frames</a></li>
<li><a href="SpotService.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) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.threerings.whirled.spot.client</FONT>
<BR>
Interface SpotService</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>com.threerings.presents.client.InvocationService</DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html" title="class in com.threerings.whirled.spot.data">SpotMarshaller</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>SpotService</B><DT>extends com.threerings.presents.client.InvocationService</DL>
</PRE>
<P>
Defines the mechanism by which the client can request to move around
<div class="header">
<div class="subTitle">com.threerings.whirled.spot.client</div>
<h2 title="Interface SpotService" class="title">Interface SpotService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.threerings.presents.client.InvocationService</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.html" title="class in com.threerings.whirled.spot.data">SpotMarshaller</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SpotService</span>
extends com.threerings.presents.client.InvocationService</pre>
<div class="block">Defines the mechanism by which the client can request to move around
within a scene and between scenes (taking exit and entry locations into
account). These services should not be used directly, but instead
should be accessed via the <A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html" title="class in com.threerings.whirled.spot.client"><CODE>SpotSceneDirector</CODE></A>.
<P>
<P>
<HR>
<P>
should be accessed via the <a href="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html" title="class in com.threerings.whirled.spot.client"><code>SpotSceneDirector</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;interface</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to communicate the response to a <A HREF="../../../../../com/threerings/whirled/client/SceneService.html#moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)"><CODE>SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)</CODE></A> request.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="nested_classes_inherited_from_class_com.threerings.presents.client.InvocationService"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface com.threerings.presents.client.InvocationService</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener</CODE></TD>
</TR>
</TABLE>
&nbsp;
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</a></span></code>
<div class="block">Used to communicate the response to a <a href="../../../../../com/threerings/whirled/client/SceneService.html#moveTo-int-int-com.threerings.whirled.client.SceneService.SceneMoveListener-"><code>SceneService.moveTo(int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)</code></a> request.</div>
</td>
</tr>
</table>
<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>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><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></B>(int&nbsp;sceneId,
<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A>&nbsp;loc,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that this client's body be made to move to the specified
location.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.html#clusterSpeak(java.lang.String, byte)">clusterSpeak</A></B>(<A HREF="http://java.sun.com/j2se/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>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that the supplied message be delivered to listeners in the
cluster to which the specified location belongs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.html#joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener)">joinCluster</A></B>(int&nbsp;friendOid,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that this client start or join the specified cluster.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.html#traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener)">traversePortal</A></B>(int&nbsp;sceneId,
int&nbsp;portalId,
int&nbsp;destSceneVer,
<A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</A>&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests to traverse the specified portal.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/client/SpotService.html#changeLocation-int-com.threerings.whirled.spot.data.Location-com.threerings.presents.client.InvocationService.ConfirmListener-">changeLocation</a></span>(int&nbsp;sceneId,
<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;loc,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</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/client/SpotService.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;message,
byte&nbsp;mode)</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/client/SpotService.html#joinCluster-int-com.threerings.presents.client.InvocationService.ConfirmListener-">joinCluster</a></span>(int&nbsp;friendOid,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</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/client/SpotService.html#traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-">traversePortal</a></span>(int&nbsp;sceneId,
int&nbsp;portalId,
int&nbsp;destSceneVer,
<a href="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</a>&nbsp;listener)</code>
<div class="block">Requests to traverse the specified portal.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="traversePortal(int, int, int, com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener)"><!-- --></A><H3>
traversePortal</H3>
<PRE>
void <B>traversePortal</B>(int&nbsp;sceneId,
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="traversePortal-int-int-int-com.threerings.whirled.spot.client.SpotService.SpotSceneMoveListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traversePortal</h4>
<pre>void&nbsp;traversePortal(int&nbsp;sceneId,
int&nbsp;portalId,
int&nbsp;destSceneVer,
<A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Requests to traverse the specified portal.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sceneId</CODE> - the player's current scene which is used to sanity
check things when the request actually arrives.<DD><CODE>portalId</CODE> - the portal to be traversed.<DD><CODE>destSceneVer</CODE> - the version of the destination scene data that
the client has in its local repository.</DL>
</DD>
</DL>
<HR>
<A NAME="changeLocation(int, com.threerings.whirled.spot.data.Location, com.threerings.presents.client.InvocationService.ConfirmListener)"><!-- --></A><H3>
changeLocation</H3>
<PRE>
void <B>changeLocation</B>(int&nbsp;sceneId,
<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A>&nbsp;loc,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</PRE>
<DL>
<DD>Requests that this client's body be made to move to the specified
<a href="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client">SpotService.SpotSceneMoveListener</a>&nbsp;listener)</pre>
<div class="block">Requests to traverse the specified portal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sceneId</code> - the player's current scene which is used to sanity
check things when the request actually arrives.</dd>
<dd><code>portalId</code> - the portal to be traversed.</dd>
<dd><code>destSceneVer</code> - the version of the destination scene data that
the client has in its local repository.</dd>
</dl>
</li>
</ul>
<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>void&nbsp;changeLocation(int&nbsp;sceneId,
<a href="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</a>&nbsp;loc,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</pre>
<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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sceneId</CODE> - the id of the scene in which to change location.<DD><CODE>loc</CODE> - the location to which to move.</DL>
</DD>
</DL>
<HR>
<A NAME="joinCluster(int, com.threerings.presents.client.InvocationService.ConfirmListener)"><!-- --></A><H3>
joinCluster</H3>
<PRE>
void <B>joinCluster</B>(int&nbsp;friendOid,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</PRE>
<DL>
<DD>Requests that this client start or join the specified cluster. They
will be relocated appropriately by the scene manager.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>friendOid</CODE> - the bodyOid of another user or the oid of an
are an occupant.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sceneId</code> - the id of the scene in which to change location.</dd>
<dd><code>loc</code> - the location to which to move.</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>void&nbsp;joinCluster(int&nbsp;friendOid,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>friendOid</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.</DL>
</DD>
</DL>
<HR>
<A NAME="clusterSpeak(java.lang.String, byte)"><!-- --></A><H3>
clusterSpeak</H3>
<PRE>
void <B>clusterSpeak</B>(<A HREF="http://java.sun.com/j2se/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>
<DL>
<DD>Requests that the supplied message be delivered to listeners in the
cluster to which the specified location belongs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the text of the message to be spoken.<DD><CODE>mode</CODE> - an associated mode constant that can be used to
identify different kinds of "speech" (emote, thought bubble, etc.).</DL>
</DD>
</DL>
if they are not already in one.</dd>
</dl>
</li>
</ul>
<a name="clusterSpeak-java.lang.String-byte-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clusterSpeak</h4>
<pre>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;message,
byte&nbsp;mode)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the text of the message to be spoken.</dd>
<dd><code>mode</code> - an associated mode constant that can be used to
identify different kinds of "speech" (emote, thought bubble, etc.).</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpotService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html" title="class in com.threerings.whirled.spot.client"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.SpotSceneMoveListener.html" title="interface in com.threerings.whirled.spot.client"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/threerings/whirled/spot/client/SpotService.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SpotService.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
<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/SpotService.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/SpotSceneDirector.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.SpotSceneMoveListener.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/SpotService.html" target="_top">Frames</a></li>
<li><a href="SpotService.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) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2011. All Rights Reserved.
</BODY>
</HTML>
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>