ForwardModel

java.lang.Object
- core.game.Game
- - core.game.ForwardModel

```
public class ForwardModel
extends Game
```
Created with IntelliJ IDEA. User: Diego Date: 13/11/13 Time: 15:37 This is a Java port from Tom Schaul's VGDL - https://github.com/schaul/py-vgdl

Nested Class Summary
- Nested classes/interfaces inherited from class core.game.Game
  Game.Bucket

Field Summary
- Fields inherited from class core.game.Game
  avatarLastAction, avatars, block_size, bucketList, charMapping, classConst, collisionEffects, counter, definedEffects, definedEOSEffects, eosEffects, fwdModel, gameTick, historicEvents, humanPlayer, is_stochastic, isEnded, iSubTypes, key_handler, ki, kill_list, MAX_SPRITES, nextSpriteID, no_counters, no_players, num_sprites, parameters, pathf, resources_colors, resources_limits, screenSize, shieldedEffects, singletons, size, spriteGroups, spriteOrder, templateSprites, terminations, timeEffects, wi

Constructor Summary

Constructors
Constructor and Description

ForwardModel(Game a_gameState, int playerID)
Constructor for StateObservation.

Constructors
Constructor and Description
`ForwardModel(Game a_gameState, int playerID)` Constructor for StateObservation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`advance(Types.ACTIONS action)` Advances the forward model using the action supplied.
`void`	`advance(Types.ACTIONS[] actions)` Advances the forward model using the actions supplied.
`void`	`buildStringLevel(java.lang.String[] levelString, int randomSeed)`
`ForwardModel`	`copy()` Creates a copy of this forward model.
`java.util.ArrayList<Types.ACTIONS>`	`getAvatarActions(boolean includeNIL)` Returns the actions that are available in this game for the avatar.
`java.util.ArrayList<Types.ACTIONS>`	`getAvatarActions(int playerID, boolean includeNIL)` Method overloaded for multi player games.
`int`	`getAvatarHealthPoints()` Returns the health points of the avatar.
`int`	`getAvatarHealthPoints(int playerID)` Method overloaded for multi player games.
`Types.ACTIONS`	`getAvatarLastAction()` Returns the avatar's last move.
`Types.ACTIONS`	`getAvatarLastAction(int playerID)` Method overloaded for multi player games.
`int`	`getAvatarLimitHealthPoints()` Returns the limit of health points this avatar can have.
`int`	`getAvatarLimitHealthPoints(int playerID)` Method overloaded for multi player games.
`int`	`getAvatarMaxHealthPoints()` Returns the maximum amount of health points.
`int`	`getAvatarMaxHealthPoints(int playerID)` Method overloaded for multi player games.
`Vector2d`	`getAvatarOrientation()` Returns the orientation of the avatar.
`Vector2d`	`getAvatarOrientation(int playerID)` Method overloaded for multi player games.
`Vector2d`	`getAvatarPosition()` Returns the position of the avatar.
`Vector2d`	`getAvatarPosition(int playerID)` Method overloaded for multi player games.
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getAvatarResources()` Returns the resources in the avatar's possession.
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getAvatarResources(int playerID)` Method overloaded for multi player games.
`double`	`getAvatarSpeed()` Returns the speed of the avatar.
`double`	`getAvatarSpeed(int playerID)` Method overloaded for multi player games.
`int`	`getAvatarType()` Returns the avatar's type.
`int`	`getAvatarType(int playerID)` Method overloaded for multi player games.
`java.util.TreeSet<Event>`	`getEventsHistory()` Returns the list of historic events happened in this game so far.
`java.util.ArrayList<Observation>[]`	`getFromAvatarSpPositions(Vector2d refPosition)` Returns a list of observations of objects created by the avatar's actions.
`double`	`getGameScore()` Gets the game score of this state.
`double`	`getGameScore(int playerID)` Method overloaded for multi player games.
`int`	`getGameTick()` Gets the current game tick of this particular state.
`Types.WINNER`	`getGameWinner()` Indicates if there is a game winner in the current observation.
`java.util.ArrayList<Observation>[]`	`getImmovablePositions(Vector2d refPosition)` Observations of static objects in the game.
`java.util.ArrayList<Observation>[]`	`getMovablePositions(Vector2d refPosition)` Returns a list with observations of sprites that move, but are NOT NPCs.
`Types.WINNER[]`	`getMultiGameWinner()` Method overloaded for multi player games.
`int`	`getNoPlayers()` Method used to access the number of players in a game.
`java.util.ArrayList<Observation>[]`	`getNPCPositions(Vector2d refPosition)` Returns a list of observations of NPC in the game.
`java.util.ArrayList<Observation>[][]`	`getObservationGrid()` Returns a grid with all observations in the level.
`java.util.ArrayList<Observation>[]`	`getPortalsPositions(Vector2d refPosition)`
`java.util.Random`	`getRandomGenerator()` Returns the sampleRandom generator of this forward model.
`java.util.ArrayList<Observation>[]`	`getResourcesPositions(Vector2d refPosition)`
`java.awt.Dimension`	`getWorldDimension()` Returns the world dimensions, in pixels.
`boolean`	`isAvatarAlive()` Returns true if the avatar is alive
`boolean`	`isAvatarAlive(int playerID)` Method overloaded for multi player games, returns true if the avatar is still alive.
`boolean`	`isGameOver()` Indicates if the game is over or if it hasn't finished yet.
`boolean`	`isMultiGameOver()` Indicates if the game is over or if it hasn't finished yet.
`void`	`printObservationGrid()` Prints the observation grid.
`void`	`removeSpriteObservation(VGDLSprite sprite)` Removes an sprite observation.
`void`	`setNewSeed(int seed)` Sets a new seed for the forward model's random generator (creates a new object)
`protected void`	`tick()` Performs one tick for the game, calling update(this) in all sprites.
`void`	`update(Game a_gameState)` Dumps the game state into 'this' object.
`protected void`	`updateAvatars(Types.ACTIONS action, int playerID)` Calls update(this) in avatar sprites.

