StateObservation

java.lang.Object
- core.game.StateObservation

Direct Known Subclasses:

StateObservationMulti
```
public class StateObservation
extends java.lang.Object
```
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

Field Summary

Fields
Modifier and Type	Field and Description
`Types.GAMESTATES`	`currentGameState` Field to represent the current game's state.
`protected ForwardModel`	`model` This is the model of the game, used to apply an action and get to the next state.

Constructor Summary

Constructors
Constructor and Description

StateObservation(ForwardModel a_model, int playerID)
Constructor for StateObservation.

Constructors
Constructor and Description
`StateObservation(ForwardModel a_model, 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 state using the action passed as the move of the agent.
`StateObservation`	`copy()` Returns an exact copy of the state observation object.
`boolean`	`equiv(java.lang.Object o)` Compares if this and the received StateObservation state are equivalent.
`java.util.ArrayList<Types.ACTIONS>`	`getAvailableActions()` Returns the actions that are available in this game for the avatar.
`java.util.ArrayList<Types.ACTIONS>`	`getAvailableActions(boolean includeNIL)` Returns the actions that are available in this game for the avatar.
`int`	`getAvatarHealthPoints()` Returns the health points of the avatar.
`Types.ACTIONS`	`getAvatarLastAction()` Returns the avatar's last move.
`int`	`getAvatarLimitHealthPoints()` Returns the limit of health points this avatar can have.
`int`	`getAvatarMaxHealthPoints()` Returns the maximum amount of health points.
`Vector2d`	`getAvatarOrientation()` Returns the orientation of the avatar.
`Vector2d`	`getAvatarPosition()` Returns the position of the avatar.
`java.util.HashMap<java.lang.Integer,java.lang.Integer>`	`getAvatarResources()` Returns the resources in the avatar's possession.
`double`	`getAvatarSpeed()` Returns the speed of the avatar.
`int`	`getAvatarType()` Returns the avatar's type.
`int`	`getBlockSize()` Indicates how many pixels form a block in the game.
`java.util.TreeSet<Event>`	`getEventsHistory()` This method retrieves a list of events that happened so far in the game.
`java.util.ArrayList<Observation>[]`	`getFromAvatarSpritesPositions()` Returns a list of observations of sprites created by the avatar (usually, by applying the action Types.ACTIONS.ACTION_USE).
`java.util.ArrayList<Observation>[]`	`getFromAvatarSpritesPositions(Vector2d reference)` Returns a list of observations of sprites created by the avatar (usually, by applying the action Types.ACTIONS.ACTION_USE).
`double`	`getGameScore()` Gets the score of the game at this observation.
`Types.GAMESTATES`	`getGameState()` Return the current state of the game
`int`	`getGameTick()` Returns the game tick of this particular observation.
`Types.WINNER`	`getGameWinner()` Indicates if there is a game winner in the current observation.
`java.util.ArrayList<Observation>[]`	`getImmovablePositions()` Returns a list of observations of immovable sprites in the game.
`java.util.ArrayList<Observation>[]`	`getImmovablePositions(Vector2d reference)` Returns a list of observations of immovable sprites in the game.
`KeyHandler`	`getKeyHandler(int playerID)` Returns key handler available to the player.
`java.util.ArrayList<Observation>[]`	`getMovablePositions()` Returns a list of observations of sprites that move, but are NOT NPCs in the game.
`java.util.ArrayList<Observation>[]`	`getMovablePositions(Vector2d reference)` Returns a list of observations of movable (not NPCs) sprites in the game.
`int`	`getNoPlayers()` Returns the number of players in the game.
`java.util.ArrayList<Observation>[]`	`getNPCPositions()` Returns a list of observations of NPC in the game.
`java.util.ArrayList<Observation>[]`	`getNPCPositions(Vector2d reference)` Returns a list of observations of NPC in the game.
`java.util.ArrayList<Observation>[][]`	`getObservationGrid()` Returns a grid with all observations in the level, accessible by the x,y coordinates of the grid.
`java.util.ArrayList<Observation>[]`	`getPortalsPositions()` Returns a list of observations of portals in the game.
`java.util.ArrayList<Observation>[]`	`getPortalsPositions(Vector2d reference)` Returns a list of observations of portals in the game.
`java.util.ArrayList<Observation>[]`	`getResourcesPositions()` Returns a list of observations of resources in the game.
`java.util.ArrayList<Observation>[]`	`getResourcesPositions(Vector2d reference)` Returns a list of observations of resources in the game.
`java.awt.Dimension`	`getWorldDimension()` Returns the world dimensions, in pixels.
`boolean`	`isAvatarAlive()` returns true if the avatar is alive.
`boolean`	`isGameOver()` Indicates if the game is over or if it hasn't finished yet.
`void`	`setNewSeed(int seed)` Sets a new seed for the forward model's random generator (creates a new object)

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

- Field Detail
  - model
```
protected ForwardModel model
```
    This is the model of the game, used to apply an action and get to the next state. This model MUST NOT be public.
  - currentGameState
```
public Types.GAMESTATES currentGameState
```
    Field to represent the current game's state.
- Constructor Detail
  - StateObservation
```
public StateObservation(ForwardModel a_model,
                        int playerID)
```
    Constructor for StateObservation. Requires a forward model
    
    Parameters:
    
    a_model - forward model of the game.
- Method Detail
  - copy
```
public StateObservation copy()
```
    Returns an exact copy of the state observation object.
    
    Returns:
    
    a copy of the state observation.
  - advance
```
public void advance(Types.ACTIONS action)
```
    Advances the state using the action passed as the move of the agent. It updates all entities in the game. It modifies the object 'this' to represent the next state after the action has been executed and all entities have moved.
    Note: stochastic events will not be necessarily the same as in the real game.
    
    Parameters:
    
    action - agent action to execute in the next cycle.
  - 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.
  - getGameState
```
public Types.GAMESTATES getGameState()
```
    Return the current state of the game
    
    Returns:
    
    current state of the game as a GAMESTATES type.
  - getAvailableActions
```
public java.util.ArrayList<Types.ACTIONS> getAvailableActions()
```
    Returns the actions that are available in this game for the avatar.
    
    Returns:
    
    the available actions.
  - getAvailableActions
```
public java.util.ArrayList<Types.ACTIONS> getAvailableActions(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.
  - getNoPlayers
```
public int getNoPlayers()
```
    Returns the number of players in the game.
  - getGameScore
```
public double getGameScore()
```
    Gets the score of the game at this observation.
    
    Returns:
    
    score of the game.
  - getGameTick
```
public int getGameTick()
```
    Returns the game tick of this particular observation.
    
    Returns:
    
    the game tick.
  - 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.
  - isGameOver
```
public boolean isGameOver()
```
    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.
  - getBlockSize
```
public int getBlockSize()
```
    Indicates how many pixels form a block in the game.
    
    Returns:
    
    how many pixels form a block in the game.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - getAvatarMaxHealthPoints
```
public int getAvatarMaxHealthPoints()
```
    Returns the maximum amount of health points.
    
    Returns:
    
    the maximum amount of health points the avatar ever had.
  - getAvatarLimitHealthPoints
```
public int getAvatarLimitHealthPoints()
```
    Returns the limit of health points this avatar can have.
    
    Returns:
    
    the limit of health points the avatar can have.
  - isAvatarAlive
```
public boolean isAvatarAlive()
```
    returns true if the avatar is alive.
    
    Returns:
    
    true if the avatar is alive.
  - getObservationGrid
```
public java.util.ArrayList<Observation>[][] getObservationGrid()
```
    Returns a grid with all observations in the level, accessible by the x,y coordinates of the grid. Each grid cell has a width and height of getBlockSize() pixels. Each cell contains a list with all observations in that position. Note that the same observation may occupy more than one grid cell.
    
    Returns:
    
    the grid of observations
  - getEventsHistory
```
public java.util.TreeSet<Event> getEventsHistory()
```
    This method retrieves a list of events that happened so far in the game. In this context, events are collisions of the avatar with other sprites in the game. Additionally, the list also contains information about collisions of a sprite created by the avatar (usually by using the action Types.ACTIONS.ACTION_USE) with other sprites. The list is ordered asc. by game step.
    
    Returns:
    
    list of events triggered by the avatar or sprites it created.
  - getNPCPositions
```
public java.util.ArrayList<Observation>[] getNPCPositions()
```
    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. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Returns:
    
    Observations of NPCs in the game.
  - getNPCPositions
```
public java.util.ArrayList<Observation>[] getNPCPositions(Vector2d reference)
```
    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 reference passed. Each Observation holds the position, sprite type id and sprite id of that particular sprite.
    
    Parameters:
    
    reference - 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()
```
    Returns a list of observations of immovable sprites in the game. As there can be immovable sprites of different type, each entry in the array corresponds to a sprite type. Every ArrayList contains a list of objects of type Observation. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Returns:
    
    Observations of immovable sprites in the game.
  - getImmovablePositions
```
public java.util.ArrayList<Observation>[] getImmovablePositions(Vector2d reference)
```
    Returns a list of observations of immovable sprites in the game. As there can be immovable sprites 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 reference passed. Each Observation holds the position, sprite type id and sprite id of that particular sprite.
    
    Parameters:
    
    reference - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    Observations of immovable sprites in the game.
  - getMovablePositions
```
public java.util.ArrayList<Observation>[] getMovablePositions()
```
    Returns a list of observations of sprites that move, but are NOT NPCs in the game. As there can be movable sprites of different type, each entry in the array corresponds to a sprite type. Every ArrayList contains a list of objects of type Observation. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Returns:
    
    Observations of movable, not NPCs, sprites in the game.
  - getMovablePositions
```
public java.util.ArrayList<Observation>[] getMovablePositions(Vector2d reference)
```
    Returns a list of observations of movable (not NPCs) sprites in the game. As there can be movable (not NPCs) sprites 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 reference passed. Each Observation holds the position, sprite type id and sprite id of that particular sprite.
    
    Parameters:
    
    reference - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    Observations of movable (not NPCs) sprites in the game.
  - getResourcesPositions
```
public java.util.ArrayList<Observation>[] getResourcesPositions()
```
    Returns a list of observations of resources in the game. As there can be resources of different type, each entry in the array corresponds to a sprite type. Every ArrayList contains a list of objects of type Observation. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Returns:
    
    Observations of resources in the game.
  - getResourcesPositions
```
public java.util.ArrayList<Observation>[] getResourcesPositions(Vector2d reference)
```
    Returns a list of observations of resources in the game. As there can be resources 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 reference passed. Each Observation holds the position, sprite type id and sprite id of that particular sprite.
    
    Parameters:
    
    reference - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    Observations of resources in the game.
  - getPortalsPositions
```
public java.util.ArrayList<Observation>[] getPortalsPositions()
```
    Returns a list of observations of portals in the game. As there can be portals of different type, each entry in the array corresponds to a sprite type. Every ArrayList contains a list of objects of type Observation. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Returns:
    
    Observations of portals in the game.
  - getPortalsPositions
```
public java.util.ArrayList<Observation>[] getPortalsPositions(Vector2d reference)
```
    Returns a list of observations of portals in the game. As there can be portals 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 reference passed. Each Observation holds the position, sprite type id and sprite id of that particular sprite.
    
    Parameters:
    
    reference - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    Observations of portals in the game.
  - getFromAvatarSpritesPositions
```
public java.util.ArrayList<Observation>[] getFromAvatarSpritesPositions()
```
    Returns a list of observations of sprites created by the avatar (usually, by applying the action Types.ACTIONS.ACTION_USE). As there can be sprites of different type, each entry in the array corresponds to a sprite type. Every ArrayList contains a list of objects of type Observation. Each Observation holds the position, unique id and sprite id of that particular sprite.
    
    Returns:
    
    Observations of sprites the avatar created.
  - getFromAvatarSpritesPositions
```
public java.util.ArrayList<Observation>[] getFromAvatarSpritesPositions(Vector2d reference)
```
    Returns a list of observations of sprites created by the avatar (usually, by applying the action Types.ACTIONS.ACTION_USE). As there can be sprites 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 reference passed. Each Observation holds the position, sprite type id and sprite id of that particular sprite.
    
    Parameters:
    
    reference - Reference position to use when sorting this array, by ascending distance to this point.
    
    Returns:
    
    Observations of sprites the avatar created.
  - getKeyHandler
```
public KeyHandler getKeyHandler(int playerID)
```
    Returns key handler available to the player.
    
    Parameters:
    
    playerID - ID of the player to query.
    
    Returns:
    
    KeyHandler object.
  - equiv
```
public boolean equiv(java.lang.Object o)
```
    Compares if this and the received StateObservation state are equivalent. DEBUG ONLY METHOD.
    
    Parameters:
    
    o - Object to compare this to.
    
    Returns:
    
    true if o has the same components as this.

Class StateObservation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

model

currentGameState

Constructor Detail

StateObservation

Method Detail

copy

advance

setNewSeed

getGameState

getAvailableActions

getAvailableActions

getNoPlayers

getGameScore

getGameTick

getGameWinner

isGameOver

getWorldDimension

getBlockSize

getAvatarPosition

getAvatarSpeed

getAvatarOrientation

getAvatarResources

getAvatarLastAction

getAvatarType

getAvatarHealthPoints

getAvatarMaxHealthPoints

getAvatarLimitHealthPoints

isAvatarAlive

getObservationGrid

getEventsHistory

getNPCPositions

getNPCPositions

getImmovablePositions

getImmovablePositions

getMovablePositions

getMovablePositions

getResourcesPositions

getResourcesPositions

getPortalsPositions

getPortalsPositions

getFromAvatarSpritesPositions

getFromAvatarSpritesPositions

getKeyHandler

equiv