Game

java.lang.Object
- core.game.Game

Direct Known Subclasses:

BasicGame, ForwardModel
```
public abstract class Game
extends java.lang.Object
```
Created with IntelliJ IDEA. User: Diego Date: 17/10/13 Time: 13:42 This is a Java port from Tom Schaul's VGDL - https://github.com/schaul/py-vgdl

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Game.Bucket
Class for helping collision detection.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Game.Bucket` Class for helping collision detection.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Types.ACTIONS[]`	`avatarLastAction` Avatars last actions.
`protected MovingAvatar[]`	`avatars` Quick reference to the gamer
`protected int`	`block_size` Size of the block in pixels.
`protected Game.Bucket[]`	`bucketList` Arraylist to hold collisions between objects in every frame
`protected java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>>`	`charMapping` Mapping between characters in the level and the entities they represent.
`protected Content[]`	`classConst` Content objects for the different sprite types..
`protected java.util.ArrayList<Effect>[][]`	`collisionEffects` Relationships for collisions: double array of (list of) effects.
`int[]`	`counter`
`protected java.util.ArrayList<Pair<java.lang.Integer,java.lang.Integer>>`	`definedEffects` Pairs of all defined effects in the game.
`protected java.util.ArrayList<java.lang.Integer>`	`definedEOSEffects` List of types that can trigger an EOS effect.
`protected java.util.ArrayList<Effect>[]`	`eosEffects` List of EOS effects
`protected ForwardModel`	`fwdModel` State observation for this game.
`protected int`	`gameTick` Game tick
`protected java.util.TreeSet<Event>`	`historicEvents` Historic of events related to the avatar happened during the game.
`boolean[]`	`humanPlayer` indicates if player i is human or not
`protected boolean`	`is_stochastic` Indicates if the game is stochastic.
`protected boolean`	`isEnded` Indicates if the game is ended.
`protected java.util.ArrayList<java.lang.Integer>[]`	`iSubTypes` For each entry, int identifier of sprite type, a list with all the itypes this sprite belongs to.
`java.lang.String`	`key_handler` Key Handler for human play.
`static KeyHandler`	`ki`
`java.util.ArrayList<VGDLSprite>`	`kill_list` List of sprites killed in the game.
`protected static int`	`MAX_SPRITES` Maximum number of sprites in a game.
`protected int`	`nextSpriteID` Next ID to generate for sprites;
`int`	`no_counters`
`int`	`no_players`
`protected int`	`num_sprites` Number of sprites this game has.
`java.util.HashMap<java.lang.String,ParameterContent>`	`parameters` Parameters for a Game Space.
`protected PathFinder`	`pathf` Pathfinder.
`protected java.awt.Color[]`	`resources_colors` Color for each resource
`protected int[]`	`resources_limits` Limit number of each resource type
`protected java.awt.Dimension`	`screenSize` Screen size.
`protected java.util.ArrayList<Pair<java.lang.Integer,java.lang.Long>>[]`	`shieldedEffects` For each entry, int identifier of sprite type, a list with all the itypes this sprite belongs to.
`protected boolean[]`	`singletons` Singletons of the game.
`protected java.awt.Dimension`	`size` Dimensions of the game.
`protected SpriteGroup[]`	`spriteGroups` Groups of sprites in the level.
`protected int[]`	`spriteOrder` z-level of sprite types (in case of overlap)
`protected VGDLSprite[]`	`templateSprites` List of template sprites, one for each object in the above "classConst" array.
`protected java.util.ArrayList<Termination>`	`terminations` Termination set conditions to finish the game.
`protected java.util.TreeSet<TimeEffect>`	`timeEffects` List of TIME effects
`static WindowInput`	`wi` Handling when the window is closed

Constructor Summary

Constructors
Constructor and Description

Game()
Default constructor.

