AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ccf127a3bbec367664de38da118dbb6f2fd1d465
vilya/apidocs/com/threerings/whirled/spot/client/SpotSceneDirector.html
T
Michael Bayne ccf127a3bb API docs for 1.3 release.
2011-04-06 17:01:15 -07:00

675 lines
35 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>
<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>
SpotSceneDirector (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="SpotSceneDirector (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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpotSceneDirector.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneController.html" title="class in com.threerings.whirled.spot.client"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/threerings/whirled/spot/client/SpotSceneDirector.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SpotSceneDirector.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.spot.client</FONT>
<BR>
Class SpotSceneDirector</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 ">com.threerings.presents.client.BasicDirector
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.whirled.spot.client.SpotSceneDirector</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>com.threerings.crowd.chat.data.ChatCodes, com.threerings.crowd.data.LocationCodes, com.threerings.presents.client.SessionObserver, com.threerings.presents.data.InvocationCodes, com.threerings.presents.dobj.AttributeChangeListener, com.threerings.presents.dobj.ChangeListener, com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;, <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>
<HR>
<DL>
<DT><PRE>public class <B>SpotSceneDirector</B><DT>extends com.threerings.presents.client.BasicDirector<DT>implements <A HREF="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</A>, com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;, com.threerings.presents.dobj.AttributeChangeListener</DL>
</PRE>
<P>
Extends the standard scene director with facilities to move between locations within a scene.
<P>
<P>
<HR>
<P>
<!-- =========== 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>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.whirled.spot.data.SpotCodes"><!-- --></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.spot.data.<A HREF="../../../../../com/threerings/whirled/spot/data/SpotCodes.html" title="interface in com.threerings.whirled.spot.data">SpotCodes</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><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></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_com.threerings.crowd.chat.data.ChatCodes"><!-- --></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.chat.data.ChatCodes</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><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></TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;<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>
&nbsp;<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>
&nbsp;
<!-- ======== 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/spot/client/SpotSceneDirector.html#SpotSceneDirector(com.threerings.whirled.util.WhirledContext, com.threerings.crowd.client.LocationDirector, com.threerings.whirled.client.SceneDirector)">SpotSceneDirector</A></B>(<A HREF="../../../../../com/threerings/whirled/util/WhirledContext.html" title="interface in com.threerings.whirled.util">WhirledContext</A>&nbsp;ctx,
com.threerings.crowd.client.LocationDirector&nbsp;locdir,
<A HREF="../../../../../com/threerings/whirled/client/SceneDirector.html" title="class in com.threerings.whirled.client">SceneDirector</A>&nbsp;scdir)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new spot scene director with the specified context and which will cooperate with
the supplied scene director.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent)">attributeChanged</A></B>(com.threerings.presents.dobj.AttributeChangedEvent&nbsp;event)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#changeLocation(com.threerings.whirled.spot.data.Location, com.samskivert.util.ResultListener)">changeLocation</A></B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A>&nbsp;loc,
<A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</A>&lt;<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A>&gt;&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Issues a request to change our location within the scene to the specified location.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#clientDidLogoff(com.threerings.presents.client.Client)">clientDidLogoff</A></B>(com.threerings.presents.client.Client&nbsp;client)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#clientDidLogon(com.threerings.presents.client.Client)">clientDidLogon</A></B>(com.threerings.presents.client.Client&nbsp;client)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#clientObjectDidChange(com.threerings.presents.client.Client)">clientObjectDidChange</A></B>(com.threerings.presents.client.Client&nbsp;client)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#getIntendedLocation()">getIntendedLocation</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns our current location unless we have a location change pending, in which case our
pending location is returned.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#joinCluster(int, com.samskivert.util.ResultListener)">joinCluster</A></B>(int&nbsp;froid,
<A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</A>&gt;&nbsp;listener)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Issues a request to join the cluster associated with the specified user (starting one if
necessary).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#objectAvailable(com.threerings.presents.dobj.DObject)">objectAvailable</A></B>(com.threerings.presents.dobj.DObject&nbsp;object)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#requestClusterSpeak(java.lang.String)">requestClusterSpeak</A></B>(<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>&nbsp;message)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#requestClusterSpeak(java.lang.String, byte)">requestClusterSpeak</A></B>(<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>&nbsp;message,
byte&nbsp;mode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#requestFailed(int, com.threerings.presents.dobj.ObjectAccessException)">requestFailed</A></B>(int&nbsp;oid,
com.threerings.presents.dobj.ObjectAccessException&nbsp;cause)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#setChatDirector(com.threerings.crowd.chat.client.ChatDirector)">setChatDirector</A></B>(com.threerings.crowd.chat.client.ChatDirector&nbsp;chatdir)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configures this spot scene director with a chat director, with which it will coordinate to
implement cluster chatting.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#traversePortal(int)">traversePortal</A></B>(int&nbsp;portalId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that this client move to the location specified by the supplied portal id.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneDirector.html#traversePortal(int, com.samskivert.util.ResultListener)">traversePortal</A></B>(int&nbsp;portalId,
<A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</A>&lt;com.threerings.crowd.data.PlaceConfig&gt;&nbsp;rl)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requests that this client move to the location specified by the supplied portal id.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.threerings.presents.client.BasicDirector"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.threerings.presents.client.BasicDirector</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clientWillLogon, isAvailableInStandalone, setAvailableInStandalone</CODE></TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;
<P>
<!-- ========= 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="SpotSceneDirector(com.threerings.whirled.util.WhirledContext, com.threerings.crowd.client.LocationDirector, com.threerings.whirled.client.SceneDirector)"><!-- --></A><H3>
SpotSceneDirector</H3>
<PRE>
public <B>SpotSceneDirector</B>(<A HREF="../../../../../com/threerings/whirled/util/WhirledContext.html" title="interface in com.threerings.whirled.util">WhirledContext</A>&nbsp;ctx,
com.threerings.crowd.client.LocationDirector&nbsp;locdir,
<A HREF="../../../../../com/threerings/whirled/client/SceneDirector.html" title="class in com.threerings.whirled.client">SceneDirector</A>&nbsp;scdir)</PRE>
<DL>
<DD>Creates a new spot scene director with the specified context and which will cooperate with
the supplied scene director.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>ctx</CODE> - the active client context.<DD><CODE>locdir</CODE> - the location director with which we will be cooperating.<DD><CODE>scdir</CODE> - the scene director with which we will be cooperating.</DL>
</DL>
<!-- ============ 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="setChatDirector(com.threerings.crowd.chat.client.ChatDirector)"><!-- --></A><H3>
setChatDirector</H3>
<PRE>
public void <B>setChatDirector</B>(com.threerings.crowd.chat.client.ChatDirector&nbsp;chatdir)</PRE>
<DL>
<DD>Configures this spot scene director with a chat director, with which it will coordinate to
implement cluster chatting.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getIntendedLocation()"><!-- --></A><H3>
getIntendedLocation</H3>
<PRE>
public <A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A> <B>getIntendedLocation</B>()</PRE>
<DL>
<DD>Returns our current location unless we have a location change pending, in which case our
pending location is returned.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="traversePortal(int)"><!-- --></A><H3>
traversePortal</H3>
<PRE>
public boolean <B>traversePortal</B>(int&nbsp;portalId)</PRE>
<DL>
<DD>Requests that this client move to the location specified by the supplied portal id. A
request will be made and when the response is received, the location observers will be
notified of success or failure.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the request was issued, false if it was rejected by a location observer or
because we have another request outstanding.</DL>
</DD>
</DL>
<HR>
<A NAME="traversePortal(int, com.samskivert.util.ResultListener)"><!-- --></A><H3>
traversePortal</H3>
<PRE>
public boolean <B>traversePortal</B>(int&nbsp;portalId,
<A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</A>&lt;com.threerings.crowd.data.PlaceConfig&gt;&nbsp;rl)</PRE>
<DL>
<DD>Requests that this client move to the location specified by the supplied portal id. A
request will be made and when the response is received, the location observers will be
notified of success or failure.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="changeLocation(com.threerings.whirled.spot.data.Location, com.samskivert.util.ResultListener)"><!-- --></A><H3>
changeLocation</H3>
<PRE>
public void <B>changeLocation</B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A>&nbsp;loc,
<A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</A>&lt;<A HREF="../../../../../com/threerings/whirled/spot/data/Location.html" title="interface in com.threerings.whirled.spot.data">Location</A>&gt;&nbsp;listener)</PRE>
<DL>
<DD>Issues a request to change our location within the scene to the specified location.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>loc</CODE> - the new location to which to move.<DD><CODE>listener</CODE> - will be notified of success or failure. Most client entities find out about
location changes via changes to the occupant info data, but the initiator of a location
change request can be notified of its success or failure, primarily so that it can act in
anticipation of a successful location change (like by starting a sprite moving toward the
new location), but backtrack if it finds out that the location change failed.</DL>
</DD>
</DL>
<HR>
<A NAME="joinCluster(int, com.samskivert.util.ResultListener)"><!-- --></A><H3>
joinCluster</H3>
<PRE>
public void <B>joinCluster</B>(int&nbsp;froid,
<A HREF="http://samskivert.googlecode.com/svn/apidocs/com/samskivert/util/ResultListener.html?is-external=true" title="class or interface in com.samskivert.util">ResultListener</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</A>&gt;&nbsp;listener)</PRE>
<DL>
<DD>Issues a request to join the cluster associated with the specified user (starting one if
necessary).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>froid</CODE> - the bodyOid of another user; the calling user will be made to join the target
user's cluster.<DD><CODE>listener</CODE> - will be notified of success or failure.</DL>
</DD>
</DL>
<HR>
<A NAME="requestClusterSpeak(java.lang.String)"><!-- --></A><H3>
requestClusterSpeak</H3>
<PRE>
public boolean <B>requestClusterSpeak</B>(<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>&nbsp;message)</PRE>
<DL>
<DD>Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if a cluster speak message was delivered, false if we are not in a valid
cluster and refused to deliver the request.</DL>
</DD>
</DL>
<HR>
<A NAME="requestClusterSpeak(java.lang.String, byte)"><!-- --></A><H3>
requestClusterSpeak</H3>
<PRE>
public boolean <B>requestClusterSpeak</B>(<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>&nbsp;message,
byte&nbsp;mode)</PRE>
<DL>
<DD>Sends a chat message to the other users in the cluster to which the location that we
currently occupy belongs.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if a cluster speak message was delivered, false if we are not in a valid
cluster and refused to deliver the request.</DL>
</DD>
</DL>
<HR>
<A NAME="objectAvailable(com.threerings.presents.dobj.DObject)"><!-- --></A><H3>
objectAvailable</H3>
<PRE>
public void <B>objectAvailable</B>(com.threerings.presents.dobj.DObject&nbsp;object)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>objectAvailable</CODE> in interface <CODE>com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="requestFailed(int, com.threerings.presents.dobj.ObjectAccessException)"><!-- --></A><H3>
requestFailed</H3>
<PRE>
public void <B>requestFailed</B>(int&nbsp;oid,
com.threerings.presents.dobj.ObjectAccessException&nbsp;cause)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>requestFailed</CODE> in interface <CODE>com.threerings.presents.dobj.Subscriber&lt;com.threerings.presents.dobj.DObject&gt;</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="attributeChanged(com.threerings.presents.dobj.AttributeChangedEvent)"><!-- --></A><H3>
attributeChanged</H3>
<PRE>
public void <B>attributeChanged</B>(com.threerings.presents.dobj.AttributeChangedEvent&nbsp;event)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>attributeChanged</CODE> in interface <CODE>com.threerings.presents.dobj.AttributeChangeListener</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="clientDidLogon(com.threerings.presents.client.Client)"><!-- --></A><H3>
clientDidLogon</H3>
<PRE>
public void <B>clientDidLogon</B>(com.threerings.presents.client.Client&nbsp;client)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>clientDidLogon</CODE> in interface <CODE>com.threerings.presents.client.SessionObserver</CODE><DT><B>Overrides:</B><DD><CODE>clientDidLogon</CODE> in class <CODE>com.threerings.presents.client.BasicDirector</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="clientObjectDidChange(com.threerings.presents.client.Client)"><!-- --></A><H3>
clientObjectDidChange</H3>
<PRE>
public void <B>clientObjectDidChange</B>(com.threerings.presents.client.Client&nbsp;client)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>clientObjectDidChange</CODE> in interface <CODE>com.threerings.presents.client.SessionObserver</CODE><DT><B>Overrides:</B><DD><CODE>clientObjectDidChange</CODE> in class <CODE>com.threerings.presents.client.BasicDirector</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="clientDidLogoff(com.threerings.presents.client.Client)"><!-- --></A><H3>
clientDidLogoff</H3>
<PRE>
public void <B>clientDidLogoff</B>(com.threerings.presents.client.Client&nbsp;client)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>clientDidLogoff</CODE> in interface <CODE>com.threerings.presents.client.SessionObserver</CODE><DT><B>Overrides:</B><DD><CODE>clientDidLogoff</CODE> in class <CODE>com.threerings.presents.client.BasicDirector</CODE></DL>
</DD>
<DD><DL>
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpotSceneDirector.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotSceneController.html" title="class in com.threerings.whirled.spot.client"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/threerings/whirled/spot/client/SpotService.html" title="interface in com.threerings.whirled.spot.client"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/threerings/whirled/spot/client/SpotSceneDirector.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SpotSceneDirector.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2011. All Rights Reserved.
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink