Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface EnglishParsing

All Superinterfaces:

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

All Known Implementing Classes:

EnglishParser

public interface EnglishParsing
extends CMLibrary

A library that deals specifically with language-specific string manipulation, and input parsing. This library would be a sure-fire candidate for a localizer to alter.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
java.lang.String	bumpDotContextNumber(java.lang.String srchStr, int byThisMuch)	Given a context-specific name, this method returns the name with the number adjusted according to the given amount.
java.lang.String	cleanPrepositions(java.lang.String s)	If the given phrase begins with a preposition word such as to, over, beside, than, since, it will strip the word off and return the rest of the string.
boolean	containsOneOfString(java.lang.String toSrchStr, java.util.List<java.lang.String> srchForStrs)	Returns whether the given string contains any of the srchForStr substrings.
boolean	containsString(java.lang.String toSrchStr, java.lang.String srchForStr)	Returns whether the first string contains the second, case insensitive, and color insensitive.
java.lang.String	coordDescShort(long[] coords)	Returns [best distance],[best distance],[best distance] A [best distance] picks the best of dm, km, etc..
java.lang.String	directionDescShort(double[] dir)	Returns direction in [degrees.YY] mark [degrees.YY]
java.lang.String	directionDescShortest(double[] dir)	Returns direction in [degrees.Y] [space] [degrees.Y]
java.lang.String	distanceDescShort(long distance)	Returns [best distance] for the given number.
Environmental	fetchAvailable(java.util.Collection<? extends Environmental> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly)	Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null.
Environmental	fetchAvailable(java.util.Collection<? extends Environmental> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly, int[] counterSlap)	Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null.
Item	fetchAvailableItem(java.util.List<Item> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly)	Returns a matching item from a collection of them by using a search string to matching, a required filter, and a container which may be null.
java.util.List<Item>	fetchAvailableItems(java.util.List<Item> list, java.lang.String srchStr, Item goodLocation, Filterer<Environmental> filter, boolean exactOnly)	Returns a set of matching items from a collection of them by using a search string to matching, a required filter, and a container which may be null.
Environmental	fetchEnvironmental(java.lang.Iterable<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)	Returns a matching environmental object from an iterable collection of them by using a search string to matching.
Environmental	fetchEnvironmental(java.util.Enumeration<? extends Environmental> iter, java.lang.String srchStr, boolean exactOnly)	Returns a matching environmental object from an enumeration of them by using a search string to matching.
Environmental	fetchEnvironmental(java.util.Iterator<? extends Environmental> iter, java.lang.String srchStr, boolean exactOnly)	Returns a matching environmental object from an iterator of them by using a search string to matching.
Environmental	fetchEnvironmental(java.util.Map<java.lang.String,? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)	Returns a matching environmental object from map of them by using a search string to matching.
java.util.List<Environmental>	fetchEnvironmentals(java.util.List<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)	Returns a set of matching environmental objects from a collection of them by using a search string to matching.
Exit	fetchExit(java.lang.Iterable<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)	Returns a matching exit object from an iterable collection of them by using a search string to matching.
java.util.List<Item>	fetchItemList(ItemPossessor from, MOB mob, Item container, java.util.List<java.lang.String> matchWords, Filterer<Environmental> filter, boolean visionMatters)	Returns a set of matching items from a given item possessor.
<T> T	fetchReflective(java.lang.Iterable<T> list, java.lang.String srchStr, java.lang.String methodName, boolean exactOnly)	Returns a matching T object from an iterable collection of them by using a search string to matching.
CMObject	findCommand(MOB mob, java.util.List<java.lang.String> commands)	Given a user input array, this method will find the skill, command, social, channel, or journal that is trying to be invoked by the user input and, if found, return it.
java.util.List<java.lang.String>	getAllContextNames(java.util.Collection<? extends Environmental> list, Filterer<Environmental> filter)	Given a list of objects and an optional filter, this method returns a list of identical size and order, with the context-specific names instead of the objects.
int	getContextDotNumber(java.lang.String srchStr)	Returns the context number of the given context-specific name.
java.lang.String	getContextName(Environmental[] list, Environmental E)	Returns the context-qualified name of the item in the given list is exactly the given environmental.
java.lang.String	getContextName(ItemCollection cont, Environmental E)	Returns the context-qualified name of the item in the given collection is exactly the given environmental.
java.lang.String	getContextName(java.util.Collection<? extends Environmental> list, Environmental E)	Returns the context-qualified name of the item in the given collection is exactly the given environmental.
int	getContextNumber(Environmental[] list, Environmental E)	Returns the context number of the item in the given list is exactly the given environmental.
int	getContextNumber(ItemCollection cont, Environmental E)	Returns the context number of the item in the given collection is exactly the given environmental.
int	getContextNumber(java.util.Collection<? extends Environmental> list, Environmental E)	Returns the context number of the item in the given collection is exactly the given environmental.
java.lang.String	getContextSameName(Environmental[] list, Environmental E)	Returns the context-specific full name of the object in the given list that is otherwise identical to the given environmental.
java.lang.String	getContextSameName(ItemCollection cont, Environmental E)	Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.
java.lang.String	getContextSameName(java.util.Collection<? extends Environmental> list, Environmental E)	Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.
int	getContextSameNumber(Environmental[] list, Environmental E)	Returns the context number of the object in the given collection that is otherwise identical to the given environmental.
int	getContextSameNumber(ItemCollection cont, Environmental E)	Returns the context number of the object in the given collection that is otherwise identical to the given environmental.
int	getContextSameNumber(java.util.Collection<? extends Environmental> list, Environmental E)	Returns the context number of the object in the given list that is otherwise identical to the given environmental.
java.lang.String	getFirstWord(java.lang.String str)	Returns the first word in the given phrase, ignoring color.
long	getMillisMultiplierByName(java.lang.String timeName)	Converts the given time specifier, or something that might be a time specifier, into the appropriate number of milliseconds.
java.lang.String	getSkillInvokeWord(MOB mob, java.lang.String word)	Given a user input array, this method will find the skill that is trying to be invoked by the MAIN invocation word and, if found, return that word.
Ability	getSkillToInvoke(MOB mob, java.util.List<java.lang.String> commands)	Given a user input array, this method will find the skill that is trying to be invoked by the commands and return it.
boolean	hasEnglishPunctuation(java.lang.String str)	Returns true if the given string contains any normal punctuation characters.
boolean	hasPunctuation(java.lang.String str)	Returns true if the given string contains any extended punctuation characters.
java.lang.String	insertAdjectives(java.lang.String paragraph, java.lang.String[] adjsToChoose, int pctChance)	Inserts one of the given adjectives after an article word found in the given paragraph, a given percentage chance of the time.
java.lang.String	insertUnColoredAdjective(java.lang.String str, java.lang.String adjective)	Inserts the given adjective before a given word or noun phrase, replacing any indefinite articles with the new correct one, and removing any "color" characters from the final phrase.
void	invokeSkill(MOB mob, java.util.List<java.lang.String> commands)	Given a user input array, this method will find the skill that is trying to be invoked by the commands and invoke it.
boolean	isAnArticle(java.lang.String s)	Returns whether the given string is an article, such as a, an, the, some, etc..
boolean	isAnIndefiniteArticle(java.lang.String s)	Returns whether the given string is an indefinite article, such as a, an, some, etc..
boolean	isEnglishPunctuation(byte b)	Returns true if the given byte is any normal punctuation character.
boolean	isPunctuation(byte b)	Returns true if the given byte is any extended punctuation character.
java.lang.String	makeNumberthWords(int num)	Returns the english representation of the given numberst, numberth, number-numberth, etc.
java.lang.String	makeNumberWords(double num, int precision)	Returns the english representation of the given number
java.lang.String	makePastTense(java.lang.String word, java.lang.String defaultWord)	Returns a best guess on the past-tense form of the given word.
java.lang.String	makePlural(java.lang.String str)	Attempts to pluralize a given word.
java.lang.String	makeSingular(java.lang.String str)	Attempts to de-pluralize a given word.
java.lang.String	matchAnyCurrencySet(java.lang.String moneyStr)	For cases when a string input must contain an amount of money, this method is used to determine the currency id reflect by the whole denomination specified by the given user input.
double	matchAnyDenomination(java.lang.String currency, java.lang.String moneyStr)	For cases when a string input must contain an amount of money, this method is used to determine the Whole Denomination multiplier specified by the given user input, and optionally, from the given currency.
Item	parseBestPossibleGold(MOB mob, Container container, java.lang.String moneyStr)	Attempts to determine if the given user input specifies an amount of currency owned by the given player, and if so, returns that precise amount parsed from the players existing currency.
int	parseMaxToGive(MOB mob, java.util.List<java.lang.String> commands, boolean breakPackages, Environmental checkWhat, boolean getOnly)	Parses user input to determine if the user, who is specifying an item of some sort, is intending to specify multiples of those items by using a number in front of their input.
Triad<java.lang.String,java.lang.Double,java.lang.Long>	parseMoneyStringSDL(MOB mob, java.lang.String moneyStr, java.lang.String correctCurrency)	For cases when a string input probably contains an amount of money, this method is used to determine the currency, denomination, and number of units of that currency.
long	parseNumPossibleGold(Environmental mine, java.lang.String moneyStr)	For cases when a string input probably contains an amount of money, this method is used to determine the amount (not value).
java.lang.String	parseNumPossibleGoldCurrency(Environmental mine, java.lang.String moneyStr)	For cases when a string input probably contains an amount of money, this method is used to determine the currency id.
double	parseNumPossibleGoldDenomination(Environmental mine, java.lang.String currency, java.lang.String moneyStr)	For cases when a string input probably contains an amount of money, this method is used to determine the denomination.
Item	parsePossibleContainer(MOB mob, java.util.List<java.lang.String> commands, boolean withStuff, Filterer<Environmental> filter)	Attempts to determine if the given user command input is specifying a container as the last argument, for cases when that would be possible.
java.util.List<Container>	parsePossibleContainers(MOB mob, java.util.List<java.lang.String> commands, Filterer<Environmental> filter, boolean withContentOnly)	Attempts to determine if the given user command input is specifying one or more containers, for cases when that would be possible.
Item	parsePossibleRoomGold(MOB seer, Room room, Container container, java.lang.String moneyStr)	Attempts to determine if the given user input specifies an amount of currency in the given room, and if so, returns that precise amount parsed from the rooms existing currency.
Environmental	parseShopkeeper(MOB mob, java.util.List<java.lang.String> matchWords, java.lang.String fromTo, java.lang.String error)	Returns a matching shopkeeper from a given and his/her location, or null.
java.lang.Long	parseSpaceDistance(java.lang.String dist)	Returns the distance in decameters represented by the given parsable user-entered string.
java.util.List<java.lang.String>	parseWords(java.lang.String thisStr)	Strips out all punctuation and returns the individual words in an english sentence.
boolean	preInvokeSkill(MOB mob, java.util.List<java.lang.String> commands, int secondsElapsed, double actionsRemaining)	Given a user input array, this method will find the skill that is trying to be invoked by the commands, but which cannot be due to insufficient action points, and then call preinvoke on it.
int	probabilityOfBeingEnglish(java.lang.String str)	Returns the probability 0-100 of the given string being english.
java.lang.String	properIndefiniteArticle(java.lang.String str)	Returns the proper indefinite article -- a or an, for the given noun or noun-phrase.
java.lang.String	removeArticleLead(java.lang.String s)	If the given phrase begins with an article word such as a, an, some, etc..
java.lang.String	sizeDescShort(long size)	Returns [best distance] for the given number.
java.lang.String	spaceOutPunctuation(java.lang.String str)	Returns the given string with any punctuation changed into spaces.
java.lang.String	speedDescShort(double speed)	Rounds the given speed and returns [speed]/sec
boolean	startsWithAnArticle(java.lang.String s)	Returns whether the given word or phrase starts with an article, such as a, an, the, some, etc..
boolean	startsWithAnIndefiniteArticle(java.lang.String s)	Returns whether the given word or phrase starts with an indefinite article, such as a, an, some, etc..
java.lang.String	startWithAorAn(java.lang.String str)	Returns the proper indefinite article for the given word/phrase
java.lang.String	stringifyElapsedTimeOrTicks(long millis, long ticks)	Converts the given number of milliseconds into ms, s, m, h, d, etc...
java.lang.String	stripEnglishPunctuation(java.lang.String str)	Returns the given string with normal punctuation removed.
java.lang.String	stripPunctuation(java.lang.String str)	Returns the given string with extended punctuation removed.
java.lang.String	toEnglishStringList(java.lang.Class<? extends java.lang.Enum<?>> enumer, boolean andOr)	Returns comma-space delimited list of the given emum names.
java.lang.String	toEnglishStringList(java.lang.String[] V, boolean andOr)	Returns comma-space delimited list of the given objects.toString().
java.lang.String	toEnglishStringList(java.util.Collection<? extends java.lang.Object> V)	Returns comma-space delimited list of the given objects.toString().

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

