Updated docs for 1.6 release.
This commit is contained in:
@@ -1,114 +1,127 @@
|
||||
<!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>
|
||||
SceneRegistry (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="SceneRegistry (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>SceneRegistry (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="SceneRegistry (Vilya Core 1.6 API)";
|
||||
}
|
||||
}
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
<HR>
|
||||
|
||||
|
||||
catch(err) {
|
||||
}
|
||||
//-->
|
||||
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
|
||||
var tabs = {65535:["t0","All 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 ======= -->
|
||||
<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> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SceneRegistry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../com/threerings/whirled/server/SceneRegistry.ConfigFactory.html" title="interface in com.threerings.whirled.server"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../index.html?com/threerings/whirled/server/SceneRegistry.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="SceneRegistry.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<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/SceneRegistry.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/server/SceneProvider.html" title="interface in com.threerings.whirled.server"><span class="typeNameLink">Prev Class</span></a></li>
|
||||
<li><a href="../../../../com/threerings/whirled/server/SceneRegistry.ConfigFactory.html" title="interface in com.threerings.whirled.server"><span class="typeNameLink">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../index.html?com/threerings/whirled/server/SceneRegistry.html" target="_top">Frames</a></li>
|
||||
<li><a href="SceneRegistry.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) {
|
||||
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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
</script>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="subNavList">
|
||||
<li>Summary: </li>
|
||||
<li><a href="#nested.class.summary">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 ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
com.threerings.whirled.server</FONT>
|
||||
<BR>
|
||||
Class SceneRegistry</H2>
|
||||
<PRE>
|
||||
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
||||
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.whirled.server.SceneRegistry</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider, <A HREF="../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</A>, <A HREF="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server">SceneProvider</A></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/threerings/whirled/spot/server/SpotSceneRegistry.html" title="class in com.threerings.whirled.spot.server">SpotSceneRegistry</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>SceneRegistry</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</A>, <A HREF="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server">SceneProvider</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
The scene registry is responsible for the management of all scenes. It handles interaction with
|
||||
<div class="header">
|
||||
<div class="subTitle">com.threerings.whirled.server</div>
|
||||
<h2 title="Class SceneRegistry" class="title">Class SceneRegistry</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.whirled.server.SceneRegistry</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="description">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<dl>
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd>com.threerings.crowd.data.LocationCodes, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider, <a href="../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a>, <a href="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server">SceneProvider</a></dd>
|
||||
</dl>
|
||||
<dl>
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><a href="../../../../com/threerings/whirled/spot/server/SpotSceneRegistry.html" title="class in com.threerings.whirled.spot.server">SpotSceneRegistry</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<br>
|
||||
<pre>public class <span class="typeNameLabel">SceneRegistry</span>
|
||||
extends <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>
|
||||
implements <a href="../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data">SceneCodes</a>, <a href="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server">SceneProvider</a></pre>
|
||||
<div class="block">The scene registry is responsible for the management of all scenes. It handles interaction with
|
||||
the scene repository and ensures that scenes are loaded into memory when needed and flushed from
|
||||
memory when not needed.
|
||||
|
||||
@@ -117,395 +130,360 @@ The scene registry is responsible for the management of all scenes. It handles i
|
||||
queue. Thus its interfaces for accessing scenes are structured so as to not block the dobjmgr
|
||||
thread while waiting for scenes to be read from or written to the repository.
|
||||
|
||||
<p><em>Note:</em> All access to the scene registry should take place from the dobjmgr thread.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<p><em>Note:</em> All access to the scene registry should take place from the dobjmgr thread.</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 interface</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.ConfigFactory.html" title="interface in com.threerings.whirled.server">SceneRegistry.ConfigFactory</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Used to create <CODE>PlaceConfig</CODE> instances for scenes.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static interface</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.ResolutionListener.html" title="interface in com.threerings.whirled.server">SceneRegistry.ResolutionListener</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Because scenes must be loaded from the scene repository and this must not be done on the
|
||||
<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"> </span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||||
<th class="colLast" scope="col">Class and Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>static interface </code></td>
|
||||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/server/SceneRegistry.ConfigFactory.html" title="interface in com.threerings.whirled.server">SceneRegistry.ConfigFactory</a></span></code>
|
||||
<div class="block">Used to create <code>PlaceConfig</code> instances for scenes.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>static interface </code></td>
|
||||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/server/SceneRegistry.ResolutionListener.html" title="interface in com.threerings.whirled.server">SceneRegistry.ResolutionListener</a></span></code>
|
||||
<div class="block">Because scenes must be loaded from the scene repository and this must not be done on the
|
||||
dobjmgr thread, the interface for resolving scenes requires that the entity that wishes for
|
||||
a scene to be resolved implement this callback interface so that it can be notified when a
|
||||
scene has been loaded and initialized.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_com.threerings.whirled.data.SceneCodes"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>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></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><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></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_com.threerings.crowd.data.LocationCodes"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface com.threerings.crowd.data.LocationCodes</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>ALREADY_THERE, MOVE_IN_PROGRESS, NO_SUCH_PLACE</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_com.threerings.presents.data.InvocationCodes"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Fields inherited from interface com.threerings.presents.data.InvocationCodes</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
scene has been loaded and initialized.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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.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 ======== -->
|
||||
|
||||
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#SceneRegistry(com.threerings.presents.server.InvocationManager)">SceneRegistry</A></B>(com.threerings.presents.server.InvocationManager invmgr)</CODE>
|
||||
|
||||
<BR>
|
||||
Constructs a scene registry.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<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/server/SceneRegistry.html#SceneRegistry-com.threerings.presents.server.InvocationManager-">SceneRegistry</a></span>(com.threerings.presents.server.InvocationManager invmgr)</code>
|
||||
<div class="block">Constructs a scene registry.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</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> <A HREF="../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">SceneManager</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#getSceneManager(int)">getSceneManager</A></B>(int sceneId)</CODE>
|
||||
|
||||
<BR>
|
||||
Fetches the scene manager associated with the specified scene.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../com/threerings/whirled/server/persist/SceneRepository.html" title="interface in com.threerings.whirled.server.persist">SceneRepository</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#getSceneRepository()">getSceneRepository</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a reference to the scene repository in use by this registry.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#leaveOccupiedScene(com.threerings.crowd.data.BodyObject)">leaveOccupiedScene</A></B>(com.threerings.crowd.data.BodyObject source)</CODE>
|
||||
|
||||
<BR>
|
||||
Ejects the specified body from their current scene and zone.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#moveBody(com.threerings.crowd.data.BodyObject, int)">moveBody</A></B>(com.threerings.crowd.data.BodyObject source,
|
||||
int sceneId)</CODE>
|
||||
|
||||
<BR>
|
||||
Ejects the specified body from their current scene and sends them a request to move to the
|
||||
specified new scene.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#moveTo(com.threerings.presents.data.ClientObject, int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)">moveTo</A></B>(com.threerings.presents.data.ClientObject caller,
|
||||
int sceneId,
|
||||
int sceneVer,
|
||||
<A HREF="../../../../com/threerings/whirled/client/SceneService.SceneMoveListener.html" title="interface in com.threerings.whirled.client">SceneService.SceneMoveListener</A> listener)</CODE>
|
||||
|
||||
<BR>
|
||||
Handles 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>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#resolveScene(int, com.threerings.whirled.server.SceneRegistry.ResolutionListener)">resolveScene</A></B>(int sceneId,
|
||||
<A HREF="../../../../com/threerings/whirled/server/SceneRegistry.ResolutionListener.html" title="interface in com.threerings.whirled.server">SceneRegistry.ResolutionListener</A> target)</CODE>
|
||||
|
||||
<BR>
|
||||
Requests that the specified scene be resolved, which means loaded into the server and
|
||||
initialized if the scene is not currently active.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <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></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#where(int)">where</A></B>(int sceneId)</CODE>
|
||||
|
||||
<BR>
|
||||
Returns <A HREF="../../../../com/threerings/whirled/server/SceneManager.html#where()"><CODE>SceneManager.where()</CODE></A> for the specified scene or <code>null:sceneId</code> if
|
||||
no scene manager exists for that scene.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<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"> </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><a href="../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">SceneManager</a></code></td>
|
||||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/server/SceneRegistry.html#getSceneManager-int-">getSceneManager</a></span>(int sceneId)</code>
|
||||
<div class="block">Fetches the scene manager associated with the specified scene.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="i1" class="rowColor">
|
||||
<td class="colFirst"><code><a href="../../../../com/threerings/whirled/server/persist/SceneRepository.html" title="interface in com.threerings.whirled.server.persist">SceneRepository</a></code></td>
|
||||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/server/SceneRegistry.html#getSceneRepository--">getSceneRepository</a></span>()</code>
|
||||
<div class="block">Returns a reference to the scene repository in use by this registry.</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/server/SceneRegistry.html#leaveOccupiedScene-com.threerings.crowd.data.BodyObject-">leaveOccupiedScene</a></span>(com.threerings.crowd.data.BodyObject source)</code>
|
||||
<div class="block">Ejects the specified body from their current scene and zone.</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/server/SceneRegistry.html#moveBody-com.threerings.crowd.data.BodyObject-int-">moveBody</a></span>(com.threerings.crowd.data.BodyObject source,
|
||||
int sceneId)</code>
|
||||
<div class="block">Ejects the specified body from their current scene and sends them a request to move to the
|
||||
specified new scene.</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/server/SceneRegistry.html#moveTo-com.threerings.presents.data.ClientObject-int-int-com.threerings.whirled.client.SceneService.SceneMoveListener-">moveTo</a></span>(com.threerings.presents.data.ClientObject caller,
|
||||
int sceneId,
|
||||
int sceneVer,
|
||||
<a href="../../../../com/threerings/whirled/client/SceneService.SceneMoveListener.html" title="interface in com.threerings.whirled.client">SceneService.SceneMoveListener</a> listener)</code>
|
||||
<div class="block">Handles 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>
|
||||
<tr id="i5" class="rowColor">
|
||||
<td class="colFirst"><code>void</code></td>
|
||||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/server/SceneRegistry.html#resolveScene-int-com.threerings.whirled.server.SceneRegistry.ResolutionListener-">resolveScene</a></span>(int sceneId,
|
||||
<a href="../../../../com/threerings/whirled/server/SceneRegistry.ResolutionListener.html" title="interface in com.threerings.whirled.server">SceneRegistry.ResolutionListener</a> target)</code>
|
||||
<div class="block">Requests that the specified scene be resolved, which means loaded into the server and
|
||||
initialized if the scene is not currently active.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="i6" 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/server/SceneRegistry.html#where-int-">where</a></span>(int sceneId)</code>
|
||||
<div class="block">Returns <a href="../../../../com/threerings/whirled/server/SceneManager.html#where--"><code>SceneManager.where()</code></a> for the specified scene or <code>null:sceneId</code> if
|
||||
no scene manager exists for that scene.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<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#toString--" title="class or interface in java.lang">toString</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 ======== -->
|
||||
|
||||
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="SceneRegistry(com.threerings.presents.server.InvocationManager)"><!-- --></A><H3>
|
||||
SceneRegistry</H3>
|
||||
<PRE>
|
||||
<FONT SIZE="-1">@Inject
|
||||
</FONT>public <B>SceneRegistry</B>(com.threerings.presents.server.InvocationManager invmgr)</PRE>
|
||||
<DL>
|
||||
<DD>Constructs a scene registry.
|
||||
<P>
|
||||
</DL>
|
||||
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="constructor.detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Constructor Detail</h3>
|
||||
<a name="SceneRegistry-com.threerings.presents.server.InvocationManager-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>SceneRegistry</h4>
|
||||
<pre>@Inject
|
||||
public SceneRegistry(com.threerings.presents.server.InvocationManager invmgr)</pre>
|
||||
<div class="block">Constructs a scene registry.</div>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- ============ 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="getSceneManager(int)"><!-- --></A><H3>
|
||||
getSceneManager</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">SceneManager</A> <B>getSceneManager</B>(int sceneId)</PRE>
|
||||
<DL>
|
||||
<DD>Fetches the scene manager associated with the specified scene.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the scene manager for the specified scene or null if no scene manager is loaded for
|
||||
that scene.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getSceneRepository()"><!-- --></A><H3>
|
||||
getSceneRepository</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../com/threerings/whirled/server/persist/SceneRepository.html" title="interface in com.threerings.whirled.server.persist">SceneRepository</A> <B>getSceneRepository</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns a reference to the scene repository in use by this registry.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="where(int)"><!-- --></A><H3>
|
||||
where</H3>
|
||||
<PRE>
|
||||
public <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> <B>where</B>(int sceneId)</PRE>
|
||||
<DL>
|
||||
<DD>Returns <A HREF="../../../../com/threerings/whirled/server/SceneManager.html#where()"><CODE>SceneManager.where()</CODE></A> for the specified scene or <code>null:sceneId</code> if
|
||||
no scene manager exists for that scene.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="resolveScene(int, com.threerings.whirled.server.SceneRegistry.ResolutionListener)"><!-- --></A><H3>
|
||||
resolveScene</H3>
|
||||
<PRE>
|
||||
public void <B>resolveScene</B>(int sceneId,
|
||||
<A HREF="../../../../com/threerings/whirled/server/SceneRegistry.ResolutionListener.html" title="interface in com.threerings.whirled.server">SceneRegistry.ResolutionListener</A> target)</PRE>
|
||||
<DL>
|
||||
<DD>Requests that the specified scene be resolved, which means loaded into the server and
|
||||
<ul class="blockList">
|
||||
<li class="blockList"><a name="method.detail">
|
||||
<!-- -->
|
||||
</a>
|
||||
<h3>Method Detail</h3>
|
||||
<a name="getSceneManager-int-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>getSceneManager</h4>
|
||||
<pre>public <a href="../../../../com/threerings/whirled/server/SceneManager.html" title="class in com.threerings.whirled.server">SceneManager</a> getSceneManager(int sceneId)</pre>
|
||||
<div class="block">Fetches the scene manager associated with the specified scene.</div>
|
||||
<dl>
|
||||
<dt><span class="returnLabel">Returns:</span></dt>
|
||||
<dd>the scene manager for the specified scene or null if no scene manager is loaded for
|
||||
that scene.</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="getSceneRepository--">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>getSceneRepository</h4>
|
||||
<pre>public <a href="../../../../com/threerings/whirled/server/persist/SceneRepository.html" title="interface in com.threerings.whirled.server.persist">SceneRepository</a> getSceneRepository()</pre>
|
||||
<div class="block">Returns a reference to the scene repository in use by this registry.</div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="where-int-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>where</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> where(int sceneId)</pre>
|
||||
<div class="block">Returns <a href="../../../../com/threerings/whirled/server/SceneManager.html#where--"><code>SceneManager.where()</code></a> for the specified scene or <code>null:sceneId</code> if
|
||||
no scene manager exists for that scene.</div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="resolveScene-int-com.threerings.whirled.server.SceneRegistry.ResolutionListener-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>resolveScene</h4>
|
||||
<pre>public void resolveScene(int sceneId,
|
||||
<a href="../../../../com/threerings/whirled/server/SceneRegistry.ResolutionListener.html" title="interface in com.threerings.whirled.server">SceneRegistry.ResolutionListener</a> target)</pre>
|
||||
<div class="block">Requests that the specified scene be resolved, which means loaded into the server and
|
||||
initialized if the scene is not currently active. The supplied callback instance will be
|
||||
notified, on the dobjmgr thread, when the scene has been resolved. If the scene is already
|
||||
active, it will be notified immediately (before the call to <A HREF="../../../../com/threerings/whirled/server/SceneRegistry.html#resolveScene(int, com.threerings.whirled.server.SceneRegistry.ResolutionListener)"><CODE>resolveScene(int, com.threerings.whirled.server.SceneRegistry.ResolutionListener)</CODE></A> returns).
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>sceneId</CODE> - the id of the scene to resolve.<DD><CODE>target</CODE> - a reference to a callback instance that will be notified when the scene has
|
||||
been resolved (which may be immediately if the scene is already active).</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="moveTo(com.threerings.presents.data.ClientObject, int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)"><!-- --></A><H3>
|
||||
moveTo</H3>
|
||||
<PRE>
|
||||
public void <B>moveTo</B>(com.threerings.presents.data.ClientObject caller,
|
||||
active, it will be notified immediately (before the call to <a href="../../../../com/threerings/whirled/server/SceneRegistry.html#resolveScene-int-com.threerings.whirled.server.SceneRegistry.ResolutionListener-"><code>resolveScene(int, com.threerings.whirled.server.SceneRegistry.ResolutionListener)</code></a> returns).</div>
|
||||
<dl>
|
||||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||||
<dd><code>sceneId</code> - the id of the scene to resolve.</dd>
|
||||
<dd><code>target</code> - a reference to a callback instance that will be notified when the scene has
|
||||
been resolved (which may be immediately if the scene is already active).</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="moveTo-com.threerings.presents.data.ClientObject-int-int-com.threerings.whirled.client.SceneService.SceneMoveListener-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>moveTo</h4>
|
||||
<pre>public void moveTo(com.threerings.presents.data.ClientObject caller,
|
||||
int sceneId,
|
||||
int sceneVer,
|
||||
<A HREF="../../../../com/threerings/whirled/client/SceneService.SceneMoveListener.html" title="interface in com.threerings.whirled.client">SceneService.SceneMoveListener</A> listener)</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/threerings/whirled/server/SceneProvider.html#moveTo(com.threerings.presents.data.ClientObject, int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)">SceneProvider</A></CODE></B></DD>
|
||||
<DD>Handles 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.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/threerings/whirled/server/SceneProvider.html#moveTo(com.threerings.presents.data.ClientObject, int, int, com.threerings.whirled.client.SceneService.SceneMoveListener)">moveTo</A></CODE> in interface <CODE><A HREF="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server">SceneProvider</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="moveBody(com.threerings.crowd.data.BodyObject, int)"><!-- --></A><H3>
|
||||
moveBody</H3>
|
||||
<PRE>
|
||||
public void <B>moveBody</B>(com.threerings.crowd.data.BodyObject source,
|
||||
int sceneId)</PRE>
|
||||
<DL>
|
||||
<DD>Ejects the specified body from their current scene and sends them a request to move to the
|
||||
specified new scene. This is the scene-equivalent to <CODE>LocationProvider.moveTo(com.threerings.presents.data.ClientObject, int, com.threerings.crowd.client.LocationService.MoveListener)</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="leaveOccupiedScene(com.threerings.crowd.data.BodyObject)"><!-- --></A><H3>
|
||||
leaveOccupiedScene</H3>
|
||||
<PRE>
|
||||
public void <B>leaveOccupiedScene</B>(com.threerings.crowd.data.BodyObject source)</PRE>
|
||||
<DL>
|
||||
<DD>Ejects the specified body from their current scene and zone. This is the zone equivalent to
|
||||
<CODE>LocationProvider.leavePlace(com.threerings.presents.data.ClientObject)</CODE>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<a href="../../../../com/threerings/whirled/client/SceneService.SceneMoveListener.html" title="interface in com.threerings.whirled.client">SceneService.SceneMoveListener</a> listener)</pre>
|
||||
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/threerings/whirled/server/SceneProvider.html#moveTo-com.threerings.presents.data.ClientObject-int-int-com.threerings.whirled.client.SceneService.SceneMoveListener-">SceneProvider</a></code></span></div>
|
||||
<div class="block">Handles 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>
|
||||
<dl>
|
||||
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||||
<dd><code><a href="../../../../com/threerings/whirled/server/SceneProvider.html#moveTo-com.threerings.presents.data.ClientObject-int-int-com.threerings.whirled.client.SceneService.SceneMoveListener-">moveTo</a></code> in interface <code><a href="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server">SceneProvider</a></code></dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="moveBody-com.threerings.crowd.data.BodyObject-int-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<h4>moveBody</h4>
|
||||
<pre>public void moveBody(com.threerings.crowd.data.BodyObject source,
|
||||
int sceneId)</pre>
|
||||
<div class="block">Ejects the specified body from their current scene and sends them a request to move to the
|
||||
specified new scene. This is the scene-equivalent to <code>LocationProvider.moveTo(com.threerings.presents.data.ClientObject, int, com.threerings.crowd.client.LocationService.MoveListener)</code>.</div>
|
||||
</li>
|
||||
</ul>
|
||||
<a name="leaveOccupiedScene-com.threerings.crowd.data.BodyObject-">
|
||||
<!-- -->
|
||||
</a>
|
||||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>leaveOccupiedScene</h4>
|
||||
<pre>public void leaveOccupiedScene(com.threerings.crowd.data.BodyObject source)</pre>
|
||||
<div class="block">Ejects the specified body from their current scene and zone. This is the zone equivalent to
|
||||
<code>LocationProvider.leavePlace(com.threerings.presents.data.ClientObject)</code>.</div>
|
||||
</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> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SceneRegistry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../com/threerings/whirled/server/SceneProvider.html" title="interface in com.threerings.whirled.server"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../com/threerings/whirled/server/SceneRegistry.ConfigFactory.html" title="interface in com.threerings.whirled.server"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../index.html?com/threerings/whirled/server/SceneRegistry.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="SceneRegistry.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<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/SceneRegistry.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/server/SceneProvider.html" title="interface in com.threerings.whirled.server"><span class="typeNameLink">Prev Class</span></a></li>
|
||||
<li><a href="../../../../com/threerings/whirled/server/SceneRegistry.ConfigFactory.html" title="interface in com.threerings.whirled.server"><span class="typeNameLink">Next Class</span></a></li>
|
||||
</ul>
|
||||
<ul class="navList">
|
||||
<li><a href="../../../../index.html?com/threerings/whirled/server/SceneRegistry.html" target="_top">Frames</a></li>
|
||||
<li><a href="SceneRegistry.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) {
|
||||
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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
</script>
|
||||
</div>
|
||||
<div>
|
||||
<ul class="subNavList">
|
||||
<li>Summary: </li>
|
||||
<li><a href="#nested.class.summary">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 ======= -->
|
||||
|
||||
<HR>
|
||||
Copyright © 2011. All Rights Reserved.
|
||||
</BODY>
|
||||
</HTML>
|
||||
<p class="legalCopy"><small>Copyright © 2015. All rights reserved.</small></p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user