mstar
Class PathComponent

java.lang.Object
  |
  +--mstar.Exit
        |
        +--mstar.PathComponent

public class PathComponent

extends Exit

The PathComponent is used as part of the path finding routines in the MUD map. It represents a piece of a potential path that may result in a full path being located between two rooms in the collaborative environment.

Version:

1.6

Author:

Thaddeus O. Cooper (cooper@tweenproject.org)

See Also:

Serialized Form

Constructor Summary

PathComponent()
Creates an empty path component.

Method Summary

boolean	depthEquals(int depth) Determines if this depth is equal to the depth that is being checked.
int	getDepth() Gets the current search depth for this path.
void	setDepth(int depth) Sets the current search depth for this path.
java.lang.String	toString() Creates a String representation of this path component.

Methods inherited from class mstar.Exit

clearVisited, equal, getDirection, getExitName, getFromRoom, getToRoom, hasBeenVisited, isConfusing, setConfusing, setConfusing, setDirection, setExitName, setFromRoom, setToRoom, setVisited, setVisited

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PathComponent

public PathComponent()

Creates an empty path component.

Method Detail

setDepth

public void setDepth(int depth)

Sets the current search depth for this path.

Parameters:

depth - the current depth for the path search.

getDepth

public int getDepth()

Gets the current search depth for this path.

Returns:

the current depth for the path search.

depthEquals

public boolean depthEquals(int depth)

Determines if this depth is equal to the depth that is being checked.

Parameters:

depth - the depth to be checked.

Returns:

true if the depths are equal, false otherwise.

toString

public java.lang.String toString()

Creates a String representation of this path component.

Overrides:

toString in class Exit

Returns:

a String representation of this path component.