games.strategy.triplea.ui.display
Interface ITripleaDisplay

All Superinterfaces:
IChannelSubscribor, IDisplay
All Known Implementing Classes:
DummyDisplay, TripleaDisplay

public interface ITripleaDisplay
extends IDisplay

Author:
Sean Bridges

Method Summary
 void battleEnd(GUID battleID, java.lang.String message)
          The given battle has eneded.
 void bombingResults(GUID battleID, int[] dice, int cost)
          Notification of the results of a bombing raid
 void casualtyNotification(GUID battleID, java.lang.String step, DiceRoll dice, PlayerID player, java.util.Collection<Unit> killed, java.util.Collection<Unit> damaged, java.util.Map<Unit,java.util.Collection<Unit>> dependents)
          Notify that the casuatlies occured
 void gotoBattleStep(GUID battleId, java.lang.String step)
           
 void listBattleSteps(GUID battleID, java.util.List<java.lang.String> steps)
           
 void notifyDice(GUID battleId, DiceRoll dice, java.lang.String stepName)
          Show dice for the given battle and step
 void notifyRetreat(GUID battleId, java.util.Collection<Unit> retreating)
           
 void notifyRetreat(java.lang.String shortMessage, java.lang.String message, java.lang.String step, PlayerID retreatingPlayer)
          Notify that the given player has retreated some or all of his units.
 void showBattle(GUID battleID, Territory location, java.lang.String battleTitle, java.util.Collection<Unit> attackingUnits, java.util.Collection<Unit> defendingUnits, java.util.Map<Unit,java.util.Collection<Unit>> dependentUnits, PlayerID attacker, PlayerID defender)
          Display info about the battle.
 
Methods inherited from interface games.strategy.engine.display.IDisplay
initialize, shutDown
 

Method Detail

showBattle

void showBattle(GUID battleID,
                Territory location,
                java.lang.String battleTitle,
                java.util.Collection<Unit> attackingUnits,
                java.util.Collection<Unit> defendingUnits,
                java.util.Map<Unit,java.util.Collection<Unit>> dependentUnits,
                PlayerID attacker,
                PlayerID defender)
Display info about the battle. This is the first message to be displayed in a battle

Parameters:
battleID - - a unique id for the battle
location - - where the battle occurs
battleTitle - - the title of the battle
attackingUnits - - attacking units
defendingUnits - - defending units
dependentUnits - - unit dependencies, maps Unit->Collection of units

listBattleSteps

void listBattleSteps(GUID battleID,
                     java.util.List<java.lang.String> steps)
Parameters:
battleID - - the battle we are listing steps for
currentStep - - the current step
steps - - a collection of strings denoting all steps in the battle

battleEnd

void battleEnd(GUID battleID,
               java.lang.String message)
The given battle has eneded.


casualtyNotification

void casualtyNotification(GUID battleID,
                          java.lang.String step,
                          DiceRoll dice,
                          PlayerID player,
                          java.util.Collection<Unit> killed,
                          java.util.Collection<Unit> damaged,
                          java.util.Map<Unit,java.util.Collection<Unit>> dependents)
Notify that the casuatlies occured


bombingResults

void bombingResults(GUID battleID,
                    int[] dice,
                    int cost)
Notification of the results of a bombing raid


notifyRetreat

void notifyRetreat(java.lang.String shortMessage,
                   java.lang.String message,
                   java.lang.String step,
                   PlayerID retreatingPlayer)
Notify that the given player has retreated some or all of his units.

Parameters:
shortMessage -
message -
step -

notifyRetreat

void notifyRetreat(GUID battleId,
                   java.util.Collection<Unit> retreating)

notifyDice

void notifyDice(GUID battleId,
                DiceRoll dice,
                java.lang.String stepName)
Show dice for the given battle and step

Parameters:
battleId -
dice -

gotoBattleStep

void gotoBattleStep(GUID battleId,
                    java.lang.String step)