Methods inherited from class core.game.Game
_updateCollisionDict, abort, addShield, addSprite, addSprite, addSprite, addSprite, addTimeEffect, buildLevel, changeSpriteOrder, checkTimeOut, clearAll, clearInteractionTerminationData, createAvatars, disqualify, disqualify, eventHandling, getAvatar, getAvatar, getAvatars, getBlockSize, getCharMapping, getCollisionEffects, getDefinedEffects, getDefinedEosEffects, getEosEffects, getFullResult, getInteractionData, getMaxSprites, getMultiWinner, getNoCounters, getNumDisabledSprites, getNumSprites, getObservation, getObservationMulti, getParameters, getPath, getResourceColor, getResourceLimit, getScore, getScore, getScreenSize, getSpriteData, getSpriteGroup, getSpriteOrder, getSprites, getSubSpritesGroup, getSubTypes, getTempAvatar, getTerminationData, getTerminations, getValueCounter, getWinner, getWinner, handleResult, initForwardModel, initMulti, initSprites, killSprite, loadDefaultConstr, parseParameters, playGame, playOnlineGame, printLearningResult, printResult, reset, reverseDirection, runGame, setAvatar, setAvatar, setAvatarLastAction, setAvatarLastAction, setCharMapping, setParameters, setStochastic, terminationHandling

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

- Constructor Detail
  - ForwardModel
```
public ForwardModel(Game a_gameState,
                    int playerID)
```
    Constructor for StateObservation. Initializes everything
    
    Parameters:
    
    a_gameState -
- Method Detail
  - update
```
public final void update(Game a_gameState)
```
    Dumps the game state into 'this' object. Effectively, creates a state observation from a game state (of class Game).
    
    Parameters:
    
    a_gameState - game to take the state from.
  - removeSpriteObservation