Constructors
Constructor and Description
`Game()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`_updateCollisionDict(VGDLSprite sprite)`
`void`	`abort()` Aborts a game.
`void`	`addShield(int type1, int type2, long functHash)` Adds a new Shield effect to the scene.
`VGDLSprite`	`addSprite(int itype, Vector2d position)` Adds a sprite given a content and position.
`VGDLSprite`	`addSprite(int itype, Vector2d position, boolean force)` Adds a sprite given a content and position.
`VGDLSprite`	`addSprite(SpriteContent content, Vector2d position, int itype, boolean force)` Adds a sprite given a content and position.
`protected void`	`addSprite(VGDLSprite sprite, int itype)` Adds a new sprite to the pool of sprites of the game.
`void`	`addTimeEffect(TimeEffect ef)` Adds a time effect to the game.
`void`	`buildLevel(java.lang.String gamelvl, int randomSeed)` Builds a level, receiving a file name.
`abstract void`	`buildStringLevel(java.lang.String[] levelString, int randomSeed)`
`void`	`changeSpriteOrder(java.util.ArrayList<java.lang.Integer> spOrder)` Modify the sprite order for the renderer of the GVG-AI
`protected void`	`checkTimeOut()` Checks if the game must finish because of number of cycles played.
`protected void`	`clearAll(ForwardModel fm)` Deletes all the sprites killed in the previous step.
`void`	`clearInteractionTerminationData()` clear all the interactions and termination in the current game
`void`	`createAvatars(int humanID)` Method to create the array of avatars from the sprites.
`void`	`disqualify()` Disqualifies the player in the game, and also sets the isEnded flag to true.
`void`	`disqualify(int id)` Overloaded method for multiplayer games.
`protected void`	`eventHandling()` Handles collisions and triggers events.
`MovingAvatar`	`getAvatar()` Returns the avatar of the game in single player games.
`MovingAvatar`	`getAvatar(int playerID)` Overloaded method, returns the avatar of the player specified (for multi player games).
`MovingAvatar[]`	`getAvatars()` Returns an array of all avatars in the game.
`int`	`getBlockSize()` Indicates how many pixels form a block in the game.
`java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>>`	`getCharMapping()` Returns the char mapping of this array, that relates characters in the level with sprite names that it references.
`java.util.ArrayList<Effect>`	`getCollisionEffects(int spriteItype1, int spriteItype2)` Gets the array of collisions defined for two types of sprites.
`java.util.ArrayList<Pair<java.lang.Integer,java.lang.Integer>>`	`getDefinedEffects()` Returns all paired effects defined in the game.
`java.util.ArrayList<java.lang.Integer>`	`getDefinedEosEffects()` Returns the list of sprite type with at least one EOS effect defined.
`java.util.ArrayList<Effect>`	`getEosEffects(int obj1)` Returns all EOS effects defined in the game.
`double[]`	`getFullResult()` Returns the complete result of the game (victory, score, timestep).
`int`	`getGameTick()` Returns the current game tick of this game.
`java.util.ArrayList<GameDescription.InteractionData>`	`getInteractionData(int itype1, int itype2)` Get a list of interaction data objects between two sprite types.
`static int`	`getMaxSprites()` Returns the number of sprites
`Types.WINNER[]`	`getMultiWinner()` Returns an array of type Types.WINNER containing the win state of all players in the game.
`int`	`getNoCounters()`
`int`	`getNoPlayers()` Method used to access the number of players in a game.
`int`	`getNumDisabledSprites(int itype)` Returns the number of sprites disabled of the type given by parameter and all its subtypes
`int`	`getNumSprites(int itype)` Returns the number of sprites of the type given by parameter, and all its subtypes
`StateObservation`	`getObservation()` Retuns the observation of this state.
`StateObservationMulti`	`getObservationMulti(int playerID)` Retuns the observation of this state (for multiplayer).
`java.util.HashMap<java.lang.String,ParameterContent>`	`getParameters()`
`java.util.ArrayList<Node>`	`getPath(Vector2d start, Vector2d end)`
`java.util.Random`	`getRandomGenerator()` Returns the sampleRandom object
`java.awt.Color`	`getResourceColor(int resourceId)` Gets the color of the resource of type resourceId
`int`	`getResourceLimit(int resourceId)` Gets the maximum amount of resources of type resourceId that are allowed by entities in the game.
`double`	`getScore()` Returns the game score.
`double`	`getScore(int playerID)` Method overloaded for multi player games.
`java.awt.Dimension`	`getScreenSize()` Gets the dimensions of the screen.
`java.util.ArrayList<GameDescription.SpriteData>`	`getSpriteData()` Get an array of sprite data objects for all leaf sprite nodes.
`java.util.Iterator<VGDLSprite>`	`getSpriteGroup(int spriteItype)` Gets an iterator for the collection of sprites for a particular sprite type.
`int[]`	`getSpriteOrder()` Gets the order in which the sprites are drawn.
`java.util.ArrayList<VGDLSprite>`	`getSprites(int spriteItype)` Gets the collection of sprites for a particular sprite type.
`java.util.Iterator<VGDLSprite>`	`getSubSpritesGroup(int spriteItype)` Gets an iterator for the collection of sprites for a particular sprite type, AND all subtypes.
`java.util.ArrayList<java.lang.Integer>`	`getSubTypes(int itype)` Returns an arraylist of subtypes of the given parent type.
`VGDLSprite`	`getTempAvatar(GameDescription.SpriteData sprite)` Construct and return a temporary avatar sprite
`java.util.ArrayList<GameDescription.TerminationData>`	`getTerminationData()` Return an array of termination data objects.
`java.util.ArrayList<Termination>`	`getTerminations()` Gets the array of termination conditions for this game.
`int`	`getValueCounter(int idx)`
`Types.WINNER`	`getWinner()` Returns the winner of this game.
`Types.WINNER`	`getWinner(int playerID)` Overloaded method for multi player games.
`double[]`	`handleResult()` Handles the result for the game, considering disqualifications.
`void`	`initForwardModel()` Starts the forward model for the game.
`void`	`initMulti()` Initialisation after the game is parsed.
`void`	`initSprites(java.util.ArrayList<java.lang.Integer> spOrder, java.util.ArrayList<java.lang.Integer> sings, java.util.HashMap<java.lang.Integer,SpriteContent> constructors)` Initializes the sprite structures that hold the game.
`abstract boolean`	`isGameOver()` Indicates if the game is over, or if it is still being played.
`void`	`killSprite(VGDLSprite sprite, boolean transformed)` Kills a given sprite, adding it to the list of sprites killed at this step.
`void`	`loadDefaultConstr()` Loads the constructor information for default objects (walls, avatar).
`protected void`	`parseParameters(GameContent content)` Reads the parameters of a game type.
`double[]`	`playGame(Player[] players, int randomSeed, boolean isHuman, int humanID)` Plays the game, graphics enabled.
`double[]`	`playOnlineGame(Player[] players, int randomSeed, boolean isHuman, int humanID)`
`void`	`printLearningResult(int levelIdx, boolean isValidation)` Prints the result of the game, indicating the game id, level id, winner, the score and the number of game ticks played, in this order.
`void`	`printResult()` Prints the result of the game, indicating the winner, the score and the number of game ticks played, in this order.
`void`	`reset()` Sets the game back to the state prior to load a level.
`void`	`reverseDirection(VGDLSprite sprite)` Reverses the direction of a given sprite.
`double[]`	`runGame(Player[] players, int randomSeed)` Runs a game, without graphics.
`void`	`setAvatar(MovingAvatar newAvatar)` Sets the avatar of the game.
`void`	`setAvatar(MovingAvatar newAvatar, int playerID)` Overloaded method, sets the avatar specified.
`void`	`setAvatarLastAction(Types.ACTIONS action)` Sets the last action executed by the avatar.
`void`	`setAvatarLastAction(Types.ACTIONS action, int playerID)` Overloaded method for multi player games.
`void`	`setCharMapping(java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> charMapping)` Set the char mapping that is used to parse loaded levels
`void`	`setParameters(java.util.HashMap<java.lang.String,ParameterContent> parameters)`
`void`	`setStochastic(boolean stoch)` Defines this game as stochastic (or not) depending on the parameter passed.
`protected void`	`terminationHandling()` Handles termination conditions, for every termination defined in 'terminations' array.
`protected void`	`tick()` Performs one tick for the game: calling update(this) in all sprites.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - humanPlayer
```
public boolean[] humanPlayer
```
    indicates if player i is human or not
  - spriteOrder
```
protected int[] spriteOrder
```
    z-level of sprite types (in case of overlap)
  - singletons
```
protected boolean[] singletons
```
    Singletons of the game.
  - classConst
```
protected Content[] classConst
```
    Content objects for the different sprite types.. The index is the type of object Content encloses information about the class of the object and its parameters.
  - parameters
```
public java.util.HashMap<java.lang.String,ParameterContent> parameters
```
    Parameters for a Game Space. Unused in normal games.
  - templateSprites
```
protected VGDLSprite[] templateSprites
```
    List of template sprites, one for each object in the above "classConst" array.
  - spriteGroups
```
protected SpriteGroup[] spriteGroups
```
    Groups of sprites in the level. Each element of the array is a collection of sprites of a given type, which is also the index of the array.
  - collisionEffects
```
protected java.util.ArrayList<Effect>[][] collisionEffects
```
    Relationships for collisions: double array of (list of) effects. Interaction between two sprites can trigger more than one effect. collisionEffects[] -> int id of the FIRST element taking part on the effects. collisionEffects[][] -> int id of the SECOND element taking part on the effects.
  - definedEffects
```
protected java.util.ArrayList<Pair<java.lang.Integer,java.lang.Integer>> definedEffects
```
    Pairs of all defined effects in the game.
  - eosEffects
```
protected java.util.ArrayList<Effect>[] eosEffects
```
    List of EOS effects
  - timeEffects
```
protected java.util.TreeSet<TimeEffect> timeEffects
```
    List of TIME effects
  - definedEOSEffects
```
protected java.util.ArrayList<java.lang.Integer> definedEOSEffects
```
    List of types that can trigger an EOS effect.
  - historicEvents
```
protected java.util.TreeSet<Event> historicEvents
```
    Historic of events related to the avatar happened during the game. The entries are ordered asc. by game step.
  - iSubTypes
```
protected java.util.ArrayList<java.lang.Integer>[] iSubTypes
```
    For each entry, int identifier of sprite type, a list with all the itypes this sprite belongs to.
  - shieldedEffects
```
protected java.util.ArrayList<Pair<java.lang.Integer,java.lang.Long>>[] shieldedEffects
```
    For each entry, int identifier of sprite type, a list with all the itypes this sprite belongs to.
  - bucketList
```
protected Game.Bucket[] bucketList
```
    Arraylist to hold collisions between objects in every frame
  - charMapping
```
protected java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> charMapping
```
    Mapping between characters in the level and the entities they represent.
  - terminations
```
protected java.util.ArrayList<Termination> terminations
```
    Termination set conditions to finish the game.
  - kill_list
```
public java.util.ArrayList<VGDLSprite> kill_list
```
    List of sprites killed in the game.
  - resources_limits
```
protected int[] resources_limits
```
    Limit number of each resource type
  - resources_colors
```
protected java.awt.Color[] resources_colors
```
    Color for each resource
  - screenSize
```
protected java.awt.Dimension screenSize
```
    Screen size.
  - size
```
protected java.awt.Dimension size
```
    Dimensions of the game.
  - is_stochastic
```
protected boolean is_stochastic
```
    Indicates if the game is stochastic.
  - num_sprites
```
protected int num_sprites
```
    Number of sprites this game has.
  - gameTick
```
protected int gameTick
```
    Game tick
  - wi
```
public static WindowInput wi
```
    Handling when the window is closed
  - block_size
```
protected int block_size
```
    Size of the block in pixels.
  - avatars
```
protected MovingAvatar[] avatars
```
    Quick reference to the gamer
  - isEnded
```
protected boolean isEnded
```
    Indicates if the game is ended.
  - fwdModel
```
protected ForwardModel fwdModel
```
    State observation for this game.
  - MAX_SPRITES
```
protected static int MAX_SPRITES
```
    Maximum number of sprites in a game.
  - nextSpriteID
```
protected int nextSpriteID
```
    Next ID to generate for sprites;
  - key_handler
```
public java.lang.String key_handler
```
    Key Handler for human play. The default is CompetitionParameters.KEY_INPUT
  - pathf
```
protected PathFinder pathf
```
    Pathfinder.
  - avatarLastAction
```
protected Types.ACTIONS[] avatarLastAction
```
    Avatars last actions. Array for all avatars in the game. Index in array corresponds to playerID.
  - no_players
```
public int no_players
```
  - no_counters
```
public int no_counters
```
  - counter
```
public int[] counter
```
  - ki
```
public static KeyHandler ki
```
- Constructor Detail
  - Game
```
public Game()
```
    Default constructor.
- Method Detail
  - loadDefaultConstr
```
public void loadDefaultConstr()
```
    Loads the constructor information for default objects (walls, avatar).
  - initMulti
```
public void initMulti()
```
    Initialisation after the game is parsed.
  - changeSpriteOrder
```
public void changeSpriteOrder(java.util.ArrayList<java.lang.Integer> spOrder)
```
    Modify the sprite order for the renderer of the GVG-AI
    
    Parameters:
    
    spOrder - the request order
  - initSprites
```
public void initSprites(java.util.ArrayList<java.lang.Integer> spOrder,
                        java.util.ArrayList<java.lang.Integer> sings,
                        java.util.HashMap<java.lang.Integer,SpriteContent> constructors)
