Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface MaskingLibrary

All Superinterfaces:

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

All Known Implementing Classes:

MUDZapper

public interface MaskingLibrary
extends CMLibrary

A ZapperMask is a set of conditions, typically of the form VALUE in SET, KEY=VALUE or VALUE, etc. These masks are used to determine the objects eligibility for some purpose. The most common use is as a mask to determine whether some mob is able to do something, or will have something happen to them. ZapperMasks are made up of one or more entries, as mentioned above. These entries have an implicit AND connector between them, whereas the values in each entry are typically an internal OR. e.g. Zappermask = condition entry AND condition entry AND condition entry, etc.. Condition Entry = VALUE = OPTION or OPTION or OPTION or OPTION...

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MaskingLibrary.CompiledZMask	A Compiled ZapperMask is a set of conditions, typically of the form VALUE in SET, KEY=VALUE or VALUE, etc.
static interface	MaskingLibrary.CompiledZMaskEntry	A Compiled Mask Entry is a condition, typically of the form VALUE in SET, or KEY=VALUE, or VALUE in RANGE.
static class	MaskingLibrary.ZapperKey	The set of mask types.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
MaskingLibrary.CompiledZMask	createEmptyMask()	Creates an empty always-passing compiled zappermask object.
java.util.List<java.lang.String>	getAbilityEduReqs(java.lang.String text)	If the given zappermask contains any references to ability or expertise requirements, this will return the IDs of the required object.
MaskingLibrary.CompiledZMask	getPreCompiledMask(java.lang.String str)	Given a zappermask, this will check the internal cache for an already compiled version of the given string, build a new one if necessary, and return it
boolean	maskCheck(MaskingLibrary.CompiledZMask cset, Environmental E, boolean actual)	Given a compiled zappermask and a Environmental object, this will return whether the Environmental passes the filter, or is rejected by it.
boolean	maskCheck(MaskingLibrary.CompiledZMask cset, PlayerLibrary.ThinPlayer E)	Given a compiled zappermask and a ThinPlayer object, this will return whether the ThinPlayer passes the filter, or is rejected by it.
boolean	maskCheck(java.lang.String text, Environmental E, boolean actual)	Given a zappermask and a Environmental object, this will return whether the Environmental passes the filter, or is rejected by it.
boolean	maskCheck(java.lang.String text, PlayerLibrary.ThinPlayer E)	Given a zappermask and a ThinPlayer object, this will return whether the ThinPlayer passes the filter, or is rejected by it.
MaskingLibrary.CompiledZMask	maskCompile(java.lang.String text)	Given a zappermask, this will return a compiled version of the given string, build a new one if necessary, and return it
java.lang.String	maskDesc(java.lang.String text)	Given a zappermask, this will return a brief readable english description of the mask.
java.lang.String	maskDesc(java.lang.String text, boolean skipFirstWord)	Given a zappermask, this will return a brief readable english description of the mask.
java.lang.String	maskHelp(java.lang.String CR, java.lang.String word)	Returns the official help file for the list of all zappermask codes, customized for the caller.
int	minMaskLevel(java.lang.String text, int minMinLevel)	Given a zappermask string, this method will find any level-check related criteria, such as level, classlevel, or maxclasslevel, and returns the minimum level of the criteria.
java.lang.String[]	parseMaskKeys(java.lang.String maskStr)	Parses the given string, returning all of the zappermask keys in the order in which they appear.
java.lang.String[]	separateMaskStrs(java.lang.String newText)	Lots of property strings support including zappermasks by including the string MASK= followed by the remainder of the string being the zappermask.
java.lang.String	separateZapperMask(java.lang.String newText)	Lots of props and behaviors support embedded zappermasks, but they aren't delineated.
boolean	syntaxCheck(java.lang.String text, java.util.List<java.lang.String> errorSink)	Parses the given string as a zappermask and returns true if any parsed bit is a valid zappermask type word.

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

maskHelp

java.lang.String maskHelp(java.lang.String CR,
                          java.lang.String word)

Returns the official help file for the list of all zappermask codes, customized for the caller.

Parameters:

CR - null, or the type of EOL string to use.

word - null, or a substitute for the word 'disallow'

Returns:

the customized help file for the zappermask codes

getAbilityEduReqs

java.util.List<java.lang.String> getAbilityEduReqs(java.lang.String text)

If the given zappermask contains any references to ability or expertise requirements, this will return the IDs of the required object.

Parameters:

text - the zappermask

Returns:

a list of any required abilities or expertises

maskDesc

java.lang.String maskDesc(java.lang.String text)

Given a zappermask, this will return a brief readable english description of the mask. The normal format is "allows only..." or "disallows ...".

Parameters:

text - the ZapperMask string

Returns:

a description of the mask

See Also:

maskDesc(String, boolean)

maskDesc

java.lang.String maskDesc(java.lang.String text,
                          boolean skipFirstWord)

