FrostbiteDomain

java.lang.Object
- burlap.domain.singleagent.frostbite.FrostbiteDomain

All Implemented Interfaces:

DomainGenerator
```
public class FrostbiteDomain
extends java.lang.Object
implements DomainGenerator
```
A simplified version of the classic Atari Frostbite domain. In this game, the agent must jump between different ice blocks. Each time the agent jumps on an ice block, it adds a layer to an igloo that is being built and "activates" all ice blocks on the same row. Jumping on an activated ice block does not ad a layer to the igloo. Once all rows of ice blocks are activated, they reset and can be activated by jumping on them again. Once the igloo is built, the agent can go to it to win the game. If the agent jumps or walks into the water, the game is over.
If you run the main method of this class, it will launch of a visual explorer that you can play. They keys w,s,a,d,x correspond to the actions jump north, jump south, move west, move east, do nothing.

Author:

Phillipe Morere

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`FrostbiteDomain.IglooBuiltPF`
`class`	`FrostbiteDomain.InWaterPF`
`class`	`FrostbiteDomain.OnIcePF`
`class`	`FrostbiteDomain.OnPlatformPF`
`class`	`FrostbiteDomain.PlatformActivePF`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTION_EAST` Constant for the name of the east action
`static java.lang.String`	`ACTION_IDLE` Constant for the name of the west action
`static java.lang.String`	`ACTION_NORTH` Constant for the name of the north action
`static java.lang.String`	`ACTION_SOUTH` Constant for the name of the south action
`static java.lang.String`	`ACTION_WEST` Constant for the name of the west action
`static java.lang.String`	`CLASS_AGENT` Constant for the name of the agent OO-MDP class
`static java.lang.String`	`CLASS_IGLOO` Constant for the name of the igloo OO-MDP class
`static java.lang.String`	`CLASS_PLATFORM` Constant for the name of the obstacle OO-MDP class
`static java.lang.String`	`PF_IGLOO_BUILT` Constant for the name of the propositional function "igloo is built"
`static java.lang.String`	`PF_IN_WATER` Constant for the name of the propositional function "agent is in water"
`static java.lang.String`	`PF_ON_ICE` Constant for the name of the propositional function "agent is on ice"
`static java.lang.String`	`PF_ON_PLATFORM` Constant for the name of the propositional function "agent is on platform"
`static java.lang.String`	`PF_PLATFORM_ACTIVE` Constant for the name of the propositional function "platform is active"
`protected RewardFunction`	`rf`
`protected int`	`scale` Constant to adjust the scale of the game
`protected TerminalFunction`	`tf`
`static java.lang.String`	`VAR_ACTIVATED` Constant for the name of the activated status of a platform
`static java.lang.String`	`VAR_BUILDING` Constant for the name of the building step of the igloo
`static java.lang.String`	`VAR_HEIGHT` Attribute name for height
`static java.lang.String`	`VAR_SIZE` Constant for the name of the size of a frozen platform
`static java.lang.String`	`VAR_X` Constant for the name of the x position attribute.
`static java.lang.String`	`VAR_Y` Constant for the name of the y position attribute.

Constructor Summary

Constructors
Constructor and Description

FrostbiteDomain()

Constructors
Constructor and Description
`FrostbiteDomain()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OOSADomain`	`generateDomain()` Creates a new frostbite domain.
`java.util.List<PropositionalFunction>`	`generatePFs()`
`RewardFunction`	`getRf()`
`int`	`getScale()`
`TerminalFunction`	`getTf()`
`static void`	`main(java.lang.String[] args)` Main function to test the domain.
`void`	`setRf(RewardFunction rf)`
`void`	`setScale(int scale)`
`void`	`setTf(TerminalFunction tf)`

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
```
    Constant for the name of the x position attribute.
    
    See Also:
    
    Constant Field Values
  - VAR_Y
```
public static final java.lang.String VAR_Y
```
    Constant for the name of the y position attribute.
    
    See Also:
    
    Constant Field Values
  - VAR_HEIGHT
```
public static final java.lang.String VAR_HEIGHT
```
    Attribute name for height
    
    See Also:
    
    Constant Field Values
  - VAR_SIZE
```
public static final java.lang.String VAR_SIZE
```
    Constant for the name of the size of a frozen platform
    
    See Also:
    
    Constant Field Values
  - VAR_BUILDING
```
public static final java.lang.String VAR_BUILDING
```
    Constant for the name of the building step of the igloo
    
    See Also:
    
    Constant Field Values
  - VAR_ACTIVATED
