cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class GameInfoShared

Package class diagram package GameInfoShared
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.GameInfoShared
All Implemented Interfaces:
IWorldObject, ISharedWorldObject, Cloneable
Direct Known Subclasses:
GameInfoMessage.GameInfoSharedMessage, GameInfoSharedImpl

public abstract class GameInfoShared
extends InfoMessage
implements ISharedWorldObject

Abstract definition of the shared part of the GameBots2004 message NFO.

Complete message documentation: Asynchronous message. Sent as response to READY command. Information about the game. What type of game is it going to be, number of teams, maximum size of teams etc.


Field Summary
static cz.cuni.amis.utils.token.Token BotsPausedPropertyToken
           
static cz.cuni.amis.utils.token.Token FragLimitPropertyToken
           
static UnrealId GameInfoId
           
static cz.cuni.amis.utils.token.Token GamePausedPropertyToken
           
static cz.cuni.amis.utils.token.Token GoalTeamScorePropertyToken
           
static cz.cuni.amis.utils.token.Token MaxTeamSizePropertyToken
           
static Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens
           
protected  long SimTime
           
static cz.cuni.amis.utils.token.Token TimeLimitPropertyToken
           
static cz.cuni.amis.utils.token.Token WeaponStayPropertyToken
           
 
Constructor Summary
GameInfoShared()
          Parameter-less contructor for the message.
 
Method Summary
abstract  GameInfoShared clone()
           
 Class getCompositeClass()
           
abstract  int getFragLimit()
          Number of kills needed to win game (BotDeathMatch only).
abstract  long getGoalTeamScore()
          Number of points a team needs to win the game (BotTeamGame, BotCTFGame, BotDoubleDomination).
 UnrealId getId()
           
abstract  int getMaxTeamSize()
          Max number of players per side (BotTeamGame, BotCTFGame, BotDoubleDomination).
 long getSimTime()
          Simulation time in MILLI SECONDS !!!
abstract  double getTimeLimit()
          Maximum time game will last (if tied at end may goe to "sudden death overtime" - depends on the game type).
abstract  boolean isBotsPaused()
          If the game is paused just for bots - human controlled players can normally move.
abstract  boolean isGamePaused()
          If the game is paused - nobody can move.
abstract  boolean isWeaponStay()
          If true respawned weapons will stay on the ground after picked up (but bot cannot pickup same weapon twice).
protected  void setSimTime(long SimTime)
          Used by Yylex to slip correct time of the object or programmatically.
 String toHtmlString()
           
 String toString()
           
 
Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
toJsonLiteral
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ISharedWorldObject
getProperties, getProperty
 

Field Detail

GameInfoId

public static final UnrealId GameInfoId

SimTime

protected long SimTime

WeaponStayPropertyToken

public static final cz.cuni.amis.utils.token.Token WeaponStayPropertyToken

TimeLimitPropertyToken

public static final cz.cuni.amis.utils.token.Token TimeLimitPropertyToken

FragLimitPropertyToken

public static final cz.cuni.amis.utils.token.Token FragLimitPropertyToken

GoalTeamScorePropertyToken

public static final cz.cuni.amis.utils.token.Token GoalTeamScorePropertyToken

MaxTeamSizePropertyToken

public static final cz.cuni.amis.utils.token.Token MaxTeamSizePropertyToken

GamePausedPropertyToken

public static final cz.cuni.amis.utils.token.Token GamePausedPropertyToken

BotsPausedPropertyToken

public static final cz.cuni.amis.utils.token.Token BotsPausedPropertyToken

SharedPropertyTokens

public static final Set<cz.cuni.amis.utils.token.Token> SharedPropertyTokens
Constructor Detail

GameInfoShared

public GameInfoShared()
Parameter-less contructor for the message.

Method Detail

getId

public UnrealId getId()
Specified by:
getId in interface IWorldObject

getSimTime

public long getSimTime()
Simulation time in MILLI SECONDS !!!

Specified by:
getSimTime in interface IWorldObject
Specified by:
getSimTime in interface ISharedWorldObject

setSimTime

protected void setSimTime(long SimTime)
Used by Yylex to slip correct time of the object or programmatically.


clone

public abstract GameInfoShared clone()
Specified by:
clone in interface ISharedWorldObject
Overrides:
clone in class Object

getCompositeClass

public Class getCompositeClass()
Specified by:
getCompositeClass in interface ISharedWorldObject

isWeaponStay

public abstract boolean isWeaponStay()
If true respawned weapons will stay on the ground after picked up (but bot cannot pickup same weapon twice).


getTimeLimit

public abstract double getTimeLimit()
Maximum time game will last (if tied at end may goe to "sudden death overtime" - depends on the game type).


getFragLimit

public abstract int getFragLimit()
Number of kills needed to win game (BotDeathMatch only).


getGoalTeamScore

public abstract long getGoalTeamScore()
Number of points a team needs to win the game (BotTeamGame, BotCTFGame, BotDoubleDomination).


getMaxTeamSize

public abstract int getMaxTeamSize()
Max number of players per side (BotTeamGame, BotCTFGame, BotDoubleDomination).


isGamePaused

public abstract boolean isGamePaused()
If the game is paused - nobody can move.


isBotsPaused

public abstract boolean isBotsPaused()
If the game is paused just for bots - human controlled players can normally move.


toString

public String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()


Copyright © 2014 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.