Package com.planet_ink.coffee_mud.Libraries

Class MUDZapper

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.MUDZapper

All Implemented Interfaces:

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

public class MUDZapper
extends StdLibrary
implements MaskingLibrary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MUDZapper.CompiledZapperMaskEntryImpl
static class	MUDZapper.CompiledZapperMaskImpl

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

MaskingLibrary.CompiledZMask, MaskingLibrary.CompiledZMaskEntry, MaskingLibrary.ZapperKey

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<MaskingLibrary.ZapperKey,java.util.TreeMap<java.lang.String,java.lang.Object>>	compiledCache
protected java.util.TreeMap<java.lang.String,MUDZapper.CompiledZapperMaskEntryImpl>	looseCodesCache
protected java.lang.String[]	looseFinalLevels
protected Item	nonCrashingItem
protected MOB	nonCrashingMOB
protected java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedClass>	savedCharClasses
protected long	savedClassUpdateTime
protected java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedRace>	savedRaces
protected java.util.Map<java.lang.String,MaskingLibrary.ZapperKey>	zapCodes

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
MUDZapper()

Method Summary

Modifier and Type	Method	Description
protected int	appendCommaList(java.lang.StringBuilder buf, java.util.List<java.lang.String> V, int v)
protected int	appendCommaList(java.lang.StringBuilder buf, java.util.List<java.lang.String> V, int v, java.lang.String startChar)
void	buildSavedClasses()
java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedClass>	charClasses()
protected boolean	checkLocation(Environmental E, MOB M, Room R, java.lang.Object o, java.lang.Object p)
int	countQuals(java.util.List<java.lang.String> V, int v, java.lang.String startsWith)
MaskingLibrary.CompiledZMask	createEmptyMask()	Creates an empty always-passing compiled zappermask object.
protected int	determineSeasonCode(java.lang.String str)
protected boolean	doZapperCompare(MaskingLibrary.CompiledZMaskEntry entry, int cl, int i)
protected boolean	evaluateSkillFlagObject(java.lang.Object o, Ability A)
protected MaskingLibrary.CompiledZMaskEntry[]	fixEntrySet(MaskingLibrary.CompiledZMaskEntry entry)
protected int	fromHereStartsWith(java.util.List<java.lang.String> lV, int v, java.lang.StringBuilder str, MaskingLibrary.ZapperKey key)
protected int	fromHereStartsWith(java.util.List<java.lang.String> lV, int v, java.util.List<java.lang.Object> parms, MaskingLibrary.ZapperKey key)
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.
protected CharStats	getBaseCharStats(CharStats base, MOB mob)
java.util.TreeMap<java.lang.String,java.lang.Object>	getCompiledCache(MaskingLibrary.ZapperKey key)
java.util.TreeMap<java.lang.String,MUDZapper.CompiledZapperMaskEntryImpl>	getLooseCodes()
protected java.util.Map<java.lang.String,MaskingLibrary.ZapperKey>	getMaskCodes()
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
protected Faction.FRange	getRange(java.lang.String s)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
protected boolean	isDateMatch(java.lang.Object o, int num)
protected MaskingLibrary.CompiledZMaskEntry	levelCompiledHelper(java.lang.String str, char c)
protected java.lang.StringBuilder	levelHelp(java.lang.String lvl, char c, java.lang.String append)
protected int	levelMinHelp(java.lang.String lvl, char c, int minMinLevel, boolean reversed)
protected java.lang.Object	makeSkillFlagObject(java.lang.String str)
protected boolean	maskCheck(MaskingLibrary.CompiledZMaskEntry[] cset, Environmental E, boolean actual)
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.
protected boolean	maskCheckSubEntries(MaskingLibrary.CompiledZMaskEntry[] set, Environmental E, boolean actual, MOB mob, Item item, Room room, Physical P)
protected boolean	maskCheckSubEntries(MaskingLibrary.CompiledZMaskEntry[] set, PlayerLibrary.ThinPlayer E)
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.
protected boolean	matchesLooseCode(java.lang.String str)
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.
protected boolean	multipleQuals(java.util.List<java.lang.String> V, int v, java.lang.String startsWith)
protected Item	nonCrashingItem(MOB mob)
protected MOB	nonCrashingMOB()
protected Room	outdoorRoom(Area A)
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.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedRace>	races()
protected java.lang.String	rawMaskHelp()
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.
protected boolean	skillFlagCheck(java.util.List<java.lang.String> V, char plusMinus, int fromHere, MOB mob)
boolean	syntaxCheck(java.lang.String mask, 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, 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, shutdown, tick

Field Detail

zapCodes

protected final java.util.Map<java.lang.String,MaskingLibrary.ZapperKey> zapCodes

savedCharClasses

protected volatile java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedClass> savedCharClasses

savedRaces

protected volatile java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedRace> savedRaces

savedClassUpdateTime

protected volatile long savedClassUpdateTime

compiledCache

protected final java.util.Map<MaskingLibrary.ZapperKey,java.util.TreeMap<java.lang.String,java.lang.Object>> compiledCache

looseCodesCache

protected final java.util.TreeMap<java.lang.String,MUDZapper.CompiledZapperMaskEntryImpl> looseCodesCache

looseFinalLevels

protected final java.lang.String[] looseFinalLevels

nonCrashingMOB

protected MOB nonCrashingMOB

nonCrashingItem

protected Item nonCrashingItem

Constructor Detail

MUDZapper

public MUDZapper()

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

nonCrashingMOB

protected MOB nonCrashingMOB()

nonCrashingItem

protected Item nonCrashingItem(MOB mob)

rawMaskHelp

protected java.lang.String rawMaskHelp()

buildSavedClasses

public void buildSavedClasses()

getLooseCodes

public final java.util.TreeMap<java.lang.String,MUDZapper.CompiledZapperMaskEntryImpl> getLooseCodes()

charClasses

public final java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedClass> charClasses()

races

public final java.util.List<com.planet_ink.coffee_mud.Libraries.MUDZapper.SavedRace> races()

getCompiledCache

public final java.util.TreeMap<java.lang.String,java.lang.Object> getCompiledCache(MaskingLibrary.ZapperKey key)

getPreCompiledMask

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

Description copied from interface: MaskingLibrary

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

Specified by:

getPreCompiledMask in interface MaskingLibrary

Parameters:

str - the zappermask string

Returns:

the compiled zappermask

See Also:

MaskingLibrary.maskCompile(String)

createEmptyMask

public MaskingLibrary.CompiledZMask createEmptyMask()

Description copied from interface: MaskingLibrary

Creates an empty always-passing compiled zappermask object.

Specified by:

createEmptyMask in interface MaskingLibrary

Returns:

an empty always-passing compiled zappermask

getMaskCodes

protected java.util.Map<java.lang.String,MaskingLibrary.ZapperKey> getMaskCodes()

maskHelp

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskHelp in interface MaskingLibrary

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

fixEntrySet

protected MaskingLibrary.CompiledZMaskEntry[] fixEntrySet(MaskingLibrary.CompiledZMaskEntry entry)

makeSkillFlagObject

protected java.lang.Object makeSkillFlagObject(java.lang.String str)

checkLocation

protected boolean checkLocation(Environmental E,
                                MOB M,
                                Room R,
                                java.lang.Object o,
                                java.lang.Object p)

evaluateSkillFlagObject

protected boolean evaluateSkillFlagObject(java.lang.Object o,
                                          Ability A)

skillFlagCheck

protected boolean skillFlagCheck(java.util.List<java.lang.String> V,
                                 char plusMinus,
                                 int fromHere,
                                 MOB mob)

levelCompiledHelper

protected MaskingLibrary.CompiledZMaskEntry levelCompiledHelper(java.lang.String str,
                                                                char c)

levelHelp

protected java.lang.StringBuilder levelHelp(java.lang.String lvl,
                                            char c,
                                            java.lang.String append)

determineSeasonCode

protected int determineSeasonCode(java.lang.String str)

levelMinHelp

protected int levelMinHelp(java.lang.String lvl,
                           char c,
                           int minMinLevel,
                           boolean reversed)

matchesLooseCode

protected boolean matchesLooseCode(java.lang.String str)

fromHereStartsWith

protected int fromHereStartsWith(java.util.List<java.lang.String> lV,
                                 int v,
                                 java.util.List<java.lang.Object> parms,
                                 MaskingLibrary.ZapperKey key)

fromHereStartsWith

protected int fromHereStartsWith(java.util.List<java.lang.String> lV,
                                 int v,
                                 java.lang.StringBuilder str,
                                 MaskingLibrary.ZapperKey key)

getRange

protected Faction.FRange getRange(java.lang.String s)

maskDesc

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskDesc in interface MaskingLibrary

Parameters:

text - the ZapperMask string

Returns:

a description of the mask

See Also:

MaskingLibrary.maskDesc(String, boolean)

countQuals

public int countQuals(java.util.List<java.lang.String> V,
                      int v,
                      java.lang.String startsWith)

multipleQuals

protected boolean multipleQuals(java.util.List<java.lang.String> V,
                                int v,
                                java.lang.String startsWith)

appendCommaList

protected int appendCommaList(java.lang.StringBuilder buf,
                              java.util.List<java.lang.String> V,
                              int v,
                              java.lang.String startChar)

appendCommaList

protected int appendCommaList(java.lang.StringBuilder buf,
                              java.util.List<java.lang.String> V,
                              int v)

parseMaskKeys

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

Description copied from interface: MaskingLibrary

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

Specified by:

parseMaskKeys in interface MaskingLibrary

Parameters:

maskStr - the full zappermask string

Returns:

the list of mask keys

maskDesc

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

Description copied from interface: MaskingLibrary

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...".

Specified by:

maskDesc in interface MaskingLibrary

Parameters:

text - the ZapperMask string

skipFirstWord - true to skip the word 'allows'

Returns:

a description of the mask

See Also:

MaskingLibrary.maskDesc(String)

isDateMatch

protected final boolean isDateMatch(java.lang.Object o,
                                    int num)

syntaxCheck

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

Description copied from interface: MaskingLibrary

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

Specified by:

syntaxCheck in interface MaskingLibrary

Parameters:

mask - the postential zappermask

errorSink - the list to put the error message in

Returns:

true if any part of the given string looks zappermasky

getAbilityEduReqs

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

Description copied from interface: MaskingLibrary

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

Specified by:

getAbilityEduReqs in interface MaskingLibrary

Parameters:

text - the zappermask

Returns:

a list of any required abilities or expertises

minMaskLevel

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

Description copied from interface: MaskingLibrary

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.

Specified by:

minMaskLevel in interface MaskingLibrary

Parameters:

text - the zappermask

minMinLevel - the default floor to return

Returns:

the minimum level in the mask

maskCompile

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskCompile in interface MaskingLibrary

Parameters:

text - the zappermask string

Returns:

the compiled zappermask

See Also:

MaskingLibrary.getPreCompiledMask(String)

outdoorRoom

protected Room outdoorRoom(Area A)

getBaseCharStats

protected CharStats getBaseCharStats(CharStats base,
                                     MOB mob)

maskCheck

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskCheck in interface MaskingLibrary

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:

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

maskCheck

protected boolean maskCheck(MaskingLibrary.CompiledZMaskEntry[] cset,
                            Environmental E,
                            boolean actual)

maskCheck

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskCheck in interface MaskingLibrary

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:

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

doZapperCompare

protected boolean doZapperCompare(MaskingLibrary.CompiledZMaskEntry entry,
                                  int cl,
                                  int i)

maskCheckSubEntries

protected boolean maskCheckSubEntries(MaskingLibrary.CompiledZMaskEntry[] set,
                                      Environmental E,
                                      boolean actual,
                                      MOB mob,
                                      Item item,
                                      Room room,
                                      Physical P)

maskCheck

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskCheck in interface MaskingLibrary

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, MaskingLibrary.maskCheck(CompiledZMask, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), MaskingLibrary.maskCheck(CompiledZMask, Environmental, boolean), MaskingLibrary.maskCheck(String, Environmental, boolean)

maskCheck

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

Description copied from interface: MaskingLibrary

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

Specified by:

maskCheck in interface MaskingLibrary

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, MaskingLibrary.maskCheck(String, com.planet_ink.coffee_mud.Libraries.interfaces.PlayerLibrary.ThinPlayer), MaskingLibrary.maskCheck(CompiledZMask, Environmental, boolean), MaskingLibrary.maskCheck(String, Environmental, boolean)

maskCheckSubEntries

protected boolean maskCheckSubEntries(MaskingLibrary.CompiledZMaskEntry[] set,
                                      PlayerLibrary.ThinPlayer E)

separateZapperMask

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

Description copied from interface: MaskingLibrary

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.

Specified by:

separateZapperMask in interface MaskingLibrary

Parameters:

newText - the string to search

Returns:

the zappermask, or ""

separateMaskStrs

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

Description copied from interface: MaskingLibrary

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.

Specified by:

separateMaskStrs in interface MaskingLibrary

Parameters:

newText - the property parameters

Returns:

the property parameter and zappermask array