GridGame

java.lang.Object
- burlap.domain.stochasticgames.gridgame.GridGame

All Implemented Interfaces:

DomainGenerator
```
public class GridGame
extends java.lang.Object
implements DomainGenerator
```
The GridGame domain is much like the GridWorld domain, except for arbitrarily many agents in a stochastic game. Each agent in the world has an OO-MDP object instance of OO-MDP class "agent" which is defined by an x position, a y position, and a player number. Agents can either move north, south, east, west, or do nothing, therefore the game is symmetric for all agents. To get a standard SGAgentType to use with this game, use the getStandardGridGameAgentType(SGDomain) static method.
In this domain, there is also an OO-MDP object class for 1-dimensional walls (both for horizontal walls or vertical walls). Each wall can take on a different type; a solid wall that can never be passed (type 0), and a semi-wall, can be passed with some stochastic probability (type 1). Finally, there is also an OO-MDP class for goal locations, which also have different types. There is a type that can be indicated as a universal goal/reward location for all agents (type 0), and type that is only useful to each individual agent (type i is a personal goal for player i-1).
The JointModel set for the domain is GridGameStandardMechanics, with a default semi-wall probability of passing through of 0.5, which is changeable with the

Author:

James MacGlashan

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GridGame.GGJointRewardFunction` Specifies goal rewards and default rewards for agents.
`static class`	`GridGame.GGTerminalFunction` Causes termination when any agent reaches a personal or universal goal location.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTION_EAST` A constant for the name of the east action.
`static java.lang.String`	`ACTION_NOOP` A constant for the name of the no operation (do nothing) action.
`static java.lang.String`	`ACTION_NORTH` A constant for the name of the north action.
`static java.lang.String`	`ACTION_SOUTH` A constant for the name of the south action.
`static java.lang.String`	`ACTION_WEST` A constant for the name of the west action.
`static java.lang.String`	`CLASS_AGENT` A constant for the name of the agent class.
`static java.lang.String`	`CLASS_DIM_H_WALL` A constant for the name of the horizontal wall class.
`static java.lang.String`	`CLASS_DIM_V_WALL` A constant for the name of the vertical wall class.
`static java.lang.String`	`CLASS_GOAL` A constant for the name of the goal class.
`protected int`	`maxDim` The width and height of the world.
`protected int`	`maxGT` The number of goal types
`protected int`	`maxPlyrs` The maximum number of players that can be in the game
`protected int`	`maxWT` The number of wall types
`static java.lang.String`	`PF_IN_P_GOAL` A constant for the name of a propositional function that evaluates whether an agent is in a personal goal location for just them.
`static java.lang.String`	`PF_IN_U_GOAL` A constant for the name of a propositional function that evaluates whether an agent is in a universal goal location.
`protected double`	`semiWallProb` The probability that an agent will pass through a semi-wall.
`static java.lang.String`	`VAR_E1` A constant for the name of the first wall end position attribute.
`static java.lang.String`	`VAR_E2` A constant for the name of the second wall end position attribute.
`static java.lang.String`	`VAR_GT` A constant for the name of the goal type attribute.
`static java.lang.String`	`VAR_PN` A constant for the name of the player number attribute.
`static java.lang.String`	`VAR_POS` A constant for the name of the attribute for defining the walls position along its orthogonal direction.
`static java.lang.String`	`VAR_WT` A constant for the name of the wall type attribute.
`static java.lang.String`	`VAR_X` A constant for the name of the x position attribute
`static java.lang.String`	`VAR_Y` A constant for the name of the y position attribute

Constructor Summary

Constructors
Constructor and Description

GridGame()

