com.planet_ink.coffee_mud.Libraries
Class MUDPercolator

java.lang.Object
  extended by com.planet_ink.coffee_mud.Libraries.StdLibrary
      extended by com.planet_ink.coffee_mud.Libraries.MUDPercolator
All Implemented Interfaces:
CMObject, AreaGenerationLibrary, CMLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class MUDPercolator
extends StdLibrary
implements AreaGenerationLibrary


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.AreaGenerationLibrary
AreaGenerationLibrary.LayoutManager, AreaGenerationLibrary.LayoutNode
 
Constructor Summary
MUDPercolator()
           
 
Method Summary
 boolean activate()
           
 Area buildArea(XMLLibrary.XMLpiece piece, java.util.Hashtable defined, int direction)
           
 void buildDefinedTagSet(java.util.Vector xmlRoot, java.util.Hashtable defined)
           
 Room buildRoom(XMLLibrary.XMLpiece piece, java.util.Hashtable defined, int direction)
           
 void checkRequirements(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
           
 java.util.Vector findItems(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
           
 java.util.Vector findMobs(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
           
 java.lang.String findString(java.lang.String tagName, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
           
 AreaGenerationLibrary.LayoutManager getLayoutManager(java.lang.String named)
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 boolean shutdown()
           
 
Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
compareTo, copyOf, getSupportThread, initializeClass, newInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
getSupportThread
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

MUDPercolator

public MUDPercolator()
Method Detail

ID

public java.lang.String ID()
Description copied from interface: CMObject
The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:
ID in interface CMObject
Overrides:
ID in class StdLibrary
Returns:
the name of this class

getLayoutManager

public AreaGenerationLibrary.LayoutManager getLayoutManager(java.lang.String named)
Specified by:
getLayoutManager in interface AreaGenerationLibrary

buildDefinedTagSet

public void buildDefinedTagSet(java.util.Vector xmlRoot,
                               java.util.Hashtable defined)
Specified by:
buildDefinedTagSet in interface AreaGenerationLibrary

activate

public boolean activate()
Specified by:
activate in interface CMLibrary
Overrides:
activate in class StdLibrary

shutdown

public boolean shutdown()
Specified by:
shutdown in interface CMLibrary
Overrides:
shutdown in class StdLibrary

buildRoom

public Room buildRoom(XMLLibrary.XMLpiece piece,
                      java.util.Hashtable defined,
                      int direction)
               throws CMException
Specified by:
buildRoom in interface AreaGenerationLibrary
Throws:
CMException

buildArea

public Area buildArea(XMLLibrary.XMLpiece piece,
                      java.util.Hashtable defined,
                      int direction)
               throws CMException
Specified by:
buildArea in interface AreaGenerationLibrary
Throws:
CMException

findMobs

public java.util.Vector findMobs(XMLLibrary.XMLpiece piece,
                                 java.util.Hashtable defined)
                          throws CMException
Specified by:
findMobs in interface AreaGenerationLibrary
Throws:
CMException

findItems

public java.util.Vector findItems(XMLLibrary.XMLpiece piece,
                                  java.util.Hashtable defined)
                           throws CMException
Specified by:
findItems in interface AreaGenerationLibrary
Throws:
CMException

findString

public java.lang.String findString(java.lang.String tagName,
                                   XMLLibrary.XMLpiece piece,
                                   java.util.Hashtable defined)
                            throws CMException
Specified by:
findString in interface AreaGenerationLibrary
Throws:
CMException

checkRequirements

public void checkRequirements(XMLLibrary.XMLpiece piece,
                              java.util.Hashtable defined)
                       throws CMException
Specified by:
checkRequirements in interface AreaGenerationLibrary
Throws:
CMException