```
    Initializes the sprite structures that hold the game.
    
    Parameters:
    
    spOrder - order of sprite types to be drawn on the screen.
    
    sings - sprites that are marked as singletons.
    
    constructors - map of sprite constructor's information.
  - getNoPlayers
```
public int getNoPlayers()
```
    Method used to access the number of players in a game.
    
    Returns:
    
    number of players.
  - getNoCounters
```
public int getNoCounters()
```
  - getValueCounter
```
public int getValueCounter(int idx)
```
  - getSpriteData
```
public java.util.ArrayList<GameDescription.SpriteData> getSpriteData()
```
    Get an array of sprite data objects for all leaf sprite nodes.
    
    Returns:
    
    Array of sprite data
  - getTempAvatar
```
public VGDLSprite getTempAvatar(GameDescription.SpriteData sprite)
```
    Construct and return a temporary avatar sprite
    
    Returns:
    
    a temproary avatar sprite
  - getTerminationData
```
public java.util.ArrayList<GameDescription.TerminationData> getTerminationData()
```
    Return an array of termination data objects. These objects represents the termination conditions for the game
    
    Returns:
    
    array of Termination Data objects
  - getInteractionData
```
public java.util.ArrayList<GameDescription.InteractionData> getInteractionData(int itype1,
                                                                               int itype2)
