org.frogx.service.api
Interface MultiUserGame


public interface MultiUserGame

A MultiUserGame provides information about the implemented game and handles MUGMatch instances.

Author:
Günther Nieß

Method Summary
 MUGMatch createMatch(MUGRoom room)
          Create a match which implements the game logic within a game room.
 void destroyMatch(MUGRoom room)
          Destroy the match in the specified game room.
 java.lang.String getCategory()
          Get the category of the game e.g. board, cards, etc.
 java.lang.String getDescription()
          Get the human readable description of the game.
 java.lang.String getNamespace()
          Gets the xml namespace of the implemented game which can be discovered.
 

Method Detail

getNamespace

java.lang.String getNamespace()
Gets the xml namespace of the implemented game which can be discovered.

Returns:
the namespace of the game.

getDescription

java.lang.String getDescription()
Get the human readable description of the game.

Returns:
the human readable description of the game.

getCategory

java.lang.String getCategory()
Get the category of the game e.g. board, cards, etc.

Returns:
the category of the game.

createMatch

MUGMatch createMatch(MUGRoom room)
Create a match which implements the game logic within a game room.

Parameters:
room - The MUGRoom which offers the match.
Returns:
The created MUGMatch.

destroyMatch

void destroyMatch(MUGRoom room)
Destroy the match in the specified game room.

Parameters:
room - The MUGRoom which hosts the match.


Copyright © 2009. All Rights Reserved.