com.sun.sgs.example.hack.server.level

Interface Level

All Superinterfaces:

com.sun.sgs.app.ManagedObject

All Known Implementing Classes:

SimpleLevel

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

This interface represents a single level in a Dungeon.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_PREFIX The standard name prefix for all levels.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCharacter(CharacterManager mgr) Adds a character to this level at some random point.
boolean	addCharacter(CharacterManager mgr, int startX, int startY) Adds a character to this level at the given location.
void	addItem(Item item) Adds an item to this level at some random position.
void	addItem(Item item, int startX, int startY) Adds an item to this level at the given position.
Board	getBoardSnapshot() Returns a snapshot (ie, static) view of the level.
String	getName() Returns the name of this level.
boolean	move(CharacterManager mgr, KeyMessages.Type direction) Tries to move the given character in the given direction
void	removeCharacter(CharacterManager mgr) Removes a character from the level.
boolean	take(CharacterManager mgr) Tries to take items at the character's current location.

Field Detail

NAME_PREFIX

static final String NAME_PREFIX

The standard name prefix for all levels.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of this level.

Returns:

the name

addCharacter

void addCharacter(CharacterManager mgr)

Adds a character to this level at some random point.

Parameters:

mgrRef - a reference to the CharacterManager who's Character is joining this Level

addCharacter

boolean addCharacter(CharacterManager mgr,
                   int startX,
                   int startY)

Adds a character to this level at the given location.

Parameters:

mgrRef - a reference to the CharacterManager who's Character is joining this Level

startX - the starting x-coordinate

startY - the starting y-coordinate

Returns:

true upon success, otherwise false

removeCharacter

void removeCharacter(CharacterManager mgr)

Removes a character from the level. This is typically only called when a character wants to remove itself directly (eg, they were killed, or quit back to the lobby). Otherwise, characters are removed naturally through other actions (like movement).

Parameters:

mgrRef - a reference to the CharacterManager who's Character is joining this Level

addItem

void addItem(Item item)

Adds an item to this level at some random position.

Parameters:

itemRef - a reference to the Item

addItem

void addItem(Item item,
           int startX,
           int startY)

Adds an item to this level at the given position.

Parameters:

itemRef - a reference to the Item

startX - the starting x-coordinate

startY - the starting y-coordinate

getBoardSnapshot

Board getBoardSnapshot()

Returns a snapshot (ie, static) view of the level.

Returns:

a snapshot of the board

move

boolean move(CharacterManager mgr,
           KeyMessages.Type direction)

Tries to move the given character in the given direction

Parameters:

mgr - the manager for the Character that is trying to move

direction - the direction in which the character wants to move

Returns:

true if we moved in the requested direction, false otherwise

take

boolean take(CharacterManager mgr)

Tries to take items at the character's current location.

Parameters:

mgr - the manager for the Character that is trying to take the items

Returns:

true if we took something, false otherwise