```
public final void removeSpriteObservation(VGDLSprite sprite)
```
    Removes an sprite observation.
    
    Parameters:
    
    sprite - sprite to remove.
  - printObservationGrid
```
public void printObservationGrid()
```
    Prints the observation grid. For debug only.
  - getRandomGenerator
```
public final java.util.Random getRandomGenerator()
```
    Returns the sampleRandom generator of this forward model. It is not the same as the sampleRandom number generator of the main game copy.
    
    Overrides:
    
    getRandomGenerator in class Game
    
    Returns:
    
    the sampleRandom generator of this forward model.
  - setNewSeed
```
public void setNewSeed(int seed)
```
    Sets a new seed for the forward model's random generator (creates a new object)
    
    Parameters:
    
    seed - the new seed.
  - getNoPlayers
```
public int getNoPlayers()
```
    Method used to access the number of players in a game.
    
    Overrides:
    
    getNoPlayers in class Game
    
    Returns:
    
    number of players.
  - updateAvatars
```
protected void updateAvatars(Types.ACTIONS action,
                             int playerID)
```
    Calls update(this) in avatar sprites. It uses the action received as the action of the avatar. Doesn't update disabled avatars.
    
    Parameters:
    
    action - Action to be performed by the avatar for this game tick.
  - tick
```
protected void tick()
```
    Performs one tick for the game, calling update(this) in all sprites. It follows the same order of update calls as in the real game (inverse spriteOrder[]). Doesn't update disabled sprites.
    
    Overrides:
    
    tick in class Game
  - advance
```
public final void advance(Types.ACTIONS action)
```
    Advances the forward model using the action supplied.
    
    Parameters:
    
    action -
  - advance
```
public final void advance(Types.ACTIONS[] actions)
```
    Advances the forward model using the actions supplied.
    
    Parameters:
    
    actions - array of actions of all players (index in array corresponds to playerID).
  - copy
```
public final ForwardModel copy()
```
    Creates a copy of this forward model.
    
    Returns:
    
    the copy of this forward model.
  - getGameScore
```
public double getGameScore()
```
    Gets the game score of this state.
    
    Returns:
    
    the game score.
  - getGameScore
```
public double getGameScore(int playerID)
```
    Method overloaded for multi player games. Gets the game score of a particular player (identified by playerID).
    
    Parameters:
    
    playerID - ID of the player to query.
    
    Returns:
    
    the game score.
  - getGameTick
```
public int getGameTick()
```
    Gets the current game tick of this particular state.
    
    Overrides:
    
    getGameTick in class Game
    
    Returns:
    
    the game tick of the current game state.
  - getGameWinner
```
public Types.WINNER getGameWinner()
```
    Indicates if there is a game winner in the current observation. Possible values are Types.WINNER.PLAYER_WINS, Types.WINNER.PLAYER_LOSES and Types.WINNER.NO_WINNER.
    
    Returns:
    
    the winner of the game.
  - getMultiGameWinner
```
public Types.WINNER[] getMultiGameWinner()
```
    Method overloaded for multi player games. Indicates if there is a game winner in the current observation. Possible values are Types.WINNER.PLAYER_WINS, Types.WINNER.PLAYER_LOSES and Types.WINNER.NO_WINNER.
    
    Returns:
    
    the winner of the game.
  - isGameOver
```
public boolean isGameOver()
```
    Indicates if the game is over or if it hasn't finished yet.
    
    Specified by:
    
    isGameOver in class Game
    
    Returns:
    
    true if the game is over.
  - isMultiGameOver
```
public boolean isMultiGameOver()
```
    Indicates if the game is over or if it hasn't finished yet.
    
    Returns:
    
    true if the game is over.
  - getWorldDimension
```
public java.awt.Dimension getWorldDimension()
```
    Returns the world dimensions, in pixels.
    
    Returns:
    
    the world dimensions, in pixels.
  - getAvatarPosition