isAnArticle

boolean isAnArticle(java.lang.String s)

Returns whether the given string is an article, such as a, an, the, some, etc.. Colors are not respected.

Parameters:

s - the string to check

Returns:

true if its an article, false otherwise

See Also:

isAnIndefiniteArticle(String), startsWithAnArticle(String), startsWithAnIndefiniteArticle(String)

isAnIndefiniteArticle

boolean isAnIndefiniteArticle(java.lang.String s)

Returns whether the given string is an indefinite article, such as a, an, some, etc.. Colors are not respected.

Parameters:

s - the string to check

Returns:

true if its an indefinite article, false otherwise

See Also:

isAnArticle(String), startsWithAnArticle(String), startsWithAnIndefiniteArticle(String)

removeArticleLead

java.lang.String removeArticleLead(java.lang.String s)

If the given phrase begins with an article word such as a, an, some, etc.. it will strip the word off and return the rest of the string. Colors codes are totally respected!

Parameters:

s - the string to clean

Returns:

the string, or the string cleaned

cleanPrepositions

java.lang.String cleanPrepositions(java.lang.String s)

If the given phrase begins with a preposition word such as to, over, beside, than, since, it will strip the word off and return the rest of the string. Colors are not respected.

Parameters:

s - the string to clean

Returns:

the string, or the string cleaned

startsWithAnArticle

boolean startsWithAnArticle(java.lang.String s)

Returns whether the given word or phrase starts with an article, such as a, an, the, some, etc.. Colors codes are totally respected.

Parameters:

s - the string to check

Returns:

true if the string starts with an article

See Also:

isAnArticle(String), isAnIndefiniteArticle(String), startsWithAnIndefiniteArticle(String)

startsWithAnIndefiniteArticle

boolean startsWithAnIndefiniteArticle(java.lang.String s)

Returns whether the given word or phrase starts with an indefinite article, such as a, an, some, etc.. Colors codes are totally respected.

Parameters:

s - the string to check

Returns:

true if the string starts with an indefinite article

See Also:

isAnArticle(String), isAnIndefiniteArticle(String), startsWithAnArticle(String)

stripPunctuation

java.lang.String stripPunctuation(java.lang.String str)

Returns the given string with extended punctuation removed. Must not be colored.

Parameters:

str - the string to check

Returns:

the string, with punctuation removed

spaceOutPunctuation

java.lang.String spaceOutPunctuation(java.lang.String str)

Returns the given string with any punctuation changed into spaces. Don't know why. Must not be colored.

Parameters:

str - the string to convert

Returns:

the string without spaces

isPunctuation

boolean isPunctuation(byte b)

Returns true if the given byte is any extended punctuation character. Such as +-,;:.?! etc.. Must not be colored.

Parameters:

b - the byte to check

Returns:

true if punctuation, false otherwise

hasPunctuation

boolean hasPunctuation(java.lang.String str)

Returns true if the given string contains any extended punctuation characters. Such as +-,;:.?! etc.. Must not be colored.

Parameters:

str - the string to check

Returns:

true if punctuation found, false otherwise

isEnglishPunctuation

boolean isEnglishPunctuation(byte b)

Returns true if the given byte is any normal punctuation character. Such as ,;:.?! etc.. Must not be colored.

Parameters:

b - the byte to check

Returns:

true if punctuation, false otherwise

hasEnglishPunctuation

boolean hasEnglishPunctuation(java.lang.String str)

Returns true if the given string contains any normal punctuation characters. Such as ,;:.?! etc.. Must not be colored.

Parameters:

str - the string to check

Returns:

true if punctuation found, false otherwise

stripEnglishPunctuation

java.lang.String stripEnglishPunctuation(java.lang.String str)

Returns the given string with normal punctuation removed. Must not be colored.

Parameters:

str - the string to check

Returns:

the string, with punctuation removed

makePlural

java.lang.String makePlural(java.lang.String str)

Attempts to pluralize a given word. It's just a best guess. Must not be colored.

Parameters:

str - the word to pluralize

Returns:

the word, pluralized, hopefuly

makeSingular

java.lang.String makeSingular(java.lang.String str)

Attempts to de-pluralize a given word. It's just a best guess. Must not be colored.

Parameters:

str - the word to de-pluralize

Returns:

the word, de-pluralized, hopefuly

makePastTense

java.lang.String makePastTense(java.lang.String word,
                               java.lang.String defaultWord)

Returns a best guess on the past-tense form of the given word. If the word is null or empty, then the default word is returned.

Parameters:

word - the word to past-tensize

defaultWord - the word to use if none given

Returns:

the paten-tensed word.

getFirstWord

java.lang.String getFirstWord(java.lang.String str)

Returns the first word in the given phrase, ignoring color. It must start with a letter.

Parameters:

str - the phrase to look in

Returns:

the first word

properIndefiniteArticle

java.lang.String properIndefiniteArticle(java.lang.String str)

Returns the proper indefinite article -- a or an, for the given noun or noun-phrase. Ignores colors.

Parameters:

str - the noun or noun phrase

Returns:

either 'a' or 'an'

toEnglishStringList

java.lang.String toEnglishStringList(java.lang.String[] V,
                                     boolean andOr)

Returns comma-space delimited list of the given objects.toString(). The final entry will have an "and" prepended. Oxford commas are used.

Parameters:

V - the collection of things to treat as strings

andOr - true to connect with AND, false for OR

Returns:

the comma-space delimited list

toEnglishStringList

java.lang.String toEnglishStringList(java.lang.Class<? extends java.lang.Enum<?>> enumer,
                                     boolean andOr)

Returns comma-space delimited list of the given emum names. The final entry will have an "and" or "or" prepended. Oxford commas are used.

Parameters:

enumer - the collection of things to treat as strings

andOr - true to use AND, false to use OR

Returns:

the comma-space delimited list

toEnglishStringList

java.lang.String toEnglishStringList(java.util.Collection<? extends java.lang.Object> V)

Returns comma-space delimited list of the given objects.toString(). The final entry will have an "and" prepended. Oxford commas are used.

Parameters:

V - the collection of things to treat as strings

Returns:

the comma-space delimited list

makeNumberWords

java.lang.String makeNumberWords(double num,
                                 int precision)

Returns the english representation of the given number

Parameters:

num - the number

precision - the number of digits less than 0

Returns:

the number in english

makeNumberthWords

java.lang.String makeNumberthWords(int num)

Returns the english representation of the given numberst, numberth, number-numberth, etc.

Parameters:

num - the num to translate

Returns:

the th words

insertUnColoredAdjective

java.lang.String insertUnColoredAdjective(java.lang.String str,
                                          java.lang.String adjective)

Inserts the given adjective before a given word or noun phrase, replacing any indefinite articles with the new correct one, and removing any "color" characters from the final phrase.

Parameters:

str - the word or noun phrase

adjective - the adjective to add

Returns:

the adjectivy word or noun phrase

insertAdjectives

java.lang.String insertAdjectives(java.lang.String paragraph,
                                  java.lang.String[] adjsToChoose,
                                  int pctChance)

Inserts one of the given adjectives after an article word found in the given paragraph, a given percentage chance of the time.

Parameters:

paragraph - The paragraph with nouns after articles

adjsToChoose - the list of adjectives to choose from

pctChance - the pct chance that any particular noun gets an adjective

Returns:

the modified paragraph

startWithAorAn

java.lang.String startWithAorAn(java.lang.String str)

Returns the proper indefinite article for the given word/phrase

Parameters:

str - the word/phrase that needs an indefinite article

Returns:

the word/phrase with the article prepended

findCommand

CMObject findCommand(MOB mob,
                     java.util.List<java.lang.String> commands)

Given a user input array, this method will find the skill, command, social, channel, or journal that is trying to be invoked by the user input and, if found, return it. Will silently return null otherwise.

Parameters:

mob - the player/mob trying to invoke a command

commands - the user input array of the invocation

Returns:

the Ability, Command, Social, etc, or null if not found.

getSkillInvokeWord

java.lang.String getSkillInvokeWord(MOB mob,
                                    java.lang.String word)

Given a user input array, this method will find the skill that is trying to be invoked by the MAIN invocation word and, if found, return that word.

Parameters:

mob - the player/mob trying to invoke a skill

word - the user input of the invocation

Returns:

the invocation word found

getSkillToInvoke

Ability getSkillToInvoke(MOB mob,
                         java.util.List<java.lang.String> commands)

Given a user input array, this method will find the skill that is trying to be invoked by the commands and return it. It will intelligently pick between multiple skills with the same invocation words (CAST, PRAY, etc) by using the skill names. DOES modify the invoke commands to remove the invocation word(s)

Parameters:

mob - the player/mob trying to invoke a skill

commands - the user input array of the invocation

Returns:

the Ability found, or null if none

preInvokeSkill

boolean preInvokeSkill(MOB mob,
                       java.util.List<java.lang.String> commands,
                       int secondsElapsed,
                       double actionsRemaining)

Given a user input array, this method will find the skill that is trying to be invoked by the commands, but which cannot be due to insufficient action points, and then call preinvoke on it. If the skill isn't found, the user is notified of the failure and false is returned. This may be called repeatedly until the skill can actually be invoked properly. DOES modify the invoke commands to remove the invocation word(s)

Parameters:

mob - the player mob trying to use a skill

commands - the skill command words and arguments

secondsElapsed - the seconds ellapsed since initial attempt

actionsRemaining - the additional action points required

Returns:

true to continue pre invoking, and false to cancel

invokeSkill

void invokeSkill(MOB mob,
                 java.util.List<java.lang.String> commands)

Given a user input array, this method will find the skill that is trying to be invoked by the commands and invoke it. If the skill isn't found, the user is notified of the failure. DOES modify the invoke commands to remove the invocation word(s)

Parameters:

mob - the player/mob trying to invoke a skill

commands - the user input array of the invocation

containsString

boolean containsString(java.lang.String toSrchStr,
                       java.lang.String srchForStr)

Returns whether the first string contains the second, case insensitive, and color insensitive. Respects special syntax like '$' to ensure complete hits.

Parameters:

toSrchStr - the string to search through

srchForStr - the string to search for in the first string

Returns:

true if the second string appears in the first, false otherwise

containsOneOfString

boolean containsOneOfString(java.lang.String toSrchStr,
                            java.util.List<java.lang.String> srchForStrs)

Returns whether the given string contains any of the srchForStr substrings. The searches are case insensitive, and color * insensitive, and respects special syntax like '$' to ensure complete hits.

Parameters:

toSrchStr - the string to search inside of

srchForStrs - the strings to search for

Returns:

true if any matches are found.

getContextDotNumber

int getContextDotNumber(java.lang.String srchStr)

Returns the context number of the given context-specific name.

Parameters:

srchStr - the context-specific name

Returns:

the number found, or 0

bumpDotContextNumber

java.lang.String bumpDotContextNumber(java.lang.String srchStr,
                                      int byThisMuch)

Given a context-specific name, this method returns the name with the number adjusted according to the given amount. There is NO validation that the resulting context number remains valid.

Parameters:

srchStr - the context name

byThisMuch - the amount to adjust by, + or -

Returns:

the new name

getAllContextNames

java.util.List<java.lang.String> getAllContextNames(java.util.Collection<? extends Environmental> list,
                                                    Filterer<Environmental> filter)

Given a list of objects and an optional filter, this method returns a list of identical size and order, with the context-specific names instead of the objects. Items that do not match the filter are represented as "" in the returned list. It apllows easy mapping between a list and the context names.

Parameters:

list - the list of objects to return the names of

filter - an optional filter, or null

Returns:

the list of context-specific names

getContextNumber

int getContextNumber(Environmental[] list,
                     Environmental E)

Returns the context number of the item in the given list is exactly the given environmental.

Parameters:

list - the list containing the environmental

E - the object to find in the list

Returns:

the context number, or -1

getContextNumber

int getContextNumber(java.util.Collection<? extends Environmental> list,
                     Environmental E)

Returns the context number of the item in the given collection is exactly the given environmental.

Parameters:

list - the collection containing the environmental

E - the object to find in the collection

Returns:

the context number, or -1

getContextNumber

int getContextNumber(ItemCollection cont,
                     Environmental E)

Returns the context number of the item in the given collection is exactly the given environmental.

Parameters:

cont - the collection containing the environmental

E - the object to find in the collection

Returns:

the context number, or -1

getContextName

java.lang.String getContextName(java.util.Collection<? extends Environmental> list,
                                Environmental E)

Returns the context-qualified name of the item in the given collection is exactly the given environmental.

Parameters:

list - the collection containing the environmental

E - the object to find in the collection

Returns:

the context-qualified name

getContextName

java.lang.String getContextName(Environmental[] list,
                                Environmental E)

Returns the context-qualified name of the item in the given list is exactly the given environmental.

Parameters:

list - the list containing the environmental

E - the object to find in the list

Returns:

the context-qualified name

getContextName

java.lang.String getContextName(ItemCollection cont,
                                Environmental E)

Returns the context-qualified name of the item in the given collection is exactly the given environmental.

Parameters:

cont - the collection containing the environmental

E - the object to find in the collection

Returns:

the context-qualified name

getContextSameNumber

int getContextSameNumber(Environmental[] list,
                         Environmental E)

Returns the context number of the object in the given collection that is otherwise identical to the given environmental.

Parameters:

list - the collection to find a match in

E - the environmental to find in the collection

Returns:

the context number of the item in the collection, or -1

getContextSameNumber

int getContextSameNumber(java.util.Collection<? extends Environmental> list,
                         Environmental E)

Returns the context number of the object in the given list that is otherwise identical to the given environmental.

Parameters:

list - the list to find a match in

E - the environmental to find in the collection

Returns:

the context number of the item in the list, or -1

getContextSameNumber

int getContextSameNumber(ItemCollection cont,
                         Environmental E)

Returns the context number of the object in the given collection that is otherwise identical to the given environmental.

Parameters:

cont - the collection to find a match in

E - the environmental to find in the collection

Returns:

the context number of the item in the collection, or -1

getContextSameName

java.lang.String getContextSameName(java.util.Collection<? extends Environmental> list,
                                    Environmental E)

Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.

Parameters:

list - the collection to find a match in

E - the environmental to find in the collection

Returns:

the context-specific name of the item in the collection, or null

getContextSameName

java.lang.String getContextSameName(Environmental[] list,
                                    Environmental E)

Returns the context-specific full name of the object in the given list that is otherwise identical to the given environmental.

Parameters:

list - the collection to find a match in

E - the environmental to find in the collection

Returns:

the context-specific name of the item in the list, or null

getContextSameName

java.lang.String getContextSameName(ItemCollection cont,
                                    Environmental E)

Returns the context-specific full name of the object in the given collection that is otherwise identical to the given environmental.

Parameters:

cont - the collection to find a match in

E - the environmental to find in the collection

Returns:

the context-specific name of the item in the collection, or null

parseWords

java.util.List<java.lang.String> parseWords(java.lang.String thisStr)

Strips out all punctuation and returns the individual words in an english sentence.

Parameters:

thisStr - the sentence

Returns:

the individual words

fetchExit

Exit fetchExit(java.lang.Iterable<? extends Environmental> list,
               java.lang.String srchStr,
               boolean exactOnly)

Returns a matching exit object from an iterable collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the collection of exit objects to search through

srchStr - the search string

exactOnly - true for exact matching, false for inexact

Returns:

a matching object, or null

fetchEnvironmental

Environmental fetchEnvironmental(java.lang.Iterable<? extends Environmental> list,
                                 java.lang.String srchStr,
                                 boolean exactOnly)

Returns a matching environmental object from an iterable collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the collection of environmental objects to search through

srchStr - the search string

exactOnly - true for exact matching, false for inexact

Returns:

a matching object, or null

fetchReflective

<T> T fetchReflective(java.lang.Iterable<T> list,
                      java.lang.String srchStr,
                      java.lang.String methodName,
                      boolean exactOnly)

Returns a matching T object from an iterable collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The object matches are according to given methodName. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Type Parameters:

T - the matching T object

Parameters:

list - the collection of environmental objects to search through

srchStr - the search string

methodName - the method to match against

exactOnly - true for exact matching, false for inexact

Returns:

a matching object, or null

fetchEnvironmental

Environmental fetchEnvironmental(java.util.Enumeration<? extends Environmental> iter,
                                 java.lang.String srchStr,
                                 boolean exactOnly)

Returns a matching environmental object from an enumeration of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

iter - the enumeraton of environmental objects to search through

srchStr - the search string

exactOnly - true for exact matching, false for inexact

Returns:

a matching object, or null

fetchEnvironmental

Environmental fetchEnvironmental(java.util.Map<java.lang.String,? extends Environmental> list,
                                 java.lang.String srchStr,
                                 boolean exactOnly)

Returns a matching environmental object from map of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the map of environmental objects to search through

srchStr - the search string

exactOnly - true for exact matching, false for inexact

Returns:

a matching object, or null

fetchEnvironmental

Environmental fetchEnvironmental(java.util.Iterator<? extends Environmental> iter,
                                 java.lang.String srchStr,
                                 boolean exactOnly)

Returns a matching environmental object from an iterator of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

iter - the iterator of objects to search through

srchStr - the search string

exactOnly - true for exact matching, false for inexact

Returns:

a matching object, or null

fetchEnvironmentals

java.util.List<Environmental> fetchEnvironmentals(java.util.List<? extends Environmental> list,
                                                  java.lang.String srchStr,
                                                  boolean exactOnly)

Returns a set of matching environmental objects from a collection of them by using a search string to matching. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the list of objects to search through

srchStr - the search string

exactOnly - true for exact matching, false for inexact

Returns:

a set of matched objects

fetchAvailableItem

Item fetchAvailableItem(java.util.List<Item> list,
                        java.lang.String srchStr,
                        Item goodLocation,
                        Filterer<Environmental> filter,
                        boolean exactOnly)

Returns a matching item from a collection of them by using a search string to matching, a required filter, and a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include item ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the list of items to search through

srchStr - the search string

goodLocation - a container, or null

filter - the required filter

exactOnly - true for exact matching, false for inexact

Returns:

a matched item, or null

fetchAvailableItems

java.util.List<Item> fetchAvailableItems(java.util.List<Item> list,
                                         java.lang.String srchStr,
                                         Item goodLocation,
                                         Filterer<Environmental> filter,
                                         boolean exactOnly)

Returns a set of matching items from a collection of them by using a search string to matching, a required filter, and a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include item ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the list of items to search through

srchStr - the search string

goodLocation - a container, or null

filter - the required filter

exactOnly - true for exact matching, false for inexact

Returns:

all matched items

fetchAvailable

Environmental fetchAvailable(java.util.Collection<? extends Environmental> list,
                             java.lang.String srchStr,
                             Item goodLocation,
                             Filterer<Environmental> filter,
                             boolean exactOnly)

Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however.

Parameters:

list - the list of objects to search through

srchStr - the search string

goodLocation - a container, or null

filter - the required filter

exactOnly - true for exact matching, false for inexact

Returns:

a matched object, or null

fetchAvailable

Environmental fetchAvailable(java.util.Collection<? extends Environmental> list,
                             java.lang.String srchStr,
                             Item goodLocation,
                             Filterer<Environmental> filter,
                             boolean exactOnly,
                             int[] counterSlap)

Returns a matching environmental object from a collection of them by using a search string to matching, a required filter, and for items, a container which may be null. The search string may include things like counters 1.itemname, etc, or even all itemname. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. Matching may be exact or inexact. Exact matching must include full names, display texts, etc. Inexact can include substrings. Both are case-insensitive, however. A one-dimensional integer array called counterSlap must be sent for tracking occurrences. The occurrence sought will have the existing counterSlap value subtracted from it before matching, and will be updated afterwards if a match is found.