```
    Get a list of interaction data objects between two sprite types. These objects represents the effect happened to the first sprite type.
    
    Parameters:
    
    itype1 - The first sprite type object
    
    itype2 - The second sprite type object
    
    Returns:
    
    array of interaction data objects.
  - reset
```
public void reset()
```
    Sets the game back to the state prior to load a level.
  - initForwardModel
```
public void initForwardModel()
```
    Starts the forward model for the game.
  - parseParameters
```
protected void parseParameters(GameContent content)
```
    Reads the parameters of a game type.
    
    Parameters:
    
    content - list of parameter-value pairs.
  - addSprite
```
protected void addSprite(VGDLSprite sprite,
                         int itype)
```
    Adds a new sprite to the pool of sprites of the game. Increments the sprite counter and also modifies is_stochastic and the avatar accordingly.
    
    Parameters:
    
    sprite - the new sprite to add.
    
    itype - main int type of this sprite (leaf of the hierarchy of types).
  - getNumSprites
```
public int getNumSprites(int itype)
```
    Returns the number of sprites of the type given by parameter, and all its subtypes
    
    Parameters:
    
    itype - parent itype requested.
    
    Returns:
    
    the number of sprites of the type and subtypes.
  - getSubTypes
```
public java.util.ArrayList<java.lang.Integer> getSubTypes(int itype)
```
    Returns an arraylist of subtypes of the given parent type.
    
    Parameters:
    
    itype - parent itype requested.
  - getNumDisabledSprites
```
public int getNumDisabledSprites(int itype)
```
    Returns the number of sprites disabled of the type given by parameter and all its subtypes
    
    Parameters:
    
    itype - parent itype requested.
    
    Returns:
    
    the number of disabled sprites of the type and subtypes.
  - runGame
```
public double[] runGame(Player[] players,
                        int randomSeed)
