core.game

Class GameDescription

java.lang.Object

core.game.GameDescription

public class GameDescription
extends java.lang.Object

This is an abstract class encapsulating all the data required for generating and testing game levels.

Author:

Ahmed A Khalifa

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameDescription.InteractionData Simple data class represents the interaction between game sprites
static class	GameDescription.SpriteData Simple data class represents all game sprites
static class	GameDescription.TerminationData Simple data class represents all game termination conditions

Constructor Summary

Constructors

Constructor and Description
GameDescription(Game currentGame) Constructor to the Game Description.

Method Summary

Modifier and Type	Method and Description
void	enableLogger(boolean value) Disable/Enable the logger
java.util.ArrayList<GameDescription.SpriteData>	getAllSpriteData() Get all defined game sprites
java.util.ArrayList<Types.ACTIONS>	getAvailableActions(boolean includeNIL) Get player supported actions
java.util.ArrayList<GameDescription.SpriteData>	getAvatar() Get avatar sprite data information
java.util.ArrayList<Message>	getErrors() get list of errors from the system
java.util.ArrayList<GameDescription.InteractionData>	getInteraction(java.lang.String stype1, java.lang.String stype2) Get a list of all effects happening to the first sprite
java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>>	getLevelMapping() Get default character mapping
java.util.ArrayList<GameDescription.SpriteData>	getMoving() Get all movable sprites
java.util.ArrayList<GameDescription.SpriteData>	getNPC() Get NPCs sprite data information
java.util.ArrayList<GameDescription.SpriteData>	getPortal() Get Portals sprite data information
java.util.ArrayList<GameDescription.SpriteData>	getResource() Get Resources sprite data information
java.util.ArrayList<GameDescription.SpriteData>	getStatic() Get Statics sprite data information
java.util.ArrayList<GameDescription.TerminationData>	getTerminationConditions() Get a list of all termination conditions for the current game
java.util.ArrayList<Message>	getWarnings() get list of warnings from the system
void	reset(Game currentGame) Reset the game description object and assign new game object
StateObservation	testLevel(java.lang.String level) Build the generated level to be tested using an agent using the original Level Mapping.
StateObservation	testLevel(java.lang.String level, java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> charMapping) Build the generated level to be tested using an agent.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameDescription

public GameDescription(Game currentGame)

Constructor to the Game Description. It initialize all the data using the passed game object.

Parameters:

currentGame - The current running game object.

Method Detail

reset

public void reset(Game currentGame)

Reset the game description object and assign new game object

Parameters:

currentGame - new game object assigned

testLevel

public StateObservation testLevel(java.lang.String level)

Build the generated level to be tested using an agent using the original Level Mapping.

Parameters:

level - a string of characters that are supplied in the character mapping

Returns:

StateObservation object that can be used to simulate the game. return null when there is errors

testLevel

public StateObservation testLevel(java.lang.String level,
                                  java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> charMapping)

Build the generated level to be tested using an agent. You should call this version if you are using your own character mapping

Parameters:

level - a string of characters that are supplied in the character mapping

Returns:

StateObservation object that can be used to simulate the game. return null when there is errors

enableLogger

public void enableLogger(boolean value)

Disable/Enable the logger

Parameters:

value - enable or disable

getErrors

public java.util.ArrayList<Message> getErrors()

get list of errors from the system

Returns:

a list of errors

getWarnings

public java.util.ArrayList<Message> getWarnings()

get list of warnings from the system

Returns:

a list of warning

getAvailableActions

public java.util.ArrayList<Types.ACTIONS> getAvailableActions(boolean includeNIL)

Get player supported actions

Parameters:

includeNIL - boolean to identify if the NIL action should exists in the supported actions

Returns:

list of all player supported actions

getAvatar

public java.util.ArrayList<GameDescription.SpriteData> getAvatar()

Get avatar sprite data information

Returns:

avatar's sprite data

getNPC

public java.util.ArrayList<GameDescription.SpriteData> getNPC()

Get NPCs sprite data information

Returns:

array of sprite data

getStatic

public java.util.ArrayList<GameDescription.SpriteData> getStatic()

Get Statics sprite data information

Returns:

array of sprite data

getResource

public java.util.ArrayList<GameDescription.SpriteData> getResource()

Get Resources sprite data information

Returns:

array of sprite data

getPortal

public java.util.ArrayList<GameDescription.SpriteData> getPortal()

Get Portals sprite data information

Returns:

array of sprite data

getMoving

public java.util.ArrayList<GameDescription.SpriteData> getMoving()

Get all movable sprites

Returns:

arary of sprite data

getAllSpriteData

public java.util.ArrayList<GameDescription.SpriteData> getAllSpriteData()

Get all defined game sprites

Returns:

an array of sprite data

getInteraction

public java.util.ArrayList<GameDescription.InteractionData> getInteraction(java.lang.String stype1,
                                                                           java.lang.String stype2)

Get a list of all effects happening to the first sprite

Parameters:

stype1 - the sprite name of the first sprite in the collision

stype2 - the sprite name of the second sprite in the collision

Returns:

an array of all possible effects. If there is no effects, an empty array is returned

getTerminationConditions

public java.util.ArrayList<GameDescription.TerminationData> getTerminationConditions()

Get a list of all termination conditions for the current game

Returns:

an array of termination data objects

getLevelMapping

public java.util.HashMap<java.lang.Character,java.util.ArrayList<java.lang.String>> getLevelMapping()

Get default character mapping

Returns:

hashmap of level characters and their corresponding sprites