API docs for 1.3 release.
This commit is contained in:
Michael Bayne
@@ -0,0 +1,487 @@
|
||||
<!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:10 PDT 2011 -->
|
||||
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<TITLE>
|
||||
TurnGameManagerDelegate (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="TurnGameManagerDelegate (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/TurnGameManagerDelegate.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/parlor/turn/server/TurnGameManager.html" title="interface in com.threerings.parlor.turn.server"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html?com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TurnGameManagerDelegate.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: NESTED | 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>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
com.threerings.parlor.turn.server</FONT>
|
||||
<BR>
|
||||
Class TurnGameManagerDelegate</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.crowd.server.PlaceManagerDelegate
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html" title="class in com.threerings.parlor.server">com.threerings.parlor.server.PlayManagerDelegate</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html" title="class in com.threerings.parlor.game.server">com.threerings.parlor.game.server.GameManagerDelegate</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.parlor.turn.server.TurnGameManagerDelegate</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/threerings/parlor/card/trick/server/TrickCardGameManagerDelegate.html" title="class in com.threerings.parlor.card.trick.server">TrickCardGameManagerDelegate</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>TurnGameManagerDelegate</B><DT>extends <A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html" title="class in com.threerings.parlor.game.server">GameManagerDelegate</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
Performs the server-side turn-based game processing for a turn based game. Game managers which
|
||||
wish to make use of the turn services must implement <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html" title="interface in com.threerings.parlor.turn.server"><CODE>TurnGameManager</CODE></A> and either create
|
||||
an instance of this class, or an instance of a derivation which customizes the behavior, either
|
||||
of which would be passed to <CODE>PlaceManager.addDelegate(com.threerings.crowd.server.PlaceManagerDelegate)</CODE> to be activated.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ======== 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/parlor/turn/server/TurnGameManagerDelegate.html#TurnGameManagerDelegate()">TurnGameManagerDelegate</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#TurnGameManagerDelegate(com.threerings.parlor.turn.server.TurnGameManager)">TurnGameManagerDelegate</A></B>(<A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html" title="interface in com.threerings.parlor.turn.server">TurnGameManager</A> tgmgr)</CODE>
|
||||
|
||||
<BR>
|
||||
<B>Deprecated.</B> <I>use the zero-argument constructor.</I></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/parlor/turn/server/TurnGameManagerDelegate.html#didInit(com.threerings.crowd.data.PlaceConfig)">didInit</A></B>(com.threerings.crowd.data.PlaceConfig config)</CODE>
|
||||
|
||||
<BR>
|
||||
</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/parlor/turn/server/TurnGameManagerDelegate.html#didStartup(com.threerings.crowd.data.PlaceObject)">didStartup</A></B>(com.threerings.crowd.data.PlaceObject plobj)</CODE>
|
||||
|
||||
<BR>
|
||||
</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/parlor/turn/server/TurnGameManagerDelegate.html#endTurn()">endTurn</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Called to end the turn.</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/parlor/turn/server/TurnGameManagerDelegate.html#gameDidStart()">gameDidStart</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
This should be called from <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html#gameDidStart()"><CODE>GameManager.gameDidStart()</CODE></A> to let the turn delegate perform
|
||||
start of game processing.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#getTurnHolderIndex()">getTurnHolderIndex</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the index of the current turn holder as configured in the game object.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#isPlayersTurn(int)">isPlayersTurn</A></B>(int playerIndex)</CODE>
|
||||
|
||||
<BR>
|
||||
Test if it's the inputted player's turn.</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/parlor/turn/server/TurnGameManagerDelegate.html#playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name)">playerWasReplaced</A></B>(int pidx,
|
||||
com.threerings.util.Name oplayer,
|
||||
com.threerings.util.Name nplayer)</CODE>
|
||||
|
||||
<BR>
|
||||
Called when a player in the game has been replaced by a call to <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html#replacePlayer(int, com.threerings.util.Name)"><CODE>GameManager.replacePlayer(int, com.threerings.util.Name)</CODE></A>.</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/parlor/turn/server/TurnGameManagerDelegate.html#startTurn()">startTurn</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Called to start the next turn.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_com.threerings.parlor.game.server.GameManagerDelegate"><!-- --></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.parlor.game.server.<A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html" title="class in com.threerings.parlor.game.server">GameManagerDelegate</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#gameDidEnd()">gameDidEnd</A>, <A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#gameWillEnd()">gameWillEnd</A>, <A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#gameWillReset()">gameWillReset</A>, <A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#gameWillStart()">gameWillStart</A>, <A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#setAI(int, com.threerings.parlor.game.data.GameAI)">setAI</A>, <A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#tickAI(int, com.threerings.parlor.game.data.GameAI)">tickAI</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_com.threerings.crowd.server.PlaceManagerDelegate"><!-- --></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.crowd.server.PlaceManagerDelegate</B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>bodyEntered, bodyLeft, bodyUpdated, didShutdown, init, placeBecameEmpty, where</CODE></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>
|
||||
|
||||
<!-- ========= 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="TurnGameManagerDelegate()"><!-- --></A><H3>
|
||||
TurnGameManagerDelegate</H3>
|
||||
<PRE>
|
||||
public <B>TurnGameManagerDelegate</B>()</PRE>
|
||||
<DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="TurnGameManagerDelegate(com.threerings.parlor.turn.server.TurnGameManager)"><!-- --></A><H3>
|
||||
TurnGameManagerDelegate</H3>
|
||||
<PRE>
|
||||
<FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
|
||||
</FONT>public <B>TurnGameManagerDelegate</B>(<A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html" title="interface in com.threerings.parlor.turn.server">TurnGameManager</A> tgmgr)</PRE>
|
||||
<DL>
|
||||
<DD><B>Deprecated.</B> <I>use the zero-argument constructor.</I>
|
||||
<P>
|
||||
</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="getTurnHolderIndex()"><!-- --></A><H3>
|
||||
getTurnHolderIndex</H3>
|
||||
<PRE>
|
||||
public int <B>getTurnHolderIndex</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the index of the current turn holder as configured in the game object.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the index into the players array of the current turn holder or <code>-1</code> if
|
||||
there is no current turn holder.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="isPlayersTurn(int)"><!-- --></A><H3>
|
||||
isPlayersTurn</H3>
|
||||
<PRE>
|
||||
public boolean <B>isPlayersTurn</B>(int playerIndex)</PRE>
|
||||
<DL>
|
||||
<DD>Test if it's the inputted player's turn.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="startTurn()"><!-- --></A><H3>
|
||||
startTurn</H3>
|
||||
<PRE>
|
||||
public void <B>startTurn</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Called to start the next turn. It calls <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#turnWillStart()"><CODE>TurnGameManager.turnWillStart()</CODE></A> to allow our
|
||||
owning manager to perform any pre-start turn processing, sets the turn holder that was
|
||||
configured either when the game started or when finishing up the last turn, and then calls
|
||||
<A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#turnDidStart()"><CODE>TurnGameManager.turnDidStart()</CODE></A> to allow the manager to perform any post-start turn
|
||||
processing. This assumes that a valid turn holder has been assigned. If some pre-game
|
||||
preparation needs to take place in a non-turn-based manner, this function should not be
|
||||
called until it is time to start the first turn.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="endTurn()"><!-- --></A><H3>
|
||||
endTurn</H3>
|
||||
<PRE>
|
||||
public void <B>endTurn</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Called to end the turn. Whatever indication a game manager has that the turn has ended
|
||||
(probably the submission of a valid move of some sort by the turn holding player), it
|
||||
should call this function to cause this turn to end and the next to begin.
|
||||
|
||||
<p>
|
||||
If the game is no longer in play (see <A HREF="../../../../../com/threerings/parlor/turn/data/TurnGameObject.html#isInPlay()"><CODE>TurnGameObject.isInPlay()</CODE></A>) after having called
|
||||
<A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#turnDidEnd()"><CODE>TurnGameManager.turnDidEnd()</CODE></A> and <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#setNextTurnHolder()"><CODE>setNextTurnHolder()</CODE></A>, then the next turn will
|
||||
not automatically be started.
|
||||
|
||||
<p>
|
||||
If the game is in play, but the next turn should not be started immediately, the game
|
||||
manager should have <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#setNextTurnHolder()"><CODE>setNextTurnHolder()</CODE></A> set the <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#_turnIdx"><CODE>_turnIdx</CODE></A> field to
|
||||
<code>-1</code> which will cause us to not start the next turn. To start things back up
|
||||
again it would set <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#_turnIdx"><CODE>_turnIdx</CODE></A> to the next turn holder and call <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html#startTurn()"><CODE>startTurn()</CODE></A>
|
||||
itself.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="didInit(com.threerings.crowd.data.PlaceConfig)"><!-- --></A><H3>
|
||||
didInit</H3>
|
||||
<PRE>
|
||||
public void <B>didInit</B>(com.threerings.crowd.data.PlaceConfig config)</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html#didInit(com.threerings.crowd.data.PlaceConfig)">didInit</A></CODE> in class <CODE><A HREF="../../../../../com/threerings/parlor/server/PlayManagerDelegate.html" title="class in com.threerings.parlor.server">PlayManagerDelegate</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="didStartup(com.threerings.crowd.data.PlaceObject)"><!-- --></A><H3>
|
||||
didStartup</H3>
|
||||
<PRE>
|
||||
public void <B>didStartup</B>(com.threerings.crowd.data.PlaceObject plobj)</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE>didStartup</CODE> in class <CODE>com.threerings.crowd.server.PlaceManagerDelegate</CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name)"><!-- --></A><H3>
|
||||
playerWasReplaced</H3>
|
||||
<PRE>
|
||||
public void <B>playerWasReplaced</B>(int pidx,
|
||||
com.threerings.util.Name oplayer,
|
||||
com.threerings.util.Name nplayer)</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name)">GameManagerDelegate</A></CODE></B></DD>
|
||||
<DD>Called when a player in the game has been replaced by a call to <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html#replacePlayer(int, com.threerings.util.Name)"><CODE>GameManager.replacePlayer(int, com.threerings.util.Name)</CODE></A>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#playerWasReplaced(int, com.threerings.util.Name, com.threerings.util.Name)">playerWasReplaced</A></CODE> in class <CODE><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html" title="class in com.threerings.parlor.game.server">GameManagerDelegate</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="gameDidStart()"><!-- --></A><H3>
|
||||
gameDidStart</H3>
|
||||
<PRE>
|
||||
public void <B>gameDidStart</B>()</PRE>
|
||||
<DL>
|
||||
<DD>This should be called from <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html#gameDidStart()"><CODE>GameManager.gameDidStart()</CODE></A> to let the turn delegate perform
|
||||
start of game processing.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html#gameDidStart()">gameDidStart</A></CODE> in class <CODE><A HREF="../../../../../com/threerings/parlor/game/server/GameManagerDelegate.html" title="class in com.threerings.parlor.game.server">GameManagerDelegate</A></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> </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/TurnGameManagerDelegate.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/parlor/turn/server/TurnGameManager.html" title="interface in com.threerings.parlor.turn.server"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html?com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="TurnGameManagerDelegate.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: NESTED | 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>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
Copyright © 2011. All Rights Reserved.
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user