2011-05-10 16:59:40 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< HTML >
< HEAD >
2011-05-10 17:05:58 +02:00
<!-- Generated by javadoc (build 1.6.0_22) on Tue May 10 17:04:57 CEST 2011 -->
2011-05-10 16:59:40 +02:00
< TITLE >
IGameState
< / TITLE >
< META NAME = "date" CONTENT = "2011-05-10" >
< 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="IGameState";
}
}
< / 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/IGameState.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-files/index-1.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 = "../../jrummikub/model/Hand.html" title = "class in jrummikub.model" > < B > PREV CLASS< / B > < / A >
< A HREF = "../../jrummikub/model/IHand.html" title = "interface in jrummikub.model" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../index.html?jrummikub/model/IGameState.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "IGameState.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" >
jrummikub.model< / FONT >
< BR >
Interface IGameState< / H2 >
< DL >
< DT > < B > All Known Implementing Classes:< / B > < DD > < A HREF = "../../jrummikub/model/GameState.html" title = "class in jrummikub.model" > GameState< / A > < / DD >
< / DL >
< HR >
< DL >
< DT > < PRE > public interface < B > IGameState< / B > < / DL >
< / PRE >
< P >
Interface for < A HREF = "../../jrummikub/model/GameState.html" title = "class in jrummikub.model" > < CODE > GameState< / CODE > < / A > model
< 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 > < A HREF = "../../jrummikub/model/IPlayer.html" title = "interface in jrummikub.model" > IPlayer< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/IGameState.html#getActivePlayer()" > getActivePlayer< / A > < / B > ()< / CODE >
< BR >
Returns the currently active player< / TD >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > < A HREF = "../../jrummikub/model/StoneHeap.html" title = "class in jrummikub.model" > StoneHeap< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/IGameState.html#getGameHeap()" > getGameHeap< / A > < / B > ()< / CODE >
< BR >
Returns the heap of stones to draw from< / TD >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > < A HREF = "../../jrummikub/model/IPlayer.html" title = "interface in jrummikub.model" > IPlayer< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/IGameState.html#getNthNextPlayer(int)" > getNthNextPlayer< / A > < / B > (int i)< / CODE >
< BR >
Returns the player that would be the active player after i turns< / 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 = "../../jrummikub/model/IGameState.html#getPlayerCount()" > getPlayerCount< / A > < / B > ()< / CODE >
< BR >
Returns the number of players< / TD >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > < A HREF = "../../jrummikub/model/ITable.html" title = "interface in jrummikub.model" > ITable< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/IGameState.html#getTable()" > getTable< / A > < / B > ()< / CODE >
< BR >
Get the current < A HREF = "../../jrummikub/model/Table.html" title = "class in jrummikub.model" > < CODE > Table< / 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 = "../../jrummikub/model/IGameState.html#nextPlayer()" > nextPlayer< / A > < / B > ()< / CODE >
< BR >
Changes the activePlayer to the next < A HREF = "../../jrummikub/model/Player.html" title = "class in jrummikub.model" > < CODE > Player< / CODE > < / A > in the list< / 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 = "../../jrummikub/model/IGameState.html#setTable(jrummikub.model.ITable)" > setTable< / A > < / B > (< A HREF = "../../jrummikub/model/ITable.html" title = "interface in jrummikub.model" > ITable< / A > table)< / CODE >
< BR >
Sets the current < A HREF = "../../jrummikub/model/Table.html" title = "class in jrummikub.model" > < CODE > Table< / CODE > < / A > < / 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 = "getTable()" > <!-- --> < / A > < H3 >
getTable< / H3 >
< PRE >
< A HREF = "../../jrummikub/model/ITable.html" title = "interface in jrummikub.model" > ITable< / A > < B > getTable< / B > ()< / PRE >
< DL >
< DD > Get the current < A HREF = "../../jrummikub/model/Table.html" title = "class in jrummikub.model" > < CODE > Table< / CODE > < / A >
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > The current Table< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "setTable(jrummikub.model.ITable)" > <!-- --> < / A > < H3 >
setTable< / H3 >
< PRE >
void < B > setTable< / B > (< A HREF = "../../jrummikub/model/ITable.html" title = "interface in jrummikub.model" > ITable< / A > table)< / PRE >
< DL >
< DD > Sets the current < A HREF = "../../jrummikub/model/Table.html" title = "class in jrummikub.model" > < CODE > Table< / CODE > < / A >
< P >
< DD > < DL >
< DT > < B > Parameters:< / B > < DD > < CODE > table< / CODE > - The new Table< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "getPlayerCount()" > <!-- --> < / A > < H3 >
getPlayerCount< / H3 >
< PRE >
int < B > getPlayerCount< / B > ()< / PRE >
< DL >
< DD > Returns the number of players
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > number of players< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "nextPlayer()" > <!-- --> < / A > < H3 >
nextPlayer< / H3 >
< PRE >
void < B > nextPlayer< / B > ()< / PRE >
< DL >
< DD > Changes the activePlayer to the next < A HREF = "../../jrummikub/model/Player.html" title = "class in jrummikub.model" > < CODE > Player< / CODE > < / A > in the list
< P >
< DD > < DL >
< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "getActivePlayer()" > <!-- --> < / A > < H3 >
getActivePlayer< / H3 >
< PRE >
< A HREF = "../../jrummikub/model/IPlayer.html" title = "interface in jrummikub.model" > IPlayer< / A > < B > getActivePlayer< / B > ()< / PRE >
< DL >
< DD > Returns the currently active player
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > currently active player< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "getGameHeap()" > <!-- --> < / A > < H3 >
getGameHeap< / H3 >
< PRE >
< A HREF = "../../jrummikub/model/StoneHeap.html" title = "class in jrummikub.model" > StoneHeap< / A > < B > getGameHeap< / B > ()< / PRE >
< DL >
< DD > Returns the heap of stones to draw from
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > heap of stones< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "getNthNextPlayer(int)" > <!-- --> < / A > < H3 >
getNthNextPlayer< / H3 >
< PRE >
< A HREF = "../../jrummikub/model/IPlayer.html" title = "interface in jrummikub.model" > IPlayer< / A > < B > getNthNextPlayer< / B > (int i)< / PRE >
< DL >
< DD > Returns the player that would be the active player after i turns
< P >
< DD > < DL >
< DT > < B > Parameters:< / B > < DD > < CODE > i< / CODE > - number of turns
< DT > < B > Returns:< / B > < DD > player active after i turns< / 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/IGameState.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-files/index-1.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 = "../../jrummikub/model/Hand.html" title = "class in jrummikub.model" > < B > PREV CLASS< / B > < / A >
< A HREF = "../../jrummikub/model/IHand.html" title = "interface in jrummikub.model" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../index.html?jrummikub/model/IGameState.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "IGameState.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 >
< / BODY >
< / HTML >
