API docs for 1.3 release.
This commit is contained in:
Michael Bayne
@@ -0,0 +1,327 @@
|
||||
<!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>
|
||||
ZoneManager (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="ZoneManager (vilya 1.3 API)";
|
||||
}
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ========= 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/ZoneManager.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">
|
||||
PREV CLASS
|
||||
<A HREF="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html?com/threerings/whirled/zone/server/ZoneManager.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ZoneManager.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
com.threerings.whirled.zone.server</FONT>
|
||||
<BR>
|
||||
Interface ZoneManager</H2>
|
||||
<DL>
|
||||
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../com/threerings/whirled/zone/peer/server/PeeredZoneManager.html" title="interface in com.threerings.whirled.zone.peer.server">PeeredZoneManager</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>ZoneManager</B></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
A zone is a collection of scenes organized into a connected group. A
|
||||
user can wander around within a zone, moving from scene to scene via
|
||||
the standard mechanisms. To move between zones, they must use a special
|
||||
mechanism (like at the dock, they can move from an island zone into
|
||||
their ship zone; or they can move from an island zone into their house
|
||||
zone). A zone provides scene summary information that can be used to
|
||||
display a map of the zone to the client.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== 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/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server">ZoneManager.ResolutionListener</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
Used to notify requesters when an asynchronous zone load has
|
||||
completed (successfully or not).</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== 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> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/zone/server/ZoneManager.html#bodyDidEnterZone(com.threerings.crowd.data.BodyObject, int)">bodyDidEnterZone</A></B>(com.threerings.crowd.data.BodyObject body,
|
||||
int zoneId)</CODE>
|
||||
|
||||
<BR>
|
||||
Called when a body has been granted access to a zone.</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/zone/server/ZoneManager.html#ratifyBodyEntry(com.threerings.crowd.data.BodyObject, int)">ratifyBodyEntry</A></B>(com.threerings.crowd.data.BodyObject body,
|
||||
int zoneId)</CODE>
|
||||
|
||||
<BR>
|
||||
Called when a body has requested to enter a zone.</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/zone/server/ZoneManager.html#ratifyBodyExit(com.threerings.crowd.data.BodyObject)">ratifyBodyExit</A></B>(com.threerings.crowd.data.BodyObject body)</CODE>
|
||||
|
||||
<BR>
|
||||
Called when a body has requested to leave a 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/zone/server/ZoneManager.html#resolveZone(int, com.threerings.whirled.zone.server.ZoneManager.ResolutionListener)">resolveZone</A></B>(int zoneId,
|
||||
<A HREF="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server">ZoneManager.ResolutionListener</A> listener)</CODE>
|
||||
|
||||
<BR>
|
||||
Resolves and delivers the scene summary information for the
|
||||
requested zone.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ 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="resolveZone(int, com.threerings.whirled.zone.server.ZoneManager.ResolutionListener)"><!-- --></A><H3>
|
||||
resolveZone</H3>
|
||||
<PRE>
|
||||
void <B>resolveZone</B>(int zoneId,
|
||||
<A HREF="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server">ZoneManager.ResolutionListener</A> listener)</PRE>
|
||||
<DL>
|
||||
<DD>Resolves and delivers the scene summary information for the
|
||||
requested zone. Zone resolution is an asynchronous process, which
|
||||
necessitates this callback-style interface.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>zoneId</CODE> - the qualified zone id of the zone to resolve.<DD><CODE>listener</CODE> - the listener that should be notified when the zone
|
||||
is successfully resolved or is known to have failed to resolve.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="ratifyBodyExit(com.threerings.crowd.data.BodyObject)"><!-- --></A><H3>
|
||||
ratifyBodyExit</H3>
|
||||
<PRE>
|
||||
<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>ratifyBodyExit</B>(com.threerings.crowd.data.BodyObject body)</PRE>
|
||||
<DL>
|
||||
<DD>Called when a body has requested to leave a zone. The zone manager
|
||||
may return null to indicate that the body is allowed to leave the
|
||||
current zone or a string error code indicating the reason for
|
||||
denial of access (which will be propagated back to the requesting
|
||||
client).
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>body</CODE> - the body object of the user that desires to depart
|
||||
their current zone (which can be obtained by casting the <CODE>BodyObject</CODE> to a <A HREF="../../../../../com/threerings/whirled/zone/data/ZonedBodyObject.html" title="interface in com.threerings.whirled.zone.data"><CODE>ZonedBodyObject</CODE></A>).</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="ratifyBodyEntry(com.threerings.crowd.data.BodyObject, int)"><!-- --></A><H3>
|
||||
ratifyBodyEntry</H3>
|
||||
<PRE>
|
||||
<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>ratifyBodyEntry</B>(com.threerings.crowd.data.BodyObject body,
|
||||
int zoneId)</PRE>
|
||||
<DL>
|
||||
<DD>Called when a body has requested to enter a zone. The zone manager
|
||||
may return null to indicate that the body is allowed access to the
|
||||
zone or a string error code indicating the reason for denial of
|
||||
access (which will be propagated back to the requesting client).
|
||||
This method is called <em>after</em> the zone is resolved so that
|
||||
the zone manager may complete the ratification process without
|
||||
blocking (which it must do).
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>body</CODE> - the body object of the user that desires access to the
|
||||
specified zone.<DD><CODE>zoneId</CODE> - the id of the zone to which the user desires access.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="bodyDidEnterZone(com.threerings.crowd.data.BodyObject, int)"><!-- --></A><H3>
|
||||
bodyDidEnterZone</H3>
|
||||
<PRE>
|
||||
void <B>bodyDidEnterZone</B>(com.threerings.crowd.data.BodyObject body,
|
||||
int zoneId)</PRE>
|
||||
<DL>
|
||||
<DD>Called when a body has been granted access to a zone. This method
|
||||
must not block.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>body</CODE> - the body object of the user that was just granted
|
||||
access to a zone.<DD><CODE>zoneId</CODE> - the id of the zone to which they were granted access.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= 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/ZoneManager.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">
|
||||
PREV CLASS
|
||||
<A HREF="../../../../../com/threerings/whirled/zone/server/ZoneManager.ResolutionListener.html" title="interface in com.threerings.whirled.zone.server"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html?com/threerings/whirled/zone/server/ZoneManager.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="ZoneManager.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
Copyright © 2011. All Rights Reserved.
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user