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

372 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>SpotCodes (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="SpotCodes (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
</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/SpotCodes.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/SceneLocation.html" title="class in com.threerings.whirled.spot.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.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/SpotCodes.html" target="_top">Frames</a></li>
<li><a href="SpotCodes.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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="Interface SpotCodes" class="title">Interface SpotCodes</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.threerings.crowd.chat.data.ChatCodes, com.threerings.presents.data.InvocationCodes, com.threerings.crowd.data.LocationCodes, <a href="../../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html" title="class in com.threerings.whirled.spot.client">SpotSceneDirector</a>, <a href="../../../../../com/threerings/whirled/spot/server/SpotSceneManager.html" title="class in com.threerings.whirled.spot.server">SpotSceneManager</a>, <a href="../../../../../com/threerings/stage/server/StageSceneManager.html" title="class in com.threerings.stage.server">StageSceneManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SpotCodes</span>
extends com.threerings.crowd.chat.data.ChatCodes, <a href="../../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a></pre>
<div class="block">Contains codes used by the Spot invocation services.</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>
<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 <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#CLUSTER_CHAT_TYPE">CLUSTER_CHAT_TYPE</a></span></code>
<div class="block">The chat type code with which we register our cluster auxiliary
chat objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#CLUSTER_FULL">CLUSTER_FULL</a></span></code>
<div class="block">An error code indicating that a cluster is full.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#INVALID_LOCATION">INVALID_LOCATION</a></span></code>
<div class="block">An error code indicating that a location is not valid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#LOCATION_OCCUPIED">LOCATION_OCCUPIED</a></span></code>
<div class="block">An error code indicating that a location is occupied.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#NO_SUCH_CLUSTER">NO_SUCH_CLUSTER</a></span></code>
<div class="block">An error code indicating that a cluster is not valid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#NO_SUCH_PORTAL">NO_SUCH_PORTAL</a></span></code>
<div class="block">An error code indicating that the portal specified in a
traversePortal request does not exist.</div>
</td>
</tr>
</table>
<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>
</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="NO_SUCH_PORTAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_SUCH_PORTAL</h4>
<pre>static final&nbsp;<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> NO_SUCH_PORTAL</pre>
<div class="block">An error code indicating that the portal specified in a
traversePortal request does not exist.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotCodes.NO_SUCH_PORTAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOCATION_OCCUPIED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOCATION_OCCUPIED</h4>
<pre>static final&nbsp;<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> LOCATION_OCCUPIED</pre>
<div class="block">An error code indicating that a location is occupied. Usually
generated by a failed changeLoc request.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotCodes.LOCATION_OCCUPIED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INVALID_LOCATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVALID_LOCATION</h4>
<pre>static final&nbsp;<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> INVALID_LOCATION</pre>
<div class="block">An error code indicating that a location is not valid. Usually
generated by a failed changeLoc request.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotCodes.INVALID_LOCATION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NO_SUCH_CLUSTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_SUCH_CLUSTER</h4>
<pre>static final&nbsp;<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> NO_SUCH_CLUSTER</pre>
<div class="block">An error code indicating that a cluster is not valid. Usually
generated by a failed joinCluster request.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotCodes.NO_SUCH_CLUSTER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLUSTER_FULL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLUSTER_FULL</h4>
<pre>static final&nbsp;<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> CLUSTER_FULL</pre>
<div class="block">An error code indicating that a cluster is full. Usually generated
by a failed joinCluster request.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotCodes.CLUSTER_FULL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLUSTER_CHAT_TYPE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CLUSTER_CHAT_TYPE</h4>
<pre>static final&nbsp;<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> CLUSTER_CHAT_TYPE</pre>
<div class="block">The chat type code with which we register our cluster auxiliary
chat objects. Chat display implementations should interpret chat
messages with this type accordingly.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.whirled.spot.data.SpotCodes.CLUSTER_CHAT_TYPE">Constant Field Values</a></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/SpotCodes.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/SceneLocation.html" title="class in com.threerings.whirled.spot.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/whirled/spot/data/SpotMarshaller.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/SpotCodes.html" target="_top">Frames</a></li>
<li><a href="SpotCodes.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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