com.eoi.freya.turn
Class BasePhase

java.lang.Object
  |
  +--com.eoi.freya.game.XMLObject
        |
        +--com.eoi.freya.turn.BasePhase
All Implemented Interfaces:
Phase
Direct Known Subclasses:
BasicPhase, EndOfTurn, RemoveModifiers, ShowPlayersNames

public abstract class BasePhase
extends XMLObject
implements Phase

BasePhase can be used as basis for more complex phase classes. The main method for phases is the execute method. This class gains access to the current players commands via the setPlayerCommand method, which is called by the Turn class for each Phase


Field Summary
protected  Player player
           
protected  PlayerCommands playerCommands
           
protected  boolean repeat
           
 
Fields inherited from class com.eoi.freya.game.XMLObject
info
 
Constructor Summary
BasePhase()
           
 
Method Summary
abstract  void execute()
           
 java.util.List getCommands(java.lang.String command)
           
 Player getPlayer()
           
 PlayerCommands getPlayerCommands()
           
 PlayerDocument getPlayerDocument()
           
 PlayerDocument getPlayerDocument(java.lang.String name)
           
 java.lang.String getPlayerName()
           
 boolean repeatForAllPlayers()
           
 void setPlayer(Player player)
           
 void setPlayerCommands(PlayerCommands playerCommands)
           
 
Methods inherited from class com.eoi.freya.game.XMLObject
addElement, getElement, getInfo, getIntSetting, getIterator, getName, getSetting, isSetting, setBooleanSetting, setInfo, setIntSetting, setName, setSetting
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.eoi.freya.turn.Phase
getInfo, getName, setInfo, setName
 

Field Detail

playerCommands

protected PlayerCommands playerCommands

player

protected Player player

repeat

protected boolean repeat
Constructor Detail

BasePhase

public BasePhase()
Method Detail

setPlayerCommands

public void setPlayerCommands(PlayerCommands playerCommands)
Specified by:
setPlayerCommands in interface Phase

getPlayerCommands

public PlayerCommands getPlayerCommands()

getPlayerDocument

public PlayerDocument getPlayerDocument(java.lang.String name)

getPlayerDocument

public PlayerDocument getPlayerDocument()

getCommands

public java.util.List getCommands(java.lang.String command)

getPlayerName

public java.lang.String getPlayerName()

getPlayer

public Player getPlayer()
Specified by:
getPlayer in interface Phase

setPlayer

public void setPlayer(Player player)
Specified by:
setPlayer in interface Phase

repeatForAllPlayers

public boolean repeatForAllPlayers()
Specified by:
repeatForAllPlayers in interface Phase

execute

public abstract void execute()
Specified by:
execute in interface Phase


Freya Engine, The Turn Based Game Engine
Copyright(c) 2002 Alexander Bilton
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA