com.planet_ink.coffee_mud.Libraries
Class MUDHelp

java.lang.Object
  com.planet_ink.coffee_mud.Libraries.StdLibrary
      com.planet_ink.coffee_mud.Libraries.MUDHelp

All Implemented Interfaces:

CMObject, CMLibrary, HelpLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class MUDHelp
extends StdLibrary
implements HelpLibrary

Constructor Summary

MUDHelp()

Method Summary

void	addHelpEntry(java.lang.String ID, java.lang.String text, boolean archon)
java.lang.String	fixHelp(java.lang.String tag, java.lang.String str, MOB forMOB)
java.lang.String	getActualUsage(Ability A, int which, MOB forMOB)
java.util.Properties	getArcHelpFile()
java.util.Properties	getHelpFile()
java.lang.StringBuffer	getHelpList(java.lang.String helpStr, java.util.Properties rHelpFile1, java.util.Properties rHelpFile2, MOB forMOB)
java.lang.StringBuffer	getHelpText(java.lang.String helpStr, MOB forMOB, boolean favorAHelp)
java.lang.StringBuffer	getHelpText(java.lang.String helpStr, java.util.Properties rHelpFile, MOB forMOB)
java.lang.StringBuffer	getHelpText(java.lang.String helpStr, java.util.Properties rHelpFile, MOB forMOB, boolean noFix)
java.util.Vector	getTopics(boolean archonHelp, boolean standardHelp)
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isPlayerSkill(java.lang.String helpStr)
boolean	shutdown()
protected DVector	suspiciousTags(java.util.Properties p)
void	unloadHelpFile(MOB mob)

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, 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

activate, 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

MUDHelp

public MUDHelp()

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

isPlayerSkill

public boolean isPlayerSkill(java.lang.String helpStr)

Specified by:

isPlayerSkill in interface HelpLibrary

getHelpText

public java.lang.StringBuffer getHelpText(java.lang.String helpStr,
                                          MOB forMOB,
                                          boolean favorAHelp)

Specified by:

getHelpText in interface HelpLibrary

getTopics

public java.util.Vector getTopics(boolean archonHelp,
                                  boolean standardHelp)

Specified by:

getTopics in interface HelpLibrary

getActualUsage

public java.lang.String getActualUsage(Ability A,
                                       int which,
                                       MOB forMOB)

Specified by:

getActualUsage in interface HelpLibrary

addHelpEntry

public void addHelpEntry(java.lang.String ID,
                         java.lang.String text,
                         boolean archon)

Specified by:

addHelpEntry in interface HelpLibrary

fixHelp

public java.lang.String fixHelp(java.lang.String tag,
                                java.lang.String str,
                                MOB forMOB)

Specified by:

fixHelp in interface HelpLibrary

getHelpText

public java.lang.StringBuffer getHelpText(java.lang.String helpStr,
                                          java.util.Properties rHelpFile,
                                          MOB forMOB)

Specified by:

getHelpText in interface HelpLibrary

getHelpText

public java.lang.StringBuffer getHelpText(java.lang.String helpStr,
                                          java.util.Properties rHelpFile,
                                          MOB forMOB,
                                          boolean noFix)

getHelpList

public java.lang.StringBuffer getHelpList(java.lang.String helpStr,
                                          java.util.Properties rHelpFile1,
                                          java.util.Properties rHelpFile2,
                                          MOB forMOB)

Specified by:

getHelpList in interface HelpLibrary

getArcHelpFile

public java.util.Properties getArcHelpFile()

Specified by:

getArcHelpFile in interface HelpLibrary

suspiciousTags

protected DVector suspiciousTags(java.util.Properties p)

getHelpFile

public java.util.Properties getHelpFile()

Specified by:

getHelpFile in interface HelpLibrary

shutdown

public boolean shutdown()

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

unloadHelpFile

public void unloadHelpFile(MOB mob)

Specified by:

unloadHelpFile in interface HelpLibrary