```
public static final java.lang.String VAR_ACTIVATED
```
    Constant for the name of the activated status of a platform
    
    See Also:
    
    Constant Field Values
  - CLASS_AGENT
```
public static final java.lang.String CLASS_AGENT
```
    Constant for the name of the agent OO-MDP class
    
    See Also:
    
    Constant Field Values
  - CLASS_IGLOO
```
public static final java.lang.String CLASS_IGLOO
```
    Constant for the name of the igloo OO-MDP class
    
    See Also:
    
    Constant Field Values
  - CLASS_PLATFORM
```
public static final java.lang.String CLASS_PLATFORM
```
    Constant for the name of the obstacle OO-MDP class
    
    See Also:
    
    Constant Field Values
  - ACTION_NORTH
```
public static final java.lang.String ACTION_NORTH
```
    Constant for the name of the north action
    
    See Also:
    
    Constant Field Values
  - ACTION_SOUTH
```
public static final java.lang.String ACTION_SOUTH
```
    Constant for the name of the south action
    
    See Also:
    
    Constant Field Values
  - ACTION_EAST
```
public static final java.lang.String ACTION_EAST
```
    Constant for the name of the east action
    
    See Also:
    
    Constant Field Values
  - ACTION_WEST
```
public static final java.lang.String ACTION_WEST
```
    Constant for the name of the west action
    
    See Also:
    
    Constant Field Values
  - ACTION_IDLE
```
public static final java.lang.String ACTION_IDLE
```
    Constant for the name of the west action
    
    See Also:
    
    Constant Field Values
  - PF_ON_PLATFORM
```
public static final java.lang.String PF_ON_PLATFORM
```
    Constant for the name of the propositional function "agent is on platform"
    
    See Also:
    
    Constant Field Values
  - PF_PLATFORM_ACTIVE
```
public static final java.lang.String PF_PLATFORM_ACTIVE
```
    Constant for the name of the propositional function "platform is active"
    
    See Also:
    
    Constant Field Values
  - PF_ON_ICE
```
public static final java.lang.String PF_ON_ICE
```
    Constant for the name of the propositional function "agent is on ice"
    
    See Also:
    
    Constant Field Values
  - PF_IGLOO_BUILT
```
public static final java.lang.String PF_IGLOO_BUILT
```
    Constant for the name of the propositional function "igloo is built"
    
    See Also:
    
    Constant Field Values
  - PF_IN_WATER
```
public static final java.lang.String PF_IN_WATER
```
    Constant for the name of the propositional function "agent is in water"
    
    See Also:
    
    Constant Field Values
  - scale
```
protected int scale
```
    Constant to adjust the scale of the game
  - rf
```
protected RewardFunction rf
```
  - tf
```
protected TerminalFunction tf
```
- Constructor Detail
  - FrostbiteDomain
```
public FrostbiteDomain()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Main function to test the domain. Note: The termination conditions are not checked when testing the domain this way, which means it is impossible to win or die and might trigger bugs. To enable them, uncomment the code in the "update" function.
    
    Parameters:
    
    args - command line args
  - getTf
```
public TerminalFunction getTf()
```
  - setTf
```
public void setTf(TerminalFunction tf)
```
  - getRf
```
public RewardFunction getRf()
```
  - setRf
```
public void setRf(RewardFunction rf)
```
  - getScale
```
public int getScale()
```
  - setScale
```
public void setScale(int scale)
```
  - generatePFs
```
public java.util.List<PropositionalFunction> generatePFs()
```
  - generateDomain
```
public OOSADomain generateDomain()
```
    Creates a new frostbite domain.
    
    Specified by:
    
    generateDomain in interface DomainGenerator
    
    Returns:
    
    the generated domain object

Class FrostbiteDomain

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VAR_X

VAR_Y

VAR_HEIGHT

VAR_SIZE

VAR_BUILDING

VAR_ACTIVATED

CLASS_AGENT

CLASS_IGLOO

CLASS_PLATFORM

ACTION_NORTH

ACTION_SOUTH

ACTION_EAST

ACTION_WEST

ACTION_IDLE

PF_ON_PLATFORM

PF_PLATFORM_ACTIVE

PF_ON_ICE

PF_IGLOO_BUILT

PF_IN_WATER

scale

rf

tf

Constructor Detail

FrostbiteDomain

Method Detail

main

getTf

setTf

getRf

setRf

getScale

setScale

generatePFs

generateDomain