rle.core
Interface World

All Superinterfaces:

PlugIn

All Known Implementing Classes:

SimpleWorld

public interface World
extends PlugIn

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

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 interface rle.core.vm.PlugIn

config, getContext, paramMap, setConfig, setParameters

Method Detail

findBoard

Board findBoard(java.lang.String id)

Retrieve the board of the given id.

createBoard

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

Create a new board.

createBoardId

java.lang.String createBoardId()

Generate an unused board id.

initialize

void initialize()

Initialize this world for a new game.

attributeKeySet

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

The set of keys for which attributes have been mapped.

getAttribute

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

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

putAttribute

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

Map a value to an attribute.

removeAttribute

void removeAttribute(java.lang.String key)

Remove a mapping.