Package 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, Tickable, CMLibrary, HelpLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class MUDHelp
extends StdLibrary
implements HelpLibrary

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.HelpLibrary

HelpLibrary.HelpSection

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.lang.String>	genUsageCost
protected int[]	proficiencyRanges
protected static java.lang.String[]	SKILL_PREFIXES
protected static java.lang.String[]	SKILL_SUFFIXES

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

idConverter

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

isDebugging, name, serviceClient, tickStatus

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
MUDHelp()

Method Summary

Modifier and Type	Method	Description
void	addHelpEntry(java.lang.String ID, java.lang.String text, boolean archon)	Adds a new entry to the cached help entries.
boolean	addModifyHelpEntry(MOB mob, java.lang.String helpFile, java.lang.String helpKey, boolean deleteOnly)	An asynchronous editor for help entries that also re-saves the file when completed.
protected java.lang.String	columnHelper(java.lang.String word, java.lang.String msg, int wrap)
java.lang.String	findHelpFile(java.lang.String key, HelpLibrary.HelpSection searchSection, boolean exactOnly)	Returns the path of the help file that contains the given help key.
java.lang.String	fixHelp(java.lang.String tag, java.lang.String str, MOB forM)	Do post processing on the given help text, resolving tags and other derived data that needs insertion.
java.lang.String	getAbilityCostDesc(Ability A, MOB forM)	Returns a description of the amount of trains/practices required by the give mob to gain the given ability.
java.lang.String	getAbilityQualityDesc(Ability A)	Returns a description of the quality of the given skill.
java.lang.String	getAbilityRangeDesc(Ability A)	Returns a description of the range of the given skill.
java.lang.String	getAbilityTargetDesc(Ability A)	Returns a description of the valid targets of the given skill.
java.lang.String	getActualAbilityUsageDesc(Ability A, int whichUsageCode, MOB forM)	Returns a description of the amount of a particular cost is required by the given mob to use the given ability.
protected java.lang.String	getActualUsage(Ability A, int whichUsageCode)
protected java.lang.String	getActualUsageInternal(Ability A, int whichUsageCode, MOB forM)
java.util.Properties	getArcHelpFile()	Returns the cache for the archon help entries.
java.util.Properties	getHelpFile()	Returns the cache for the main help entries.
java.util.List<java.lang.String>	getHelpList(java.lang.String helpStr, java.util.Properties rHelpFile1, java.util.Properties rHelpFile2, MOB forM)	Returns a list of help entries containing the given string, as an aid in search.
Pair<java.lang.String,java.lang.String>	getHelpMatch(java.lang.String helpStr, java.util.Properties rHelpFile, MOB forM, int skipEntries)	Returns a viewable help entry for the given key, checking the given help file and returning the matching key and help text.
java.lang.String	getHelpText(java.lang.String helpStr, MOB forM, boolean favorAHelp)	Returns a viewable help entry for the given key.
java.lang.String	getHelpText(java.lang.String helpStr, MOB forM, boolean favorAHelp, boolean noFix)	Returns a viewable help entry for the given key.
protected java.lang.String	getHelpText(java.lang.String helpKey, java.util.Properties rHelpFile, MOB forM, boolean noFix)
protected Pair<java.lang.String,java.lang.String>	getHelpText(java.lang.String helpKey, java.util.Properties rHelpFile, MOB forM, boolean noFix, int[] skip)
java.lang.String	getRPProficiencyStr(int proficiency)	Returns the official description of a skill proficiency value.
java.util.List<java.lang.String>	getSeeAlsoHelpOn(MOB mob, java.util.Properties rHelpFile, java.lang.String helpSearch, java.lang.String helpKey, java.lang.String helpText, int howMany)	Given the original search term, and the matching helpKey and helpText and mob, this will find any other help keys that might be relevant to the search, returning the list of also-matching results.
java.util.List<java.lang.String>	getTopics(boolean archonHelp, boolean standardHelp)	Returns a list of all help keys.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isPlayerSkill(java.lang.String helpStr)	Returns whether the given string resembles a key for a player qualifying skill, or if the entry has common skill help markers.
protected java.lang.String	normalizeHelpText(java.lang.String helpText, int[] skip)
boolean	shutdown()	Shuts down the library.
void	unloadHelpFile(MOB mob)	Unloads the help file cache, forcing the cache to be repopulated from the filesystem on next access.

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

activate, getServiceClient, L, propertiesLoaded

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

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

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

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, tick

Field Detail

genUsageCost

protected final java.util.Map<java.lang.String,java.lang.String> genUsageCost

SKILL_PREFIXES

protected static final java.lang.String[] SKILL_PREFIXES

SKILL_SUFFIXES

