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/SpotService.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

362 lines
16 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>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)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.whirled.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>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/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 =========== -->
<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 ========== -->
<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>
<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.</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.</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 ========= -->
<!-- ======= 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/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) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink