core.game

Class StateObservationMulti

java.lang.Object

core.game.StateObservation

core.game.StateObservationMulti

public class StateObservationMulti
extends StateObservation

Created by Raluca on 07-Apr-16.

Field Summary

Fields inherited from class core.game.StateObservation

currentGameState, model

Constructor Summary

Constructors

Constructor and Description
StateObservationMulti(ForwardModel a_model, int playerID) Constructor for StateObservation in multi player games.

Method Summary

Modifier and Type	Method and Description
void	advance(Types.ACTIONS[] actions) Method overloaded for multi player games.
StateObservationMulti	copy() Returns an exact copy of the state observation object.
boolean	equiv(java.lang.Object o) Method overwritten with multi player optimisations.
java.util.ArrayList<Types.ACTIONS>	getAvailableActions(int playerID) Method overloaded for multi player games.
int	getAvatarHealthPoints(int playerID) Method overloaded for multi player games.
Types.ACTIONS	getAvatarLastAction(int playerID) Method overloaded for multi player games.
int	getAvatarLimitHealthPoints(int playerID) Method overloaded for multi player games.
int	getAvatarMaxHealthPoints(int playerID) Method overloaded for multi player games.
Vector2d	getAvatarOrientation(int playerID) Method overloaded for multi player games.
Vector2d	getAvatarPosition(int playerID) Method overloaded for multi player games.
java.util.HashMap<java.lang.Integer,java.lang.Integer>	getAvatarResources(int playerID) Method overloaded for multi player games.
double	getAvatarSpeed(int playerID) Method overloaded for multi player games.
int	getAvatarType(int playerID) Method overloaded for multi player games.
double	getGameScore(int playerID) Method overloaded for multi player games.
Types.WINNER[]	getMultiGameWinner() Similar to getGameWinner() in single player games, but for multi player.
boolean	isAvatarAlive(int playerID) returns true if the avatar is alive.
boolean	isGameOver() Method overridden for multi player games.

Methods inherited from class core.game.StateObservation

advance, getAvailableActions, getAvailableActions, getAvatarHealthPoints, getAvatarLastAction, getAvatarLimitHealthPoints, getAvatarMaxHealthPoints, getAvatarOrientation, getAvatarPosition, getAvatarResources, getAvatarSpeed, getAvatarType, getBlockSize, getEventsHistory, getFromAvatarSpritesPositions, getFromAvatarSpritesPositions, getGameScore, getGameState, getGameTick, getGameWinner, getImmovablePositions, getImmovablePositions, getKeyHandler, getMovablePositions, getMovablePositions, getNoPlayers, getNPCPositions, getNPCPositions, getObservationGrid, getPortalsPositions, getPortalsPositions, getResourcesPositions, getResourcesPositions, getWorldDimension, isAvatarAlive, setNewSeed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StateObservationMulti

public StateObservationMulti(ForwardModel a_model,
                             int playerID)

Constructor for StateObservation in multi player games. Requires a forward model

Parameters:

a_model - forward model of the game.

Method Detail

advance

public void advance(Types.ACTIONS[] actions)

Method overloaded for multi player games. Now passes an array of actions for all players in the game, the index in the array corresponding to playerID. Advances the state using the action passed as the move of the agents. It updates all entities in the game. It modifies the object 'this' to represent the next state after the actions have been executed and all entities have moved.

Note: stochastic events will not be necessarily the same as in the real game.

Parameters:

actions - array of agent actions to execute in the next cycle for all players.

getAvailableActions

public java.util.ArrayList<Types.ACTIONS> getAvailableActions(int playerID)

Method overloaded for multi player games. Now passes the playerID. Returns the actions that are available in this game for the avatar.

Parameters:

playerID - ID of the player to query

Returns:

the available actions.

getGameScore

public double getGameScore(int playerID)

Method overloaded for multi player games. Now passes the playerID. Gets the score of the game at this observation.

Parameters:

playerID - ID of the player to query.

Returns:

score of the player with the corresponding playerID.

getMultiGameWinner

public Types.WINNER[] getMultiGameWinner()

Similar to getGameWinner() in single player games, but for multi player. Now returns an array of type Types.WINNER and length as the number of players in the game. The index corresponds to a playerID, so the state of which player can be checked by accessing the element in this array with the right index. Indicates if there is a game winner in the current observation. Possible values in the array are Types.WINNER.PLAYER_WINS, Types.WINNER.PLAYER_LOSES and Types.WINNER.NO_WINNER.

Returns:

array of type Types.WINNER, length of number of players in the game.

isGameOver

public boolean isGameOver()

Method overridden for multi player games. Indicates if the game is over or if it hasn't finished yet.

Overrides:

isGameOver in class StateObservation

Returns:

true if the game is over.

getAvatarPosition

public Vector2d getAvatarPosition(int playerID)

Method overloaded for multi player games. Now passes the player ID. 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.

Parameters:

playerID - ID of the player to query.

Returns:

position of the avatar, or Types.NIL if game is over.

getAvatarSpeed

public double getAvatarSpeed(int playerID)

Method overloaded for multi player games. Now passes the player ID. 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.

Parameters:

playerID - ID of the player to query.

Returns:

orientation of the avatar, or 0 if game is over.

getAvatarOrientation

public Vector2d getAvatarOrientation(int playerID)

Method overloaded for multi player games. Now passes the player ID. 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.

Parameters:

playerID - ID of the player to query.

Returns:

orientation of the avatar, or Types.NIL if game is over.

getAvatarResources

public java.util.HashMap<java.lang.Integer,java.lang.Integer> getAvatarResources(int playerID)

Method overloaded for multi player games. Now passes the player ID. 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.

Parameters:

playerID - ID of the player to query.

Returns:

resources owned by the avatar.

getAvatarLastAction

public Types.ACTIONS getAvatarLastAction(int playerID)

Method overloaded for multi player games. Now passes the player ID. 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.

Parameters:

playerID - ID of the player to query.

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(int playerID)

Method overloaded for multi player games. Now passes the player ID. Returns the avatar's type. In case it has multiple types, it returns the most specific one.

Parameters:

playerID - ID of the player to query.

Returns:

the itype of the avatar.

getAvatarHealthPoints

public int getAvatarHealthPoints(int playerID)

Method overloaded for multi player games. Now passes the player ID. 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).

Parameters:

playerID - ID of the player to query.

Returns:

a numeric value, the amount of remaining health points.

getAvatarMaxHealthPoints

public int getAvatarMaxHealthPoints(int playerID)

Method overloaded for multi player games. Now passes the player ID. Returns the maximum amount of health points.

Parameters:

playerID - ID of the player to query.

Returns:

the maximum amount of health points the avatar ever had.

getAvatarLimitHealthPoints

public int getAvatarLimitHealthPoints(int playerID)

Method overloaded for multi player games. Now passes the player ID. Returns the limit of health points this avatar can have.

Parameters:

playerID - ID of the player to query.

Returns:

the limit of health points the avatar can have.

isAvatarAlive

public boolean isAvatarAlive(int playerID)

returns true if the avatar is alive.

Returns:

true if the avatar is alive.

copy

public StateObservationMulti copy()

Description copied from class: StateObservation

Returns an exact copy of the state observation object.

Overrides:

copy in class StateObservation

Returns:

a copy of the state observation.

equiv

public boolean equiv(java.lang.Object o)

Method overwritten with multi player optimisations.

Overrides:

equiv in class StateObservation

Parameters:

o - Object to compare this to.

Returns:

true if o has the same components as this.