com.sun.sgs.example.hack.server

Interface Game

All Superinterfaces:

com.sun.sgs.app.ManagedObject

All Known Implementing Classes:

Creator, Dungeon, Lobby

public interface Game
extends com.sun.sgs.app.ManagedObject

This is the generic interface for a game. A game is a place where users can interact with each other and with the game's logic. Typically the games that players use are the Lobby or a Dungeon.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_PREFIX The standard namespace prefix for all games.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the name of this Game.
MessageHandler	join(Player player) Joins the given Player to this Game.
void	leave(Player player) Removes the given Player from this Game.
int	numPlayers() Returns the number of players in this Game.

Field Detail

NAME_PREFIX

static final String NAME_PREFIX

The standard namespace prefix for all games.

See Also:

Constant Field Values

Method Detail

join

MessageHandler join(Player player)

Joins the given Player to this Game. The player has been get-locked.

Parameters:

player - the Player joining this game

Returns:

the MessageHandler that will process the provided player's messages while they are joined to this game

leave

void leave(Player player)

Removes the given Player from this Game. The player has been get-locked.

Parameters:

player - the Player joining this game

getName

String getName()

Returns the name of this Game.

Returns:

the name

numPlayers

int numPlayers()

Returns the number of players in this Game.

Returns:

the player count