Constructors
Constructor and Description
`GridGame()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OOSGDomain`	`generateDomain()` Returns a newly instanced Domain object
`static State`	`getCorrdinationGameInitialState()` Returns the initial state for a classic coordination game, where the agent's personal goals are on opposite sides.
`static State`	`getFriendFoeInitialState()` Returns the initial state for Friend Foe game.
`static State`	`getIncredibleInitialState()` Returns the initial state for the Incredible game (a game in which player 0 can give an incredible threat).
`int`	`getMaxDim()` Returns the maximum dimension of the world; it's width and height.
`int`	`getMaxGT()` Returns the maximum goal types
`int`	`getMaxPlyrs()` Returns the max number of players
`int`	`getMaxWT()` Returns the maximum number of wall types
`static State`	`getPrisonersDilemmaInitialState()` Returns the initial state for a classic prisoner's dilemma formulated in a Grid Game.
`double`	`getSemiWallProb()` Returns the probability that an agent can pass through a semi-wall.
`static State`	`getSimpleGameInitialState()` Returns the initial state for a simple game in which both players can win without interfering with one another.
`static SGAgentType`	`getStandardGridGameAgentType(SGDomain domain)` Creates and returns a standard `SGAgentType` for grid games.
`static State`	`getTurkeyInitialState()`
`static void`	`main(java.lang.String[] args)` Creates a visual explorer for a simple domain with two agents in it.
`static void`	`setBoundaryWalls(GenericOOState s, int w, int h)` /** Sets boundary walls of a domain.
`void`	`setMaxDim(int maxDim)` Sets the maximum dimension of the world; it's width and height.
`void`	`setMaxGT(int maxGT)` Sets the maximum goal types
`void`	`setMaxPlyrs(int maxPlyrs)` Sets the max number of players
`void`	`setMaxWT(int maxWT)` Sets the maximum number of wall types
`void`	`setSemiWallPassableProbability(double p)` Sets the probability that an agent can pass through a semi-wall.

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

- Field Detail
  - VAR_X
```
public static final java.lang.String VAR_X
```
    A constant for the name of the x position attribute
    
    See Also:
    
    Constant Field Values
  - VAR_Y
```
public static final java.lang.String VAR_Y
```
    A constant for the name of the y position attribute
    
    See Also:
    
    Constant Field Values
  - VAR_PN
```
public static final java.lang.String VAR_PN
```
    A constant for the name of the player number attribute. The first player number is 0.
    
    See Also:
    
    Constant Field Values
  - VAR_GT
```
public static final java.lang.String VAR_GT
```
    A constant for the name of the goal type attribute. Type 0 corresponds to a universal goal. Type i corresponds to a personal goal for player i-1.
    
    See Also:
    
    Constant Field Values
  - VAR_E1
```
public static final java.lang.String VAR_E1
```
    A constant for the name of the first wall end position attribute. For a horizontal wall, this attribute represents the left end point; for a vertical wall, the bottom end point.
    
    See Also:
    
    Constant Field Values
  - VAR_E2
```
public static final java.lang.String VAR_E2
```
    A constant for the name of the second wall end position attribute. For a horizontal wall, this attribute represents the right end point; for a vertical wall, the top end point.
    
    See Also:
    
    Constant Field Values
  - VAR_POS
```
public static final java.lang.String VAR_POS
```
    A constant for the name of the attribute for defining the walls position along its orthogonal direction. For a horizontal wall, this attribute represents the y position of the wall; for a vertical wall, the x position.
    
    See Also:
    
    Constant Field Values
  - VAR_WT
```
public static final java.lang.String VAR_WT
```
    A constant for the name of the wall type attribute.
    
    See Also:
    
    Constant Field Values
  - CLASS_AGENT
```
public static final java.lang.String CLASS_AGENT
```
    A constant for the name of the agent class.
    
    See Also:
    
    Constant Field Values
  - CLASS_GOAL
```
public static final java.lang.String CLASS_GOAL
```
    A constant for the name of the goal class.
    
    See Also:
    
    Constant Field Values
  - CLASS_DIM_H_WALL
```
public static final java.lang.String CLASS_DIM_H_WALL
```
    A constant for the name of the horizontal wall class.
    
    See Also:
    
    Constant Field Values
  - CLASS_DIM_V_WALL
```
public static final java.lang.String CLASS_DIM_V_WALL
```
    A constant for the name of the vertical wall class.
    
    See Also:
    
    Constant Field Values
  - ACTION_NORTH
```
public static final java.lang.String ACTION_NORTH
```
    A constant for the name of the north action.
    
    See Also:
    
    Constant Field Values
  - ACTION_SOUTH
```
public static final java.lang.String ACTION_SOUTH
```
    A constant for the name of the south action.
    
    See Also:
    
    Constant Field Values
  - ACTION_EAST
```
public static final java.lang.String ACTION_EAST
```
    A constant for the name of the east action.
    
    See Also:
    
    Constant Field Values
  - ACTION_WEST
```
public static final java.lang.String ACTION_WEST
```
    A constant for the name of the west action.
    
    See Also:
    
    Constant Field Values
  - ACTION_NOOP
```
public static final java.lang.String ACTION_NOOP
```
    A constant for the name of the no operation (do nothing) action.
    
    See Also:
    
    Constant Field Values
  - PF_IN_U_GOAL
```
public static final java.lang.String PF_IN_U_GOAL
```
    A constant for the name of a propositional function that evaluates whether an agent is in a universal goal location.
    
    See Also:
    
    Constant Field Values
  - PF_IN_P_GOAL
```
public static final java.lang.String PF_IN_P_GOAL
```
    A constant for the name of a propositional function that evaluates whether an agent is in a personal goal location for just them.
    
    See Also:
    
    Constant Field Values
  - maxDim
```
protected int maxDim
```
    The width and height of the world.
  - maxPlyrs
```
protected int maxPlyrs
```
    The maximum number of players that can be in the game
  - maxGT
```
protected int maxGT
```
    The number of goal types
  - maxWT
```
protected int maxWT
```
    The number of wall types
  - semiWallProb
```
protected double semiWallProb
```
    The probability that an agent will pass through a semi-wall.
- Constructor Detail
  - GridGame
```
public GridGame()
```
- Method Detail
  - getMaxDim
```
public int getMaxDim()
```
    Returns the maximum dimension of the world; it's width and height.
    
    Returns:
    
    the maximum dimension of the world; it's width and height.
  - setMaxDim
```
public void setMaxDim(int maxDim)
```
    Sets the maximum dimension of the world; it's width and height.
    
    Parameters:
    
    maxDim - the maximum dimension of the world; it's width and height.
  - getMaxPlyrs
```
public int getMaxPlyrs()
```
    Returns the max number of players
    
    Returns:
    
    the max number of players
  - setMaxPlyrs
```
public void setMaxPlyrs(int maxPlyrs)
```
    Sets the max number of players
    
    Parameters:
    
    maxPlyrs - the max number of players
  - getMaxGT
```
public int getMaxGT()
```
    Returns the maximum goal types
    
    Returns:
    
    the maximum goal types
  - setMaxGT
```
public void setMaxGT(int maxGT)
```
    Sets the maximum goal types
    
    Parameters:
    
    maxGT - the maximum goal types
  - getMaxWT
```
public int getMaxWT()
```
    Returns the maximum number of wall types
    
    Returns:
    
    the maximum number of wall types
  - setMaxWT
```
public void setMaxWT(int maxWT)
```
    Sets the maximum number of wall types
    
    Parameters:
    
    maxWT - the maximum number of wall types
  - setSemiWallPassableProbability
```
public void setSemiWallPassableProbability(double p)
```
    Sets the probability that an agent can pass through a semi-wall.
    
    Parameters:
    
    p - the probability that an agent will pass through a semi-wall.
  - getSemiWallProb
```
public double getSemiWallProb()
```
    Returns the probability that an agent can pass through a semi-wall.
    
    Returns:
    
    the probability that an agent can pass through a semi-wall.
  - generateDomain
```
public OOSGDomain generateDomain()
```
    Description copied from interface: DomainGenerator
    
    Returns a newly instanced Domain object
    
    Specified by:
    
    generateDomain in interface DomainGenerator
    
    Returns:
    
    the newly instantiated Domain object.
  - getSimpleGameInitialState
```
public static State getSimpleGameInitialState()
```
    Returns the initial state for a simple game in which both players can win without interfering with one another.
    
    Returns:
    
    the simple game initial state
  - getCorrdinationGameInitialState
```
public static State getCorrdinationGameInitialState()
```
    Returns the initial state for a classic coordination game, where the agent's personal goals are on opposite sides.
    
    Returns:
    
    the coordination game initial state
  - getPrisonersDilemmaInitialState
```
public static State getPrisonersDilemmaInitialState()
```
    Returns the initial state for a classic prisoner's dilemma formulated in a Grid Game.
    
    Returns:
    
    the grid game prisoner's dilemma initial state
  - getFriendFoeInitialState
```
public static State getFriendFoeInitialState()
```
    Returns the initial state for Friend Foe game.
    
    Returns:
    
    the initial state for Friend Foe
  - getIncredibleInitialState
```
public static State getIncredibleInitialState()
```
    Returns the initial state for the Incredible game (a game in which player 0 can give an incredible threat).
    
    Returns:
    
    the initial state for the Incredible game.
  - getTurkeyInitialState
```
public static State getTurkeyInitialState()
```
  - setBoundaryWalls
```
public static void setBoundaryWalls(GenericOOState s,
                                    int w,
                                    int h)
```
    /** Sets boundary walls of a domain. This method will add 4 solid walls (top left bottom right) to create a playing field in which the agents can interact.
    
    Parameters:
    
    s - the state in which the walls should be added
    
    w - the width of the playing field
    
    h - the height of the playing field
  - getStandardGridGameAgentType
```
public static SGAgentType getStandardGridGameAgentType(SGDomain domain)
```
    Creates and returns a standard SGAgentType for grid games. This SGAgentType is assigned the type name "agent", grid game OO-MDP object class for "agent", and has its action space set to all possible actions in the grid game domain. Typically, all agents in a grid game should be assigned to the same type.
    
    Parameters:
    
    domain - the domain object of the grid game.
    
    Returns:
    
    An SGAgentType that typically all SGAgent's of the grid game should play as.
  - main
```
public static void main(java.lang.String[] args)
```
    Creates a visual explorer for a simple domain with two agents in it. The w-a-s-d keys control the movement of the first agent; the i-k-j-l keys control the movement direction of the second agent. q sets the first agent to do nothing and u sets the second agent to do nothing. When the actions for both agents have been set, the actions can be committed to affect the world by pressing the c key.
    If "t" is passed as an argument then a terminal explorer is used instead.
    
    Parameters:
    
    args - command line args

Class GridGame

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VAR_X

VAR_Y

VAR_PN

VAR_GT

VAR_E1

VAR_E2

VAR_POS

VAR_WT

CLASS_AGENT

CLASS_GOAL

CLASS_DIM_H_WALL

CLASS_DIM_V_WALL

ACTION_NORTH

ACTION_SOUTH

ACTION_EAST

ACTION_WEST

ACTION_NOOP

PF_IN_U_GOAL

PF_IN_P_GOAL

maxDim

maxPlyrs

maxGT

maxWT

semiWallProb

Constructor Detail

GridGame

Method Detail

getMaxDim

setMaxDim

getMaxPlyrs

setMaxPlyrs

getMaxGT

setMaxGT

getMaxWT

setMaxWT

setSemiWallPassableProbability

getSemiWallProb

generateDomain

getSimpleGameInitialState

getCorrdinationGameInitialState

getPrisonersDilemmaInitialState

getFriendFoeInitialState

getIncredibleInitialState

getTurkeyInitialState

setBoundaryWalls

getStandardGridGameAgentType

main