com.planet_ink.coffee_mud.Libraries.interfaces
Interface HelpLibrary

All Superinterfaces:

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

All Known Implementing Classes:

MUDHelp

public interface HelpLibrary
extends CMLibrary

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.util.Vector	getTopics(boolean archonHelp, boolean standardHelp)
boolean	isPlayerSkill(java.lang.String helpStr)
void	unloadHelpFile(MOB mob)

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getSupportThread, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getHelpText

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

getTopics

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

getActualUsage

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

fixHelp

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

getHelpText

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

getHelpList

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

getArcHelpFile

java.util.Properties getArcHelpFile()

getHelpFile

java.util.Properties getHelpFile()

unloadHelpFile

void unloadHelpFile(MOB mob)

isPlayerSkill

boolean isPlayerSkill(java.lang.String helpStr)

addHelpEntry

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