rle.simple
Class SimpleWorld

java.lang.Object
  rle.core.vm.PlugInBase
      rle.simple.SimpleWorld

All Implemented Interfaces:

PlugIn, World

public class SimpleWorld
extends PlugInBase
implements World

Class that represents the highest level data of the player environment. A single instance of this class will typically exist.

Field Summary

protected java.util.HashMap<java.lang.String,java.lang.Object>

attributes

Fields inherited from class rle.core.vm.PlugInBase

config, context, parameters

Constructor Summary

SimpleWorld()

Method Summary

java.util.Set<java.lang.String>	attributeKeySet() The set of keys for which attributes have been mapped.
Board	createBoard(java.lang.String id, CreationContext cc) Create a new board.
java.lang.String	createBoardId() Generate an unused board id.
Board	findBoard(java.lang.String id) Retrieve the board of the given id.
java.lang.Object	getAttribute(java.lang.String key) Retrieve the value mapped to key, or null if no such mapping exists.
void	initialize() Initialize this world for a new game.
void	putAttribute(java.lang.String key, java.lang.Object value) Map a value to an attribute.
void	removeAttribute(java.lang.String key) Remove a mapping.

Methods inherited from class rle.core.vm.PlugInBase

config, getContext, getParameters, paramMap, setConfig, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface rle.core.vm.PlugIn

config, getContext, paramMap, setConfig, setParameters

Field Detail

attributes

protected java.util.HashMap<java.lang.String,java.lang.Object> attributes

Constructor Detail

SimpleWorld

public SimpleWorld()

Method Detail

findBoard

public Board findBoard(java.lang.String id)

Retrieve the board of the given id. For now this always returns null.

Specified by:

findBoard in interface World

createBoard

public Board createBoard(java.lang.String id,
                         CreationContext cc)

Create a new board. Uses the BoardCreationContext hints:

 board-path - Variant Mgr path to board plug-in
 builder-path - path to BoardBuilder plug-in
 

Specified by:

createBoard in interface World

createBoardId

public java.lang.String createBoardId()

Generate an unused board id.

Specified by:

createBoardId in interface World

initialize

public void initialize()

Initialize this world for a new game.

Specified by:

initialize in interface World

attributeKeySet

public java.util.Set<java.lang.String> attributeKeySet()

The set of keys for which attributes have been mapped.

Specified by:

attributeKeySet in interface World

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Retrieve the value mapped to key, or null if no such mapping exists.

Specified by:

getAttribute in interface World

putAttribute

public void putAttribute(java.lang.String key,
                         java.lang.Object value)

Map a value to an attribute.

Specified by:

putAttribute in interface World

removeAttribute

public void removeAttribute(java.lang.String key)

Remove a mapping.

Specified by:

removeAttribute in interface World