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	getAbilityCostDesc(Ability A, MOB forMOB)
java.lang.String	getAbilityQualityDesc(Ability A)
java.lang.String	getAbilityRangeDesc(Ability A)
java.lang.String	getAbilityTargetDesc(Ability A)
java.lang.String	getActualAbilityUsageDesc(Ability A, int whichUsageCode, MOB forMOB) Returns a description of the amount of a particular cost is required by the given mob to use the given ability.
java.util.Properties	getArcHelpFile()
java.util.Properties	getHelpFile()
java.lang.StringBuilder	getHelpList(java.lang.String helpStr, java.util.Properties rHelpFile1, java.util.Properties rHelpFile2, MOB forMOB)
java.lang.StringBuilder	getHelpText(java.lang.String helpStr, MOB forMOB, boolean favorAHelp)
java.lang.StringBuilder	getHelpText(java.lang.String helpStr, MOB forMOB, boolean favorAHelp, boolean noFix)
java.lang.StringBuilder	getHelpText(java.lang.String helpStr, java.util.Properties rHelpFile, MOB forMOB)
java.lang.StringBuilder	getHelpText(java.lang.String helpStr, java.util.Properties rHelpFile, MOB forMOB, boolean noFix)
java.util.List<java.lang.String>	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, getServiceClient, L, propertiesLoaded, shutdown

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

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getTopics

java.util.List<java.lang.String> getTopics(boolean archonHelp,
                                           boolean standardHelp)

fixHelp

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

getHelpText

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

getHelpText

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

getHelpText

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

getHelpList

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

getHelpText

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

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)

getActualAbilityUsageDesc

java.lang.String getActualAbilityUsageDesc(Ability A,
                                           int whichUsageCode,
                                           MOB forMOB)

Returns a description of the amount of a particular cost is required by the given mob to use the given ability.

Parameters:

A - the Ability to find usage for

whichUsageCode - the Ability.USAGE_ code.

forMOB - null, or a mob to make the report more specific

Returns:

either the word "all" or a number in string form

See Also:

Ability.USAGE_DESCS

getAbilityTargetDesc

java.lang.String getAbilityTargetDesc(Ability A)

getAbilityQualityDesc

java.lang.String getAbilityQualityDesc(Ability A)

getAbilityRangeDesc

java.lang.String getAbilityRangeDesc(Ability A)

getAbilityCostDesc

java.lang.String getAbilityCostDesc(Ability A,
                                    MOB forMOB)