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

Interface Tile

All Superinterfaces:

com.sun.sgs.app.ManagedObject, Serializable

All Known Implementing Classes:

BasicTile, ConnectorTile, ImpassableTile, PassableTile

public interface Tile
extends Serializable, com.sun.sgs.app.ManagedObject

This interface defines a single square on a board. It is used to maintain internal state about what's in a level. Instances of this interface are not a ManagedObjects because they are included as private state for other ManagedObjects.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCharacter(CharacterManager mgr) Adds the given character to this tile if possible.
boolean	addItem(Item item) Adds the given item to this tile if possible.
boolean	canOccupy(CharacterManager mgr) Returns whether or not this tile, in its current state, can be occupied by the given character.
int	getID() Returns the identifier for this tile.
int[]	getIdStack() Returns a stack of identifiers, specifying everything on this Tile.
LevelBoard.ActionResult	getItem(CharacterManager characterManager) Tries to take an item on this tile.
boolean	isPassable(CharacterManager mgr) Returns whether or not this space could be entered by the given character.
LevelBoard.ActionResult	moveTo(CharacterManager characterManager) Test to move the given character to this tile.
boolean	removeCharacter(CharacterManager mgrRef) Removes the given character from this tile, if and only if this character is already on this tile.
boolean	removeItem(Item item) Removes the given item from this tile, if and only if this item is already on this tile.

Method Detail

getID

int getID()

Returns the identifier for this tile. Typically this is the sprite identifier for this space on the board.

Returns:

the tile's identifier

getIdStack

int[] getIdStack()

Returns a stack of identifiers, specifying everything on this Tile. The the zeroeith index is always the same value as calling getID. If there is am item on this tile, it is in the next index, and if there is a character on this tile, it always appears last. There may be multiple items or characters on a tile, depending on implementation.

Returns:

the set of identifiers for the things at this space

isPassable

boolean isPassable(CharacterManager mgr)

Returns whether or not this space could be entered by the given character. Note that this only tests if the tile itself is passable. If there is a character or item on this space that would block access, it will still return true. If you want to test for the ability to actually move to the space in its current state, use canOccupy.

Parameters:

mgr - the manager for a character

Returns:

whether or not the tile is passable

canOccupy

boolean canOccupy(CharacterManager mgr)

Returns whether or not this tile, in its current state, can be occupied by the given character. This takes into account the passability of the tile as well as anything that might currently occupy it. If you just want a simple test for tile passability, use isPassable.

Parameters:

mgr - the manager for a character

Returns:

whether or not the character can occupy this tile

addCharacter

boolean addCharacter(CharacterManager mgr)

Adds the given character to this tile if possible.

Parameters:

mgr - the manager for a character

Returns:

whether or not the character was added successfully

removeCharacter

boolean removeCharacter(CharacterManager mgrRef)

Removes the given character from this tile, if and only if this character is already on this tile.

Parameters:

mgr - the manager for a character

Returns:

whether or not the character was removed successfully

addItem

boolean addItem(Item item)

Adds the given item to this tile if possible.

Parameters:

item - the manager for the item

Returns:

whether or not the item was added successfully

removeItem

boolean removeItem(Item item)

Removes the given item from this tile, if and only if this item is already on this tile.

Parameters:

item - the manager for the item

Returns:

whether or not the item was removed successfully

moveTo

LevelBoard.ActionResult moveTo(CharacterManager characterManager)

Test to move the given character to this tile. Note that this does not actually move the character, since doing so requires knowledge of the other tiles with which the character is interacting. This method does test that the move can be done, and does handle any interactions like moving the character to a new level or attacking another character.

Parameters:

characterManager - the manager for a character

Returns:

the result of making the move

getItem

LevelBoard.ActionResult getItem(CharacterManager characterManager)

Tries to take an item on this tile. Unlike moveTo, this actually will remove items from the tile if they are successfully taken.

Parameters:

characterManager - the manager for a character

Returns:

the result of getting an item