```
    Runs a game, without graphics.
    
    Parameters:
    
    players - Players that play this game.
    
    randomSeed - sampleRandom seed for the whole game.
    
    Returns:
    
    the score of the game played.
  - playGame
```
public double[] playGame(Player[] players,
                         int randomSeed,
                         boolean isHuman,
                         int humanID)
```
    Plays the game, graphics enabled.
    
    Parameters:
    
    players - Players that play this game.
    
    randomSeed - sampleRandom seed for the whole game.
    
    isHuman - indicates if a human is playing the game.
    
    humanID - ID of the human player
    
    Returns:
    
    the score of the game played.
  - playOnlineGame
```
public double[] playOnlineGame(Player[] players,
                               int randomSeed,
                               boolean isHuman,
                               int humanID)
```
  - handleResult
```
public double[] handleResult()
```
    Handles the result for the game, considering disqualifications. Prints the result (score, time and winner) and returns the score of the game. Default player ID used 0 for single player games.
    
    Returns:
    
    the result of the game.
  - checkTimeOut
```
protected void checkTimeOut()
```
    Checks if the game must finish because of number of cycles played. This is a value stored in CompetitionParameters.MAX_TIMESTEPS. If the game is due to end, the winner is determined and the flag isEnded is set to true.
  - printResult
```
public void printResult()
```
    Prints the result of the game, indicating the winner, the score and the number of game ticks played, in this order.
  - printLearningResult
```
public void printLearningResult(int levelIdx,
                                boolean isValidation)