Given a zappermask, this will return a brief readable english description of the mask. The normal format is "allows only..." or "disallows ...". If skipFirstWord is sent, then the allows case returns "only...".

Parameters:

text - the ZapperMask string

skipFirstWord - true to skip the word 'allows'

Returns:

a description of the mask

See Also:

maskDesc(String)

maskCompile

MaskingLibrary.CompiledZMask maskCompile(java.lang.String text)

Given a zappermask, this will return a compiled version of the given string, build a new one if necessary, and return it

Parameters:

text - the zappermask string

Returns:

the compiled zappermask

See Also:

getPreCompiledMask(String)

getPreCompiledMask

MaskingLibrary.CompiledZMask getPreCompiledMask(java.lang.String str)

Given a zappermask, this will check the internal cache for an already compiled version of the given string, build a new one if necessary, and return it

Parameters:

str - the zappermask string

Returns:

the compiled zappermask

See Also:

maskCompile(String)

maskCheck

boolean maskCheck(MaskingLibrary.CompiledZMask cset,
                  Environmental E,
                  boolean actual)

Given a compiled zappermask and a Environmental object, this will return whether the Environmental passes the filter, or is rejected by it.

Parameters:

cset - the compiled zappermask to apply to the player

E - the object to apply the pas to

actual - true to use base stats, false for adjusted

Returns:

true to pass the given object, false if rejected

See Also:

maskCheck(CompiledZMask, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), maskCheck(String, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), maskCheck(String, Environmental, boolean)

maskCheck

boolean maskCheck(java.lang.String text,
                  Environmental E,
                  boolean actual)

Given a zappermask and a Environmental object, this will return whether the Environmental passes the filter, or is rejected by it.

Parameters:

text - the zappermask to apply to the player

E - the object to apply the pas to

actual - true to use base stats, false for adjusted

Returns:

true to pass the given object, false if rejected

See Also:

maskCheck(CompiledZMask, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), maskCheck(String, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), maskCheck(CompiledZMask, Environmental, boolean)

maskCheck

boolean maskCheck(MaskingLibrary.CompiledZMask cset,
                  PlayerLibrary.ThinPlayer E)

Given a compiled zappermask and a ThinPlayer object, this will return whether the ThinPlayer passes the filter, or is rejected by it.

Parameters:

cset - the compiled zappermask to apply to the player

E - the thinplayer object

Returns:

true to pass the thinplayer, false if rejected

See Also:

PlayerLibrary.ThinPlayer, maskCheck(String, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), maskCheck(CompiledZMask, Environmental, boolean), maskCheck(String, Environmental, boolean)

maskCheck

boolean maskCheck(java.lang.String text,
                  PlayerLibrary.ThinPlayer E)

Given a zappermask and a ThinPlayer object, this will return whether the ThinPlayer passes the filter, or is rejected by it.

Parameters:

text - the zappermask to apply to the player

E - the thinplayer object

Returns:

true to pass the thinplayer, false if rejected

See Also:

PlayerLibrary.ThinPlayer, maskCheck(CompiledZMask, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), maskCheck(CompiledZMask, Environmental, boolean), maskCheck(String, Environmental, boolean)

syntaxCheck

boolean syntaxCheck(java.lang.String text,
                    java.util.List<java.lang.String> errorSink)

Parses the given string as a zappermask and returns true if any parsed bit is a valid zappermask type word.

Parameters:

text - the postential zappermask

errorSink - the list to put the error message in

Returns:

true if any part of the given string looks zappermasky

minMaskLevel

int minMaskLevel(java.lang.String text,
                 int minMinLevel)

Given a zappermask string, this method will find any level-check related criteria, such as level, classlevel, or maxclasslevel, and returns the minimum level of the criteria.

Parameters:

text - the zappermask

minMinLevel - the default floor to return

Returns:

the minimum level in the mask

separateMaskStrs

java.lang.String[] separateMaskStrs(java.lang.String newText)

Lots of property strings support including zappermasks by including the string MASK= followed by the remainder of the string being the zappermask. This method helps support those properties. It will return a two dimensional array where the first string is the normal arguments, and the second string is the zappermask, or "" if none was found.

Parameters:

newText - the property parameters

Returns:

the property parameter and zappermask array

separateZapperMask

java.lang.String separateZapperMask(java.lang.String newText)

Lots of props and behaviors support embedded zappermasks, but they aren't delineated. This method will attempt to discover the mask embedded in a complex string by looking for first and last appearances of pluses and minuses.

Parameters:

newText - the string to search

Returns:

the zappermask, or ""

createEmptyMask

MaskingLibrary.CompiledZMask createEmptyMask()

Creates an empty always-passing compiled zappermask object.

Returns:

an empty always-passing compiled zappermask

parseMaskKeys

java.lang.String[] parseMaskKeys(java.lang.String maskStr)

Parses the given string, returning all of the zappermask keys in the order in which they appear.

Parameters:

maskStr - the full zappermask string

Returns:

the list of mask keys