protected static final java.lang.String[] SKILL_SUFFIXES

proficiencyRanges

protected final int[] proficiencyRanges

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, Tech. 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)

Description copied from interface: HelpLibrary

Returns whether the given string resembles a key for a player qualifying skill, or if the entry has common skill help markers.

Specified by:

isPlayerSkill in interface HelpLibrary

Parameters:

helpStr - the possible skill key

Returns:

true if it looks like a player skill, false otherwise

getRPProficiencyStr

public java.lang.String getRPProficiencyStr(int proficiency)

Description copied from interface: HelpLibrary

Returns the official description of a skill proficiency value.

Specified by:

getRPProficiencyStr in interface HelpLibrary

Parameters:

proficiency - the proficiency value 0-100

Returns:

the description for that proficiency

getHelpText

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

Description copied from interface: HelpLibrary

Returns a viewable help entry for the given key.

Specified by:

getHelpText in interface HelpLibrary

Parameters:

helpStr - the key

forM - the mob to get info for

favorAHelp - true to search archon help first

Returns:

the help entry text

See Also:

HelpLibrary.getArcHelpFile(), HelpLibrary.getHelpFile()

getHelpText

public java.lang.String getHelpText(java.lang.String helpStr,
                                    MOB forM,
                                    boolean favorAHelp,
                                    boolean noFix)

Description copied from interface: HelpLibrary

Returns a viewable help entry for the given key.

Specified by:

getHelpText in interface HelpLibrary

Parameters:

helpStr - the key

forM - the mob to get info for

favorAHelp - true to search archon help first

noFix - true to skip post-processing, false otherwise

Returns:

the help entry text

See Also:

HelpLibrary.getArcHelpFile(), HelpLibrary.getHelpFile()

getTopics

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

Description copied from interface: HelpLibrary

Returns a list of all help keys.

Specified by:

getTopics in interface HelpLibrary

Parameters:

archonHelp - true to include archon keys, false otherwise

standardHelp - true to include normal keys, false otherwise

Returns:

the list of help keys

getActualUsageInternal

protected java.lang.String getActualUsageInternal(Ability A,
                                                  int whichUsageCode,
                                                  MOB forM)

getAbilityQualityDesc

public java.lang.String getAbilityQualityDesc(Ability A)

Description copied from interface: HelpLibrary

Returns a description of the quality of the given skill.

Specified by:

getAbilityQualityDesc in interface HelpLibrary

Parameters:

A - the Ability in question

Returns:

the quality description

getAbilityCostDesc

public java.lang.String getAbilityCostDesc(Ability A,
                                           MOB forM)

Description copied from interface: HelpLibrary

Returns a description of the amount of trains/practices required by the give mob to gain the given ability.

Specified by:

getAbilityCostDesc in interface HelpLibrary

Parameters:

A - the Ability in question

forM - the mob to get info for

Returns:

the cost description

getAbilityRangeDesc

public java.lang.String getAbilityRangeDesc(Ability A)

Description copied from interface: HelpLibrary

Returns a description of the range of the given skill.

Specified by:

getAbilityRangeDesc in interface HelpLibrary

Parameters:

A - the Ability in question

Returns:

the range description

getAbilityTargetDesc

public java.lang.String getAbilityTargetDesc(Ability A)

Description copied from interface: HelpLibrary

Returns a description of the valid targets of the given skill.

Specified by:

getAbilityTargetDesc in interface HelpLibrary

Parameters:

A - the Ability in question

Returns:

the quality description

getActualAbilityUsageDesc

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

Description copied from interface: HelpLibrary

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

Specified by:

getActualAbilityUsageDesc in interface HelpLibrary

Parameters:

A - the Ability to find usage for

whichUsageCode - the Ability.USAGE_ code.

forM - 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

getActualUsage

protected java.lang.String getActualUsage(Ability A,
                                          int whichUsageCode)

addHelpEntry

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

Description copied from interface: HelpLibrary

Adds a new entry to the cached help entries. Saves nothing.

Specified by:

addHelpEntry in interface HelpLibrary

Parameters:

ID - the key of the help entry

text - the full text of the help entry

archon - true to add to archon ahelp entries, false for normal

columnHelper

protected java.lang.String columnHelper(java.lang.String word,
                                        java.lang.String msg,
                                        int wrap)

fixHelp

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

Description copied from interface: HelpLibrary

Do post processing on the given help text, resolving tags and other derived data that needs insertion.

Specified by:

fixHelp in interface HelpLibrary

Parameters:

tag - the key

str - the help text to post-process

forM - the mob for whom the help is intended

Returns:

the final help text

getHelpMatch

