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

353 lines
15 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>SpotScene (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="SpotScene (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/SpotScene.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/SpotMarshaller.SpotSceneMoveMarshaller.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/SpotSceneImpl.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/SpotScene.html" target="_top">Frames</a></li>
<li><a href="SpotScene.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>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.data</div>
<h2 title="Interface SpotScene" class="title">Interface SpotScene</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html" title="class in com.threerings.whirled.spot.data">SpotSceneImpl</a>, <a href="../../../../../com/threerings/stage/data/StageScene.html" title="class in com.threerings.stage.data">StageScene</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SpotScene</span></pre>
<div class="block">Makes available the spot scene information that the server needs to do its business.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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/data/SpotScene.html#addPortal-com.threerings.whirled.spot.data.Portal-">addPortal</a></span>(<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;portal)</code>
<div class="block">Adds a portal to this scene, immediately making the requisite modifications to the
underlying scene model.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getDefaultEntrance--">getDefaultEntrance</a></span>()</code>
<div class="block">Returns the portal that represents the default entrance to this scene.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getNextPortalId--">getNextPortalId</a></span>()</code>
<div class="block">Returns the portal id that should be assigned to the next portal added to this scene.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortal-int-">getPortal</a></span>(int&nbsp;portalId)</code>
<div class="block">Returns a <a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data"><code>Portal</code></a> object for the portal with the specified id or null if no portal
exists with that id.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortalCount--">getPortalCount</a></span>()</code>
<div class="block">Returns the number of portals in this scene.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortals--">getPortals</a></span>()</code>
<div class="block">Returns an iterator over the portals in this scene.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#removePortal-com.threerings.whirled.spot.data.Portal-">removePortal</a></span>(<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;portal)</code>
<div class="block">Removes the specified portal from the scene.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#setDefaultEntrance-com.threerings.whirled.spot.data.Portal-">setDefaultEntrance</a></span>(<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;portal)</code>
<div class="block">Sets the default entrance in this scene, immediately making the requisite modifications to
the underlying scene model.</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="getPortal-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPortal</h4>
<pre><a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;getPortal(int&nbsp;portalId)</pre>
<div class="block">Returns a <a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data"><code>Portal</code></a> object for the portal with the specified id or null if no portal
exists with that id.</div>
</li>
</ul>
<a name="getPortalCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPortalCount</h4>
<pre>int&nbsp;getPortalCount()</pre>
<div class="block">Returns the number of portals in this scene.</div>
</li>
</ul>
<a name="getPortals--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPortals</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&gt;&nbsp;getPortals()</pre>
<div class="block">Returns an iterator over the portals in this scene.</div>
</li>
</ul>
<a name="getNextPortalId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextPortalId</h4>
<pre>short&nbsp;getNextPortalId()</pre>
<div class="block">Returns the portal id that should be assigned to the next portal added to this scene.</div>
</li>
</ul>
<a name="getDefaultEntrance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultEntrance</h4>
<pre><a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;getDefaultEntrance()</pre>
<div class="block">Returns the portal that represents the default entrance to this scene. If a body enters the
scene at logon time rather than entering from some other scene, this is the portal at which
they would appear.</div>
</li>
</ul>
<a name="addPortal-com.threerings.whirled.spot.data.Portal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPortal</h4>
<pre>void&nbsp;addPortal(<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;portal)</pre>
<div class="block">Adds a portal to this scene, immediately making the requisite modifications to the
underlying scene model. The portal id should have already been assigned using the value
obtained from <a href="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getNextPortalId--"><code>getNextPortalId()</code></a>.</div>
</li>
</ul>
<a name="removePortal-com.threerings.whirled.spot.data.Portal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePortal</h4>
<pre>void&nbsp;removePortal(<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;portal)</pre>
<div class="block">Removes the specified portal from the scene.</div>
</li>
</ul>
<a name="setDefaultEntrance-com.threerings.whirled.spot.data.Portal-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDefaultEntrance</h4>
<pre>void&nbsp;setDefaultEntrance(<a href="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</a>&nbsp;portal)</pre>
<div class="block">Sets the default entrance in this scene, immediately making the requisite modifications to
the underlying scene model.</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/SpotScene.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/SpotMarshaller.SpotSceneMoveMarshaller.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/SpotSceneImpl.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/SpotScene.html" target="_top">Frames</a></li>
<li><a href="SpotScene.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>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