Package com.planet_ink.coffee_mud.Libraries.layouts

Class ApartmentLayout

java.lang.Object

com.planet_ink.coffee_mud.Libraries.layouts.AbstractLayout

com.planet_ink.coffee_mud.Libraries.layouts.ApartmentLayout

All Implemented Interfaces:

AreaGenerationLibrary.LayoutManager

public class ApartmentLayout
extends AbstractLayout

Constructor Summary

Constructors

Constructor	Description
ApartmentLayout()

Method Summary

Modifier and Type	Method	Description
java.util.List<AreaGenerationLibrary.LayoutNode>	generate(int num, int dir)	Generates a list of layout nodes, each of which reprents a single room in the area.
java.lang.String	name()	The name of the layout manager
void	setRunFromDirection(AreaGenerationLibrary.LayoutNode node, int dir)

Methods inherited from class com.planet_ink.coffee_mud.Libraries.layouts.AbstractLayout

diff, getDirection, getRunDirection

Methods inherited from class java.lang.Object

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

Constructor Detail

ApartmentLayout

public ApartmentLayout()

Method Detail

name

public java.lang.String name()

Description copied from interface: AreaGenerationLibrary.LayoutManager

The name of the layout manager

Specified by:

name in interface AreaGenerationLibrary.LayoutManager

Specified by:

name in class AbstractLayout

Returns:

name of the layout manager

setRunFromDirection

public void setRunFromDirection(AreaGenerationLibrary.LayoutNode node,
                                int dir)

generate

public java.util.List<AreaGenerationLibrary.LayoutNode> generate(int num,
                                                                 int dir)

Description copied from interface: AreaGenerationLibrary.LayoutManager

Generates a list of layout nodes, each of which reprents a single room in the area. The first node is always the entry room, which is entered from the direction given to this method.

Specified by:

generate in interface AreaGenerationLibrary.LayoutManager

Specified by:

generate in class AbstractLayout

Parameters:

num - the number of nodes to generate

dir - the direction of entry into this group of nodes.

Returns:

a list of layout nodes

See Also:

AreaGenerationLibrary.LayoutNode