Parameters:

list - the list of objects to search through

srchStr - the search string

goodLocation - a container, or null

filter - the required filter

exactOnly - true for exact matching, false for inexact

counterSlap - a one-dimensional array, usually with 0

Returns:

a matched object, or null. counterslap is modified

fetchItemList

java.util.List<Item> fetchItemList(ItemPossessor from,
                                   MOB mob,
                                   Item container,
                                   java.util.List<java.lang.String> matchWords,
                                   Filterer<Environmental> filter,
                                   boolean visionMatters)

Returns a set of matching items from a given item possessor. The items must match a string descriptor given in matchWords, as well as the given Filterer, and within the given container. The matchWords may include things like counters 1.itemname, etc, or even all itemname. The name matches may include item ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. The mob argument is required due to having a viewer for the visionMatters argument, and as an alternate possible source of items when the item possessor (from) is a room.

Parameters:

from - The room or mob that possess items to select.

mob - the mob in the room, or the viewer of the items

container - the required container that the items should be in, or null

matchWords - the words that must be matched to select an item

filter - the required filter for items

visionMatters - true if the items must be seen by the mob, or false otherwise

Returns:

the list of all selected items, which could be empty.

parseShopkeeper

Environmental parseShopkeeper(MOB mob,
                              java.util.List<java.lang.String> matchWords,
                              java.lang.String fromTo,
                              java.lang.String error)

Returns a matching shopkeeper from a given and his/her location, or null. The shopkeeper must match the minimal *end* of the string descriptor given in matchWords, and, if found, the method will remove those terms from the matchWords list. The first word in matchWords is ALWAYS REMOVED, and so should always be a dummy term. The name matches may include object ids, names, or display text. Exact matches can be demanded using the anchor $ character on the front, back, or both, of the match words. The returned shopkeeper may not itself implement the shopkeeper interface, but will, if not implement it, have an effect that does implement it.

Parameters:

mob - the mob looking for a shopkeeper nearby

matchWords - the search words, possibly modified

fromTo - whether from or to is the proper separator

error - the error message to send for bad arguments

Returns:

a matched shopkeeper, with a modified matchWords list

parseNumPossibleGold

long parseNumPossibleGold(Environmental mine,
                          java.lang.String moneyStr)

For cases when a string input probably contains an amount of money, this method is used to determine the amount (not value). It will attempt to prefer whatever kind of money the given mine mob has on hand, if mine is specified at all, which matches the amount in the user input. Otherwise, it will rely entirely on whatever clues the user input provides as to the amount.

Parameters:

mine - someone with money, like a mob, or null

moneyStr - a user input string to parse

Returns:

the amount of money units

parseNumPossibleGoldCurrency

java.lang.String parseNumPossibleGoldCurrency(Environmental mine,
                                              java.lang.String moneyStr)

For cases when a string input probably contains an amount of money, this method is used to determine the currency id. It will attempt to prefer whatever kind of currency the given mine mob has on hand, if mine is specified at all, which matches the amount in the user input. Otherwise, it will rely entirely on whatever clues the user input provides.

Parameters:

mine - someone with money, like a mob, or null

moneyStr - a user input string to parse

Returns:

the currency id to use

parseNumPossibleGoldDenomination

double parseNumPossibleGoldDenomination(Environmental mine,
                                        java.lang.String currency,
                                        java.lang.String moneyStr)

For cases when a string input probably contains an amount of money, this method is used to determine the denomination. It will attempt to prefer whatever kind of currency the given mine mob has on hand, if mine is specified at all. Otherwise, it relies utterly on the given currency.

Parameters:

mine - someone with money, like a mob, or null

currency - currency to use if mine is unavail

moneyStr - a user input string to parse

Returns:

the denomination reflected by the input, or 0.0

parseMoneyStringSDL

Triad<java.lang.String,java.lang.Double,java.lang.Long> parseMoneyStringSDL(MOB mob,
                                                                            java.lang.String moneyStr,
                                                                            java.lang.String correctCurrency)

For cases when a string input probably contains an amount of money, this method is used to determine the currency, denomination, and number of units of that currency. It will attempt to prefer whatever kind of currency the given mob has on hand.

Parameters:

mob - the user to use to find the right currency

moneyStr - the parsable user input

correctCurrency - a currency id to use, or null to use mob above

Returns:

the currency, denomination, and amount as a triad

matchAnyCurrencySet

java.lang.String matchAnyCurrencySet(java.lang.String moneyStr)

For cases when a string input must contain an amount of money, this method is used to determine the currency id reflect by the whole denomination specified by the given user input.

Parameters:

moneyStr - the user input that contains a denomination

Returns:

the currency id reflecting the found denomination, or null

matchAnyDenomination

double matchAnyDenomination(java.lang.String currency,
                            java.lang.String moneyStr)

For cases when a string input must contain an amount of money, this method is used to determine the Whole Denomination multiplier specified by the given user input, and optionally, from the given currency.

Parameters:

currency - currency id, or null will check all currencies, but why?

moneyStr - the user input that contains a denomination

Returns:

the whole denomination found, or 0.0 for no match

parsePossibleRoomGold

Item parsePossibleRoomGold(MOB seer,
                           Room room,
                           Container container,
                           java.lang.String moneyStr)

Attempts to determine if the given user input specifies an amount of currency in the given room, and if so, returns that precise amount parsed from the rooms existing currency. If the input string does not seem to specify money, then null is quietly returned.