```
    Prints the result of the game, indicating the game id, level id, winner, the score and the number of game ticks played, in this order.
  - getFullResult
```
public double[] getFullResult()
```
    Returns the complete result of the game (victory, score, timestep). Indicated in triplets, one per player.
    
    Returns:
    
    [w0,s0,t0,w1,s1,t1,...]
  - disqualify
```
public void disqualify()
```
    Disqualifies the player in the game, and also sets the isEnded flag to true.
  - disqualify
```
public void disqualify(int id)
```
    Overloaded method for multiplayer games. Same functionality as above.
    
    Parameters:
    
    id - - id of the player that was disqualified
  - abort
```
public void abort()
```
    Aborts a game. Game is lost and game over.
  - createAvatars
```
public void createAvatars(int humanID)
```
    Method to create the array of avatars from the sprites.
  - tick
```
protected void tick()
```
    Performs one tick for the game: calling update(this) in all sprites. It follows the opposite order of the drawing order (inverse spriteOrder[]). Avatar is always updated first. Doesn't update disabled sprites.
  - eventHandling
```
protected void eventHandling()
```
    Handles collisions and triggers events.
  - terminationHandling
```
protected void terminationHandling()
```
    Handles termination conditions, for every termination defined in 'terminations' array.
  - clearAll
```
protected void clearAll(ForwardModel fm)
```
    Deletes all the sprites killed in the previous step. Also, clears the array of collisions from the last step.
    
    Parameters:
    
    fm - Forward model where we are cleaning sprites.
  - addShield
```
public void addShield(int type1,
                      int type2,
                      long functHash)
```
    Adds a new Shield effect to the scene.
    
    Parameters:
    
    type1 - Recipient of the effect (sprite ID)
    
    type2 - Second sprite ID
    
    functHash - Hash of the effect name to shield.
  - addSprite
```
public VGDLSprite addSprite(int itype,
                            Vector2d position)
```
    Adds a sprite given a content and position.
    
    Parameters:
    
    itype - integer that identifies the definition of the sprite to add
    
    position - where the sprite has to be placed.
  - addSprite
```
public VGDLSprite addSprite(int itype,
                            Vector2d position,
                            boolean force)
```
    Adds a sprite given a content and position.
    
    Parameters:
    
    itype - integer that identifies the definition of the sprite to add
    
    position - where the sprite has to be placed.
    
    force - if true, ignores the singleton restrictions and creates it anyway.
  - addSprite
```
public VGDLSprite addSprite(SpriteContent content,
                            Vector2d position,
                            int itype,
                            boolean force)
```
    Adds a sprite given a content and position. It checks for possible singletons.
    
    Parameters:
    
    content - definition of the sprite to add
    
    position - where the sprite has to be placed.
    
    itype - integer identifier of this type of sprite.
    
    force - If true, forces the creation ignoring singleton restrictions
  - _updateCollisionDict
```
public void _updateCollisionDict(VGDLSprite sprite)
```
  - getScore
```
public double getScore()
```
    Returns the game score.
  - getScore
```
public double getScore(int playerID)
```
    Method overloaded for multi player games. Returns the game score of the specified player.
    
    Parameters:
    
    playerID - ID of the player.
  - reverseDirection
```
public void reverseDirection(VGDLSprite sprite)
```
    Reverses the direction of a given sprite.
    
    Parameters:
    
    sprite - sprite to reverse.
  - killSprite
```
public void killSprite(VGDLSprite sprite,
                       boolean transformed)
