io.nadron.app

Interface Game

All Known Implementing Classes:

SimpleGame

public interface Game

This interface abstracts a game domain object. Each game deployed in the server should implement this interface.

Author:

Abraham Menacherry

Method Summary

Methods

Modifier and Type	Method and Description
GameCommandInterpreter	getGameCommandInterpreter() Each game requires a different set of game commands.
String	getGameName() Get the name of the game.
Object	getId()
void	setGameCommandInterpreter(GameCommandInterpreter interpreter) Set the interpreter associated with this game.
void	setGameName(String gameName) Set the name of the game.
void	setId(Object id)
Object	unload() Unloads the current game, by closing all sessions.

Method Detail

getId

Object getId()

Returns:

Returns the unique id associated with this game object.

setId

void setId(Object id)

Parameters:

id - Sets the unique id for this game.

getGameName

String getGameName()

Get the name of the game. Preferably should be a unique name.

Returns:

Returns the name of the game.

setGameName

void setGameName(String gameName)

Set the name of the game. Preferably it should be a unique value.

Parameters:

gameName - Set the preferably unique game name.

getGameCommandInterpreter

GameCommandInterpreter getGameCommandInterpreter()

Each game requires a different set of game commands. This method will set the interpreter which will convert these commands to method calls.

Returns:

The associated GameCommandInterpreter instance.

setGameCommandInterpreter

void setGameCommandInterpreter(GameCommandInterpreter interpreter)

Set the interpreter associated with this game. This method will be used if the creation of the interpreter is outside of the implementing game room instance, say by a Game instance or set by the spring container.

Parameters:

interpreter - The interpreter instance to set.

unload

Object unload()

Unloads the current game, by closing all sessions. This will delegate to GameRoom.close()

Returns:

In case of Netty Implementation it would return a collection of ChannelFuture object.