Package 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

Help File system for online users, providing not only lookup for named entries, but derived help data for various map and game objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HelpLibrary.HelpSection	An enum for how to search help files.

Field Summary

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

idConverter

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

Returns a list of all help keys.

Parameters:

archonHelp - true to include archon keys, false otherwise

standardHelp - true to include normal keys, false otherwise

Returns:

the list of help keys

fixHelp

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.

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

getHelpText

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

Returns a viewable help entry for the given key.

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:

getArcHelpFile(), getHelpFile()

getHelpText

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

Returns a viewable help entry for the given key.

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:

getArcHelpFile(), getHelpFile()

getSeeAlsoHelpOn

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.

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

findHelpFile

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.

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:

addModifyHelpEntry(MOB, String, String, boolean)

addModifyHelpEntry

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.

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:

findHelpFile(String, HelpSection, boolean)

getHelpMatch

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.

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:

getArcHelpFile(), getHelpFile()

getHelpList

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.

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:

getArcHelpFile(), getHelpFile()

getArcHelpFile

java.util.Properties getArcHelpFile()

Returns the cache for the archon help entries.

Returns:

the cache for the archon help entries.

getHelpFile

java.util.Properties getHelpFile()

Returns the cache for the main help entries.

Returns:

the cache for the main help entries.

unloadHelpFile

void unloadHelpFile(MOB mob)

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

Parameters:

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

getRPProficiencyStr

java.lang.String getRPProficiencyStr(int proficiency)

Returns the official description of a skill proficiency value.

Parameters:

proficiency - the proficiency value 0-100

Returns:

the description for that proficiency

isPlayerSkill

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.

Parameters:

helpStr - the possible skill key

Returns:

true if it looks like a player skill, false otherwise

addHelpEntry

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

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

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

getActualAbilityUsageDesc

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.

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

getAbilityTargetDesc

java.lang.String getAbilityTargetDesc(Ability A)

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

Parameters:

A - the Ability in question

Returns:

the quality description

getAbilityQualityDesc

java.lang.String getAbilityQualityDesc(Ability A)

Returns a description of the quality of the given skill.

Parameters:

A - the Ability in question

Returns:

the quality description

getAbilityRangeDesc

java.lang.String getAbilityRangeDesc(Ability A)

Returns a description of the range of the given skill.

Parameters:

A - the Ability in question

Returns:

the range description

getAbilityCostDesc

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.

Parameters:

A - the Ability in question

forM - the mob to get info for

Returns:

the cost description