```
    Kills a given sprite, adding it to the list of sprites killed at this step.
    
    Parameters:
    
    sprite - the sprite to kill.
    
    transformed - - indicates if the sprite was transformed (necessary to kill sprite even if avatar, instead of disabling it).
  - getSpriteGroup
```
public java.util.Iterator<VGDLSprite> getSpriteGroup(int spriteItype)
```
    Gets an iterator for the collection of sprites for a particular sprite type.
    
    Parameters:
    
    spriteItype - type of the sprite to retrieve.
    
    Returns:
    
    sprite collection of the specified type.
  - getSubSpritesGroup
```
public java.util.Iterator<VGDLSprite> getSubSpritesGroup(int spriteItype)
```
    Gets an iterator for the collection of sprites for a particular sprite type, AND all subtypes.
    
    Parameters:
    
    spriteItype - type of the sprite to retrieve.
    
    Returns:
    
    sprite collection of the specified type and subtypes.
  - getSprites
```
public java.util.ArrayList<VGDLSprite> getSprites(int spriteItype)
```
    Gets the collection of sprites for a particular sprite type.
    
    Parameters:
    
    spriteItype - type of the sprite to retrieve.
    
    Returns:
    
    sprite collection of the specified type.
  - getCollisionEffects
```
public java.util.ArrayList<Effect> getCollisionEffects(int spriteItype1,
                                                       int spriteItype2)
```
    Gets the array of collisions defined for two types of sprites.
    
    Parameters:
    
    spriteItype1 - type of the first sprite.
    
    spriteItype2 - type of the second sprite.
    
    Returns:
    
    the collection of the effects defined between the two sprite types.
  - getDefinedEffects
```
public java.util.ArrayList<Pair<java.lang.Integer,java.lang.Integer>> getDefinedEffects()
```
    Returns all paired effects defined in the game.
    
    Returns:
    
    all paired effects defined in the game.
  - getDefinedEosEffects
```
public java.util.ArrayList<java.lang.Integer> getDefinedEosEffects()
```
    Returns the list of sprite type with at least one EOS effect defined.
    
    Returns:
    
    the list of sprite type with at least one EOS effect defined.
  - getEosEffects
```
public java.util.ArrayList<Effect> getEosEffects(int obj1)
```
    Returns all EOS effects defined in the game.
    
    Returns:
    
    all EOS effects defined in the game.
  - addTimeEffect
```
public void addTimeEffect(TimeEffect ef)
```
    Adds a time effect to the game.
  - getCharMapping
```
public java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> getCharMapping()
```
    Returns the char mapping of this array, that relates characters in the level with sprite names that it references.
    
    Returns:
    
    the char mapping of this array. For each character, there is a list of N sprite names.
  - setCharMapping
```
public void setCharMapping(java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> charMapping)
```
    Set the char mapping that is used to parse loaded levels
    
    Parameters:
    
    charMapping - new character mapping
  - getTerminations
```
public java.util.ArrayList<Termination> getTerminations()
```
    Gets the array of termination conditions for this game.
    
    Returns:
    
    the array of termination conditions.
  - getResourceLimit
```
public int getResourceLimit(int resourceId)
```
    Gets the maximum amount of resources of type resourceId that are allowed by entities in the game.
    
    Parameters:
    
    resourceId - the id of the resource to query for.
    
    Returns:
    
    maximum amount of resources of type resourceId.
  - getResourceColor
```
public java.awt.Color getResourceColor(int resourceId)
```
    Gets the color of the resource of type resourceId
    
    Parameters:
    
    resourceId - id of the resource to query for.
    
    Returns:
    
    Color assigned to this resource.
  - getScreenSize
```
public java.awt.Dimension getScreenSize()
```
    Gets the dimensions of the screen.
    
    Returns:
    
    the dimensions of the screen.
  - setStochastic
```
public void setStochastic(boolean stoch)
```
    Defines this game as stochastic (or not) depending on the parameter passed.
    
    Parameters:
    
    stoch - true if the game is stochastic.
  - getAvatar
```
public MovingAvatar getAvatar()
```
    Returns the avatar of the game in single player games.
    
    Returns:
    
    the avatar of the game.
  - getAvatar
```
public MovingAvatar getAvatar(int playerID)
```
    Overloaded method, returns the avatar of the player specified (for multi player games).
    
    Parameters:
    
    playerID - ID of the player desired.
    
    Returns:
    
    the corresponding avatar.
  - getAvatars
```
public MovingAvatar[] getAvatars()
```
    Returns an array of all avatars in the game.
    
    Returns:
    
    array of avatars.
  - setAvatar
```
public void setAvatar(MovingAvatar newAvatar)
```
    Sets the avatar of the game.
    
    Parameters:
    
    newAvatar - the avatar of the game.
  - setAvatar
```
public void setAvatar(MovingAvatar newAvatar,
                      int playerID)
