Michael Bayne
372 lines
14 KiB
HTML
372 lines
14 KiB
HTML
<!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>
|
|
TurnGameManager (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="TurnGameManager (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/TurnGameManager.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/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../index.html?com/threerings/parlor/turn/server/TurnGameManager.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="TurnGameManager.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 | 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.parlor.turn.server</FONT>
|
|
<BR>
|
|
Interface TurnGameManager</H2>
|
|
<DL>
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/threerings/parlor/card/server/CardGameManager.html" title="class in com.threerings.parlor.card.server">CardGameManager</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>TurnGameManager</B></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
A game manager that wishes to make use of the turn game services should
|
|
implement this interface and create a <A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server"><CODE>TurnGameManagerDelegate</CODE></A>
|
|
which will perform the basic turn game processing and call back to the
|
|
main manager via this interface.
|
|
|
|
<p> The basic flow of a turn-based game is as follows:
|
|
<pre>
|
|
GameManager.gameWillStart()
|
|
GameManager.gameDidStart()
|
|
TurnGameManagerDelegate.setFirstTurnHolder()
|
|
TurnGameManagerDelegate.startTurn()
|
|
TurnGameManager.turnWillStart()
|
|
TurnGameManagerDelegate.endTurn()
|
|
TurnGameManager.turnDidEnd()
|
|
TurnGameManagerDelegate.setNextTurnHolder()
|
|
TurnGameManagerDelegate.startTurn()
|
|
...
|
|
GameManager.endGame()
|
|
</pre>
|
|
<P>
|
|
|
|
<P>
|
|
<HR>
|
|
|
|
<P>
|
|
|
|
<!-- ========== 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> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#getPlayerCount()">getPlayerCount</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.</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/TurnGameManager.html#getPlayerIndex(com.threerings.util.Name)">getPlayerIndex</A></B>(com.threerings.util.Name username)</CODE>
|
|
|
|
<BR>
|
|
Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> com.threerings.util.Name</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../com/threerings/parlor/turn/server/TurnGameManager.html#getPlayerName(int)">getPlayerName</A></B>(int index)</CODE>
|
|
|
|
<BR>
|
|
Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.</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/TurnGameManager.html#isActivePlayer(int)">isActivePlayer</A></B>(int pidx)</CODE>
|
|
|
|
<BR>
|
|
Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.</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/TurnGameManager.html#turnDidEnd()">turnDidEnd</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Called when the turn was ended.</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/TurnGameManager.html#turnDidStart()">turnDidStart</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Called when we have started the next 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/TurnGameManager.html#turnWillStart()">turnWillStart</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Called when we are about to start the next turn.</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="getPlayerName(int)"><!-- --></A><H3>
|
|
getPlayerName</H3>
|
|
<PRE>
|
|
com.threerings.util.Name <B>getPlayerName</B>(int index)</PRE>
|
|
<DL>
|
|
<DD>Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPlayerIndex(com.threerings.util.Name)"><!-- --></A><H3>
|
|
getPlayerIndex</H3>
|
|
<PRE>
|
|
int <B>getPlayerIndex</B>(com.threerings.util.Name username)</PRE>
|
|
<DL>
|
|
<DD>Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPlayerCount()"><!-- --></A><H3>
|
|
getPlayerCount</H3>
|
|
<PRE>
|
|
int <B>getPlayerCount</B>()</PRE>
|
|
<DL>
|
|
<DD>Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isActivePlayer(int)"><!-- --></A><H3>
|
|
isActivePlayer</H3>
|
|
<PRE>
|
|
boolean <B>isActivePlayer</B>(int pidx)</PRE>
|
|
<DL>
|
|
<DD>Extending <A HREF="../../../../../com/threerings/parlor/game/server/GameManager.html" title="class in com.threerings.parlor.game.server"><CODE>GameManager</CODE></A> should automatically handle
|
|
implementing this method.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="turnWillStart()"><!-- --></A><H3>
|
|
turnWillStart</H3>
|
|
<PRE>
|
|
void <B>turnWillStart</B>()</PRE>
|
|
<DL>
|
|
<DD>Called when we are about to start the next turn. Implementations
|
|
can do whatever pre-start turn activities need to be done.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="turnDidStart()"><!-- --></A><H3>
|
|
turnDidStart</H3>
|
|
<PRE>
|
|
void <B>turnDidStart</B>()</PRE>
|
|
<DL>
|
|
<DD>Called when we have started the next turn. Implementations can do
|
|
whatever post-start turn activities need to be done.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="turnDidEnd()"><!-- --></A><H3>
|
|
turnDidEnd</H3>
|
|
<PRE>
|
|
void <B>turnDidEnd</B>()</PRE>
|
|
<DL>
|
|
<DD>Called when the turn was ended. Implementations can perform any
|
|
post-turn processing (like updating scores, etc.).
|
|
<P>
|
|
<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/TurnGameManager.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/parlor/turn/server/TurnGameManagerDelegate.html" title="class in com.threerings.parlor.turn.server"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../index.html?com/threerings/parlor/turn/server/TurnGameManager.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="TurnGameManager.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 | 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>
|