451 lines
24 KiB
HTML
451 lines
24 KiB
HTML
<!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>SpotSceneManager (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="SpotSceneManager (Vilya Core 1.6 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SpotSceneManager.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/server/SpotProvider.html" title="interface in com.threerings.whirled.spot.server"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../com/threerings/whirled/spot/server/SpotSceneMoveHandler.html" title="class in com.threerings.whirled.spot.server"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/threerings/whirled/spot/server/SpotSceneManager.html" target="_top">Frames</a></li>
|
|
<li><a href="SpotSceneManager.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li><a href="#nested.classes.inherited.from.class.com.threerings.crowd.server.PlaceManager">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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.server</div>
|
|
<h2 title="Class SpotSceneManager" class="title">Class SpotSceneManager</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.crowd.server.PlaceManager</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">com.threerings.whirled.server.SceneManager</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.threerings.whirled.spot.server.SpotSceneManager</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>com.threerings.crowd.chat.data.ChatCodes, com.threerings.crowd.chat.server.SpeakHandler.SpeakerValidator, com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.MessageListener, <a href="../../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</a></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><a href="../../../../../com/threerings/stage/server/StageSceneManager.html" title="class in com.threerings.stage.server">StageSceneManager</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">SpotSceneManager</span>
|
|
extends <a href="../../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">SceneManager</a>
|
|
implements <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</a></pre>
|
|
<div class="block">Handles the movement of bodies between locations in the scene and creates the necessary
|
|
distributed objects to allow bodies in clusters to chat with one another.</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>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.crowd.server.PlaceManager">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Nested classes/interfaces inherited from class com.threerings.crowd.server.PlaceManager</h3>
|
|
<code>com.threerings.crowd.server.PlaceManager.DelegateOp, com.threerings.crowd.server.PlaceManager.MessageHandler</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.whirled.spot.data.SpotCodes">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from interface com.threerings.whirled.spot.data.<a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</a></h3>
|
|
<code><a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#CLUSTER_CHAT_TYPE">CLUSTER_CHAT_TYPE</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#CLUSTER_FULL">CLUSTER_FULL</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#INVALID_LOCATION">INVALID_LOCATION</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#LOCATION_OCCUPIED">LOCATION_OCCUPIED</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#NO_SUCH_CLUSTER">NO_SUCH_CLUSTER</a>, <a href="../../../../../com/threerings/whirled/spot/data/SpotCodes.html#NO_SUCH_PORTAL">NO_SUCH_PORTAL</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.crowd.chat.data.ChatCodes">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from interface 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 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 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 com.threerings.presents.data.InvocationCodes</h3>
|
|
<code>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </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/server/SpotSceneManager.html#SpotSceneManager--">SpotSceneManager</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/server/SpotSceneManager.html#clearEnteringBody-com.threerings.crowd.data.BodyObject-">clearEnteringBody</a></span>(com.threerings.crowd.data.BodyObject body)</code>
|
|
<div class="block">Called if a body failed to enter our scene after we assigned them an entering position.</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/server/SpotSceneManager.html#mapEnteringBody-com.threerings.crowd.data.BodyObject-com.threerings.whirled.spot.data.Portal-">mapEnteringBody</a></span>(com.threerings.crowd.data.BodyObject body,
|
|
<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a> from)</code>
|
|
<div class="block">Assigns a starting location for an entering body.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><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/server/SpotSceneManager.html#mayTraversePortal-com.threerings.crowd.data.BodyObject-com.threerings.whirled.spot.data.Portal-">mayTraversePortal</a></span>(com.threerings.crowd.data.BodyObject body,
|
|
<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a> portal)</code>
|
|
<div class="block">This is called when a user requests to traverse a portal from this scene to another scene.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/server/SpotSceneManager.html#moveBodyToDefaultPortal-com.threerings.crowd.server.PlaceRegistry-com.threerings.crowd.data.BodyObject-">moveBodyToDefaultPortal</a></span>(com.threerings.crowd.server.PlaceRegistry plreg,
|
|
com.threerings.crowd.data.BodyObject body)</code>
|
|
<div class="block">Move the specified body to the default portal, if possible.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/server/SpotSceneManager.html#willTraversePortal-com.threerings.crowd.data.BodyObject-com.threerings.whirled.spot.data.Portal-">willTraversePortal</a></span>(com.threerings.crowd.data.BodyObject body,
|
|
<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a> portal)</code>
|
|
<div class="block">This is called to let this scene manager know that the user is about to traverse the
|
|
specified portal.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.whirled.server.SceneManager">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.threerings.whirled.server.<a href="../../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">SceneManager</a></h3>
|
|
<code><a href="../../../../../com/threerings/whirled/server/SceneManager.html#getLocation--">getLocation</a>, <a href="../../../../../com/threerings/whirled/server/SceneManager.html#getScene--">getScene</a>, <a href="../../../../../com/threerings/whirled/server/SceneManager.html#getUpdates-int-">getUpdates</a>, <a href="../../../../../com/threerings/whirled/server/SceneManager.html#isPersistent--">isPersistent</a>, <a href="../../../../../com/threerings/whirled/server/SceneManager.html#where--">where</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.crowd.server.PlaceManager">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.threerings.crowd.server.PlaceManager</h3>
|
|
<code>addDelegate, applyToDelegates, applyToOccupants, bodyWillEnter, bodyWillLeave, checkPermissions, getConfig, getPlaceObject, init, isValidSpeaker, messageReceived, ratifyBodyEntry, registerMessageHandler, shutdown, startup, toString, updateOccupantInfo</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class 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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="SpotSceneManager--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>SpotSceneManager</h4>
|
|
<pre>public SpotSceneManager()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="moveBodyToDefaultPortal-com.threerings.crowd.server.PlaceRegistry-com.threerings.crowd.data.BodyObject-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>moveBodyToDefaultPortal</h4>
|
|
<pre>public static void moveBodyToDefaultPortal(com.threerings.crowd.server.PlaceRegistry plreg,
|
|
com.threerings.crowd.data.BodyObject body)</pre>
|
|
<div class="block">Move the specified body to the default portal, if possible.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="mapEnteringBody-com.threerings.crowd.data.BodyObject-com.threerings.whirled.spot.data.Portal-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mapEnteringBody</h4>
|
|
<pre>public void mapEnteringBody(com.threerings.crowd.data.BodyObject body,
|
|
<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a> from)</pre>
|
|
<div class="block">Assigns a starting location for an entering body. This will happen before the body is made
|
|
to "occupy" the scene (defined by their having an occupant info record). So when they do
|
|
finally occupy the scene, the client will know where to render them.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="clearEnteringBody-com.threerings.crowd.data.BodyObject-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>clearEnteringBody</h4>
|
|
<pre>public void clearEnteringBody(com.threerings.crowd.data.BodyObject body)</pre>
|
|
<div class="block">Called if a body failed to enter our scene after we assigned them an entering position.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="mayTraversePortal-com.threerings.crowd.data.BodyObject-com.threerings.whirled.spot.data.Portal-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mayTraversePortal</h4>
|
|
<pre>public <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> mayTraversePortal(com.threerings.crowd.data.BodyObject body,
|
|
<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a> portal)</pre>
|
|
<div class="block">This is called when a user requests to traverse a portal from this scene to another scene.
|
|
The manager may return an error code string that will be reported back to the caller
|
|
explaining the failure or <code>null</code> indicating that it is OK for the caller to
|
|
traverse the portal.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="willTraversePortal-com.threerings.crowd.data.BodyObject-com.threerings.whirled.spot.data.Portal-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>willTraversePortal</h4>
|
|
<pre>public void willTraversePortal(com.threerings.crowd.data.BodyObject body,
|
|
<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a> portal)</pre>
|
|
<div class="block">This is called to let this scene manager know that the user is about to traverse the
|
|
specified portal. The default implementation relocates the user to the location associated
|
|
with the portal. It is still possible that the traversal will fail, so don't do anything too
|
|
crazy.</div>
|
|
</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/SpotSceneManager.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/server/SpotProvider.html" title="interface in com.threerings.whirled.spot.server"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../com/threerings/whirled/spot/server/SpotSceneMoveHandler.html" title="class in com.threerings.whirled.spot.server"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/threerings/whirled/spot/server/SpotSceneManager.html" target="_top">Frames</a></li>
|
|
<li><a href="SpotSceneManager.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li><a href="#nested.classes.inherited.from.class.com.threerings.crowd.server.PlaceManager">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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 © 2015. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|