```
public Vector2d getAvatarPosition()
```
    Returns the position of the avatar. If the game is finished, we cannot guarantee that this position reflects the real position of the avatar (the avatar itself could be destroyed). If game finished, this returns Types.NIL.
    
    Returns:
    
    position of the avatar, or Types.NIL if game is over.
  - getAvatarPosition
```
public Vector2d getAvatarPosition(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarSpeed
```
public double getAvatarSpeed()
```
    Returns the speed of the avatar. If the game is finished, we cannot guarantee that this speed reflects the real speed of the avatar (the avatar itself could be destroyed). If game finished, this returns 0.
    
    Returns:
    
    orientation of the avatar, or 0 if game is over.
  - getAvatarSpeed
```
public double getAvatarSpeed(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarOrientation
```
public Vector2d getAvatarOrientation()
```
    Returns the orientation of the avatar. If the game is finished, we cannot guarantee that this orientation reflects the real orientation of the avatar (the avatar itself could be destroyed). If game finished, this returns Types.NIL.
    
    Returns:
    
    orientation of the avatar, or Types.NIL if game is over.
  - getAvatarOrientation
```
public Vector2d getAvatarOrientation(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarActions
```
public java.util.ArrayList<Types.ACTIONS> getAvatarActions(boolean includeNIL)
```
    Returns the actions that are available in this game for the avatar. If the parameter 'includeNIL' is true, the array contains the (always available) NIL action. If it is false, this is equivalent to calling getAvailableActions().
    
    Parameters:
    
    includeNIL - true to include Types.ACTIONS.ACTION_NIL in the array of actions.
    
    Returns:
    
    the available actions.
  - getAvatarActions
```
public java.util.ArrayList<Types.ACTIONS> getAvatarActions(int playerID,
                                                           boolean includeNIL)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarResources
```
public java.util.HashMap<java.lang.Integer,java.lang.Integer> getAvatarResources()
```
    Returns the resources in the avatar's possession. As there can be resources of different nature, each entry is a key-value pair where the key is the resource ID, and the value is the amount of that resource type owned. It should be assumed that there might be other resources available in the game, but the avatar could have none of them. If the avatar has no resources, an empty HashMap is returned.
    
    Returns:
    
    resources owned by the avatar.
  - getAvatarResources
```
public java.util.HashMap<java.lang.Integer,java.lang.Integer> getAvatarResources(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarLastAction
```
public Types.ACTIONS getAvatarLastAction()
```
    Returns the avatar's last move. At the first game cycle, it returns ACTION_NIL. Note that this may NOT be the same as the last action given by the agent, as it may have overspent in the last game cycle.
    
    Returns:
    
    the action that was executed in the real game in the last cycle. ACTION_NIL is returned in the very first game step.
  - getAvatarLastAction
```
public Types.ACTIONS getAvatarLastAction(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarType
```
public int getAvatarType()
```
    Returns the avatar's type. In case it has multiple types, it returns the most specific one.
    
    Returns:
    
    the itype of the avatar.
  - getAvatarType
```
public int getAvatarType(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarHealthPoints
```
public int getAvatarHealthPoints()
```
    Returns the health points of the avatar. A value of 0 doesn't necessarily mean that the avatar is dead (could be that no health points are in use in that game).
    
    Returns:
    
    a numeric value, the amount of remaining health points.
  - getAvatarHealthPoints
```
public int getAvatarHealthPoints(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarMaxHealthPoints
```
public int getAvatarMaxHealthPoints()
```
    Returns the maximum amount of health points.
    
    Returns:
    
    the maximum amount of health points the avatar can have.
  - getAvatarMaxHealthPoints
```
public int getAvatarMaxHealthPoints(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getAvatarLimitHealthPoints
```
public int getAvatarLimitHealthPoints()
```
    Returns the limit of health points this avatar can have.
    
    Returns:
    
    the limit of health points the avatar can have.
  - getAvatarLimitHealthPoints
```
public int getAvatarLimitHealthPoints(int playerID)
```
    Method overloaded for multi player games.
    
    Parameters:
    
    playerID - ID of the player to query.
  - isAvatarAlive
```
public boolean isAvatarAlive()
```
    Returns true if the avatar is alive
    
    Returns:
    
    true if the avatar is alive
  - isAvatarAlive
```
public boolean isAvatarAlive(int playerID)
```
    Method overloaded for multi player games, returns true if the avatar is still alive.
    
    Parameters:
    
    playerID - ID of the player to query.
  - getObservationGrid
```
public java.util.ArrayList<Observation>[][] getObservationGrid()
```
    Returns a grid with all observations in the level.
    
    Returns:
    
    the grid of observations
  - getEventsHistory
```
public java.util.TreeSet<Event> getEventsHistory()
```
    Returns the list of historic events happened in this game so far.
    
    Returns:
    
    list of historic events happened in this game so far.
  - getNPCPositions
```
public java.util.ArrayList<Observation>[] getNPCPositions(Vector2d refPosition)
```
    Returns a list of observations of NPC in the game. As there can be NPCs of different type, each entry in the array corresponds to a sprite type. Every ArrayList contains a list of objects of type Observation, ordered asc. by distance to the avatar. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Parameters:
    
    refPosition - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    Observations of NPCs in the game.
  - getImmovablePositions
```
public java.util.ArrayList<Observation>[] getImmovablePositions(Vector2d refPosition)
```
    Observations of static objects in the game.
    
    Parameters:
    
    refPosition - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    a list with the observations of static objects in the game..
  - getMovablePositions
```
public java.util.ArrayList<Observation>[] getMovablePositions(Vector2d refPosition)
```
    Returns a list with observations of sprites that move, but are NOT NPCs.
    
    Parameters:
    
    refPosition - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    a list with observations of sprites that move, but are NOT NPCs.
  - getResourcesPositions
```
public java.util.ArrayList<Observation>[] getResourcesPositions(Vector2d refPosition)
```
  - getPortalsPositions
```
public java.util.ArrayList<Observation>[] getPortalsPositions(Vector2d refPosition)
```
  - getFromAvatarSpPositions
```
public java.util.ArrayList<Observation>[] getFromAvatarSpPositions(Vector2d refPosition)
```
    Returns a list of observations of objects created by the avatar's actions.
    
    Parameters:
    
    refPosition - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    a list with observations of sprites.
  - buildStringLevel
```
public void buildStringLevel(java.lang.String[] levelString,
                             int randomSeed)
```
    Specified by:
    
    buildStringLevel in class Game

Class ForwardModel

Nested Class Summary

Nested classes/interfaces inherited from class core.game.Game

Field Summary

Fields inherited from class core.game.Game

Constructor Summary

Method Summary

Methods inherited from class core.game.Game

Methods inherited from class java.lang.Object

Constructor Detail

ForwardModel

Method Detail

update

removeSpriteObservation

printObservationGrid

getRandomGenerator

setNewSeed

getNoPlayers

updateAvatars

tick

advance

advance

copy

getGameScore

getGameScore

getGameTick

getGameWinner

getMultiGameWinner

isGameOver

isMultiGameOver

getWorldDimension

getAvatarPosition

getAvatarPosition

getAvatarSpeed

getAvatarSpeed

getAvatarOrientation

getAvatarOrientation

getAvatarActions

getAvatarActions

getAvatarResources

getAvatarResources

getAvatarLastAction

getAvatarLastAction

getAvatarType

getAvatarType

getAvatarHealthPoints

getAvatarHealthPoints

getAvatarMaxHealthPoints

getAvatarMaxHealthPoints

getAvatarLimitHealthPoints

getAvatarLimitHealthPoints

isAvatarAlive

isAvatarAlive

getObservationGrid

getEventsHistory

getNPCPositions

getImmovablePositions

getMovablePositions

getResourcesPositions

getPortalsPositions

getFromAvatarSpPositions

buildStringLevel