```
    Overloaded method, sets the avatar specified.
    
    Parameters:
    
    newAvatar - the avatar of the game.
    
    playerID - the ID of the player desired.
  - setAvatarLastAction
```
public void setAvatarLastAction(Types.ACTIONS action)
```
    Sets the last action executed by the avatar. It could be NIL in case of time overspent.
    
    Parameters:
    
    action - the action to set.
  - setAvatarLastAction
```
public void setAvatarLastAction(Types.ACTIONS action,
                                int playerID)
```
    Overloaded method for multi player games. Sets the last action executed by the avatar with the corresponding player ID. It could be NIL in case of time overspent.
    
    Parameters:
    
    action - the action to set.
    
    playerID - the ID of the player.
  - isGameOver
```
public abstract boolean isGameOver()
```
    Indicates if the game is over, or if it is still being played.
    
    Returns:
    
    true if the game is over, false if it is still being played.
  - clearInteractionTerminationData
```
public void clearInteractionTerminationData()
```
    clear all the interactions and termination in the current game
  - getObservation
```
public StateObservation getObservation()
```
    Retuns the observation of this state.
    
    Returns:
    
    the observation.
  - getObservationMulti
```
public StateObservationMulti getObservationMulti(int playerID)
```
    Retuns the observation of this state (for multiplayer).
    
    Returns:
    
    the observation.
  - getRandomGenerator
```
public java.util.Random getRandomGenerator()
```
    Returns the sampleRandom object
    
    Returns:
    
    the sampleRandom generator.
  - getGameTick
```
public int getGameTick()
```
    Returns the current game tick of this game.
    
    Returns:
    
    the current game tick of this game.
  - getWinner
```
public Types.WINNER getWinner()
```
    Returns the winner of this game. A value from Types.WINNER.
    
    Returns:
    
    the winner of this game.
  - getWinner
```
public Types.WINNER getWinner(int playerID)
```
    Overloaded method for multi player games. Returns the win state of the specified player.
    
    Parameters:
    
    playerID - ID of the player.
    
    Returns:
    
    the win state of the specified player.
  - getMultiWinner
```
public Types.WINNER[] getMultiWinner()
```
    Returns an array of type Types.WINNER containing the win state of all players in the game. Index in the array corresponds to playerID.
    
    Returns:
    
    array of Types.WINNER values.
  - getSpriteOrder
```
public int[] getSpriteOrder()
```
    Gets the order in which the sprites are drawn.
    
    Returns:
    
    the order of the sprites.
  - getMaxSprites
```
public static int getMaxSprites()
```
    Returns the number of sprites
  - getBlockSize
```
public int getBlockSize()
```
    Indicates how many pixels form a block in the game.
    
    Returns:
    
    how many pixels form a block in the game.
  - buildStringLevel
```
public abstract void buildStringLevel(java.lang.String[] levelString,
                                      int randomSeed)
```
  - buildLevel
```
public void buildLevel(java.lang.String gamelvl,
                       int randomSeed)
```
    Builds a level, receiving a file name.
    
    Parameters:
    
    gamelvl - file name containing the level.
  - getPath
```
public java.util.ArrayList<Node> getPath(Vector2d start,
                                         Vector2d end)
```
  - getParameters
```
public java.util.HashMap<java.lang.String,ParameterContent> getParameters()
```
  - setParameters
```
public void setParameters(java.util.HashMap<java.lang.String,ParameterContent> parameters)
```

Class Game

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

humanPlayer

spriteOrder

singletons

classConst

parameters

templateSprites

spriteGroups

collisionEffects

definedEffects

eosEffects

timeEffects

definedEOSEffects

historicEvents

iSubTypes

shieldedEffects

bucketList

charMapping

terminations

kill_list

resources_limits

resources_colors

screenSize

size

is_stochastic

num_sprites

gameTick

wi

block_size

avatars

isEnded

fwdModel

MAX_SPRITES

nextSpriteID

key_handler

pathf

avatarLastAction

no_players

no_counters

counter

ki

Constructor Detail

Game

Method Detail

loadDefaultConstr

initMulti

changeSpriteOrder

initSprites

getNoPlayers

getNoCounters

getValueCounter

getSpriteData

getTempAvatar

getTerminationData

getInteractionData

reset

initForwardModel

parseParameters

addSprite

getNumSprites

getSubTypes

getNumDisabledSprites

runGame

playGame

playOnlineGame

handleResult

checkTimeOut

printResult

printLearningResult

getFullResult

disqualify

disqualify

abort

createAvatars