public Pair<java.lang.String,java.lang.String> getHelpMatch(java.lang.String helpStr,
                                                            java.util.Properties rHelpFile,
                                                            MOB forM,
                                                            int skipEntries)

Description copied from interface: HelpLibrary

Returns a viewable help entry for the given key, checking the given help file and returning the matching key and help text.

Specified by:

getHelpMatch in interface HelpLibrary

Parameters:

helpStr - the key

rHelpFile - the help file cache to use

forM - the mob to get info for

skipEntries - number of matches to skip before returning the next one

Returns:

the help entry key, and help entry text as a pair

See Also:

HelpLibrary.getArcHelpFile(), HelpLibrary.getHelpFile()

normalizeHelpText

protected java.lang.String normalizeHelpText(java.lang.String helpText,
                                             int[] skip)

getHelpText

protected java.lang.String getHelpText(java.lang.String helpKey,
                                       java.util.Properties rHelpFile,
                                       MOB forM,
                                       boolean noFix)

getHelpText

protected Pair<java.lang.String,java.lang.String> getHelpText(java.lang.String helpKey,
                                                              java.util.Properties rHelpFile,
                                                              MOB forM,
                                                              boolean noFix,
                                                              int[] skip)

getHelpList

public java.util.List<java.lang.String> getHelpList(java.lang.String helpStr,
                                                    java.util.Properties rHelpFile1,
                                                    java.util.Properties rHelpFile2,
                                                    MOB forM)

Description copied from interface: HelpLibrary

Returns a list of help entries containing the given string, as an aid in search.

Specified by:

getHelpList in interface HelpLibrary

Parameters:

helpStr - the string to search for

rHelpFile1 - the first help cache to prioritize

rHelpFile2 - null, or the second help cache to prioritize

forM - the mob for whom help entries are searched

Returns:

a friendly list of help entries in columns suitable for the given mob

See Also:

HelpLibrary.getArcHelpFile(), HelpLibrary.getHelpFile()

getArcHelpFile

public java.util.Properties getArcHelpFile()

Description copied from interface: HelpLibrary

Returns the cache for the archon help entries.

Specified by:

getArcHelpFile in interface HelpLibrary

Returns:

the cache for the archon help entries.

getHelpFile

public java.util.Properties getHelpFile()

Description copied from interface: HelpLibrary

Returns the cache for the main help entries.

Specified by:

getHelpFile in interface HelpLibrary

Returns:

the cache for the main help entries.

findHelpFile

public java.lang.String findHelpFile(java.lang.String key,
                                     HelpLibrary.HelpSection searchSection,
                                     boolean exactOnly)

Description copied from interface: HelpLibrary

Returns the path of the help file that contains the given help key.

Specified by:

findHelpFile in interface HelpLibrary

Parameters:

key - the official help key to look for

searchSection - how to search for keys

exactOnly - true to return only exact match, false to get best

Returns:

null, or the help file path

See Also:

HelpLibrary.addModifyHelpEntry(MOB, String, String, boolean)

addModifyHelpEntry

public boolean addModifyHelpEntry(MOB mob,
                                  java.lang.String helpFile,
                                  java.lang.String helpKey,
                                  boolean deleteOnly)

Description copied from interface: HelpLibrary

An asynchronous editor for help entries that also re-saves the file when completed.

Specified by:

addModifyHelpEntry in interface HelpLibrary

Parameters:

mob - the mob who wants to add/edit

helpFile - the help file to edit

helpKey - the help file key entry to edit

deleteOnly - true to delete the entry only

Returns:

true if editing has STARTED

See Also:

HelpLibrary.findHelpFile(String, HelpSection, boolean)

getSeeAlsoHelpOn

public java.util.List<java.lang.String> getSeeAlsoHelpOn(MOB mob,
                                                         java.util.Properties rHelpFile,
                                                         java.lang.String helpSearch,
                                                         java.lang.String helpKey,
                                                         java.lang.String helpText,
                                                         int howMany)

Description copied from interface: HelpLibrary

Given the original search term, and the matching helpKey and helpText and mob, this will find any other help keys that might be relevant to the search, returning the list of also-matching results.

Specified by:

getSeeAlsoHelpOn in interface HelpLibrary

Parameters:

mob - the mob who wants more options

rHelpFile - the help files to base see also on

helpSearch - the original search words

helpKey - the officially found help key

helpText - the officially processed and found help text

howMany - the maximum number of options to return

Returns:

the found see-also help keys

unloadHelpFile

public void unloadHelpFile(MOB mob)

Description copied from interface: HelpLibrary

Unloads the help file cache, forcing the cache to be repopulated from the filesystem on next access.

Specified by:

unloadHelpFile in interface HelpLibrary

Parameters:

mob - null, or a mob to notify after the unload is completed.

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()