Parameters:

seer - the player looking to get some money

room - the room the money is in

container - the container the money is in, or null

moneyStr - the user input

Returns:

null, or the exact currency object to get

parseBestPossibleGold

Item parseBestPossibleGold(MOB mob,
                           Container container,
                           java.lang.String moneyStr)

Attempts to determine if the given user input specifies an amount of currency owned by the given player, and if so, returns that precise amount parsed from the players existing currency. If the input string does not seem to specify money, then null is quietly returned. if it does specify money, but more than the player has, then the player will receive an error, and null is still returned.

Parameters:

mob - the player looking to give away their money

container - the container it must be in, or null

moneyStr - the user input

Returns:

the players currency as an object, or null

parsePossibleContainers

java.util.List<Container> parsePossibleContainers(MOB mob,
                                                  java.util.List<java.lang.String> commands,
                                                  Filterer<Environmental> filter,
                                                  boolean withContentOnly)

Attempts to determine if the given user command input is specifying one or more containers, for cases when that would be possible. It does this by looking for words like "from", "in", or "on", or the last word, and then checking whether it specifies a container. If containers is found, the given input array is modified. The containers may be in the players inv, or in the room. The word 'all' is parsed out for multiple containers.

Parameters:

mob - the player whose commands are parsed

commands - the commands to parse and check

filter - filter for allowed containers, or null

withContentOnly - true if the container must not be empty

Returns:

list of all containers found, which may be empty

parsePossibleContainer

Item parsePossibleContainer(MOB mob,
                            java.util.List<java.lang.String> commands,
                            boolean withStuff,
                            Filterer<Environmental> filter)

Attempts to determine if the given user command input is specifying a container as the last argument, for cases when that would be possible. It does this by looking for words like "from", "in", or "on", or the last word, and then checking whether it specifies a container. If a container is found, the given input array is modified. The container may be in the players inv, or in the room.

Parameters:

mob - the player whose commands are parsed

commands - the commands to parse and check

withStuff - true if the container must not be empty

filter - filter for allowed containers, or null

Returns:

the container found, or null

stringifyElapsedTimeOrTicks

java.lang.String stringifyElapsedTimeOrTicks(long millis,
                                             long ticks)

Converts the given number of milliseconds into ms, s, m, h, d, etc... If a number of ticks > 0 is also given, it will append them as an average ms/tick.

Parameters:

millis - the number of ellapsed milliseconds to convert

ticks - the number of ticks to average ms by

Returns:

a string efficiently describing this ellapsed time.

parseMaxToGive

int parseMaxToGive(MOB mob,
                   java.util.List<java.lang.String> commands,
                   boolean breakPackages,
                   Environmental checkWhat,
                   boolean getOnly)

Parses user input to determine if the user, who is specifying an item of some sort, is intending to specify multiples of those items by using a number in front of their input. For example: get 10 bags This parser assumes the thing being given might be in the players inventory, or on the ground. This might modify the given commands list.

Parameters:

mob - the player to parse commands from

commands - the parsed input from the user

breakPackages - true to allow package breaking

checkWhat - Possessor (MOB or Room) to check.

getOnly - true if getting from a room

Returns:

-1 for error, or number to get 1-n.

getMillisMultiplierByName

long getMillisMultiplierByName(java.lang.String timeName)

Converts the given time specifier, or something that might be a time specifier, into the appropriate number of milliseconds. The given time must be a single word. These are things like: ticks, seconds, minutes, etc, etc

Parameters:

timeName - an amount of time word

Returns:

the number of milliseconds, or -1

probabilityOfBeingEnglish

int probabilityOfBeingEnglish(java.lang.String str)

Returns the probability 0-100 of the given string being english. Used for Scholar stuff.

Parameters:

str - the text to inspect

Returns:

0-100 chance of it being english

sizeDescShort

java.lang.String sizeDescShort(long size)

Returns [best distance] for the given number. A [best distance] picks the best of dm, km, etc..

Parameters:

size - the full dm distance

Returns:

the best size string

See Also:

distanceDescShort(long)

distanceDescShort

java.lang.String distanceDescShort(long distance)

Returns [best distance] for the given number. A [best distance] picks the best of dm, km, etc..

Parameters:

distance - the full dm distance

Returns:

the best distance string

See Also:

sizeDescShort(long)

coordDescShort

java.lang.String coordDescShort(long[] coords)

Returns [best distance],[best distance],[best distance] A [best distance] picks the best of dm, km, etc..

Parameters:

coords - the 3-absolute coords

Returns:

a displayable best distance coordinate

See Also:

sizeDescShort(long)

speedDescShort

java.lang.String speedDescShort(double speed)

Rounds the given speed and returns [speed]/sec

Parameters:

speed - the raw speed double

Returns:

a friendlier display speed per sec

directionDescShort

java.lang.String directionDescShort(double[] dir)

Returns direction in [degrees.YY] mark [degrees.YY]

Parameters:

dir - the direction in radians

Returns:

a short direction string

See Also:

directionDescShortest(double[])

directionDescShortest

java.lang.String directionDescShortest(double[] dir)

Returns direction in [degrees.Y] [space] [degrees.Y]

Parameters:

dir - the direction in radians

Returns:

a shortest direction possible

See Also:

directionDescShort(double[])

parseSpaceDistance

java.lang.Long parseSpaceDistance(java.lang.String dist)

Returns the distance in decameters represented by the given parsable user-entered string.

Parameters:

dist - the user-entered string

Returns:

the distance in decameters