dip.gui.order
Class GUIOrder.StateInfo

java.lang.Object
  extended bydip.gui.order.GUIOrder.StateInfo
Enclosing class:
GUIOrder

public static class GUIOrder.StateInfo
extends java.lang.Object

StateInfo is the object which is passed to GUIOrder subclasses that contains various information about the current game state.

This information is 'relatively constant' in that it does not typically change until the TurnState changes (or validation options change).


Constructor Summary
GUIOrder.StateInfo()
           
 
Method Summary
 boolean canIssueOrder(Power power)
          Determines if the player can issue orders for this power
 Adjustment.AdjustmentInfoMap getAdjustmenInfoMap()
           
 Phase getPhase()
          Convenience method to get Phase from TurnState
 Position getPosition()
          Convenience method to get Position from TurnState
 RetreatChecker getRetreatChecker()
          Gets a RetreatChecker object (that can be shared between orders)
 RuleOptions getRuleOptions()
           
 TurnState getTurnState()
           
 ValidationOptions getValidationOptions()
           
 void setAdjustmenInfoMap(Adjustment.AdjustmentInfoMap adjMap)
           
 void setClientFrame(ClientFrame cf)
           
 void setRuleOptions(RuleOptions ruleOpts)
           
 void setTurnState(TurnState turnState)
           
 void setValidationOptions(ValidationOptions valOpts)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GUIOrder.StateInfo

public GUIOrder.StateInfo()
Method Detail

setTurnState

public void setTurnState(TurnState turnState)

setAdjustmenInfoMap

public void setAdjustmenInfoMap(Adjustment.AdjustmentInfoMap adjMap)

setRuleOptions

public void setRuleOptions(RuleOptions ruleOpts)

setValidationOptions

public void setValidationOptions(ValidationOptions valOpts)

setClientFrame

public void setClientFrame(ClientFrame cf)

getTurnState

public TurnState getTurnState()

getAdjustmenInfoMap

public Adjustment.AdjustmentInfoMap getAdjustmenInfoMap()

getRuleOptions

public RuleOptions getRuleOptions()

getValidationOptions

public ValidationOptions getValidationOptions()

canIssueOrder

public boolean canIssueOrder(Power power)
Determines if the player can issue orders for this power


getPosition

public Position getPosition()
Convenience method to get Position from TurnState


getPhase

public Phase getPhase()
Convenience method to get Phase from TurnState


getRetreatChecker

public RetreatChecker getRetreatChecker()
Gets a RetreatChecker object (that can be shared between orders)



Copyright 2002-2004 Zachary DelProposto / jDip Development Team. All Rights Reserved.