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


Nested Class Summary
static interface MaskingLibrary.CompiledZMask
           
static interface MaskingLibrary.CompiledZMaskEntry
           
static class MaskingLibrary.ZapperKey
           
 
Method Summary
 MaskingLibrary.CompiledZMask createEmptyMask()
           
 java.util.List<java.lang.String> getAbilityEduReqs(java.lang.String text)
           
 java.util.Map<java.lang.String,MaskingLibrary.ZapperKey> getMaskCodes()
           
 MaskingLibrary.CompiledZMask getPreCompiledMask(java.lang.String str)
           
 boolean maskCheck(MaskingLibrary.CompiledZMask cset, Environmental E, boolean actual)
           
 boolean maskCheck(MaskingLibrary.CompiledZMask cset, PlayerLibrary.ThinPlayer E)
           
 boolean maskCheck(java.lang.String text, Environmental E, boolean actual)
           
 boolean maskCheck(java.lang.String text, PlayerLibrary.ThinPlayer E)
           
 MaskingLibrary.CompiledZMask maskCompile(java.lang.String text)
           
 java.lang.String maskDesc(java.lang.String text)
           
 java.lang.String maskDesc(java.lang.String text, boolean skipFirstWord)
           
 java.lang.String maskHelp(java.lang.String CR, java.lang.String word)
           
 int minMaskLevel(java.lang.String text, int minMinLevel)
           
 java.lang.String rawMaskHelp()
           
 java.lang.String[] separateMaskStrs(java.lang.String newText)
           
 boolean syntaxCheck(java.lang.String text, java.util.List<java.lang.String> errorSink)
           
 
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

getMaskCodes

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

rawMaskHelp

java.lang.String rawMaskHelp()

maskHelp

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

getAbilityEduReqs

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

maskDesc

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

maskDesc

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

maskCompile

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

getPreCompiledMask

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

maskCheck

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

maskCheck

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

maskCheck

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

maskCheck

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

syntaxCheck

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

minMaskLevel

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

separateMaskStrs

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

createEmptyMask

MaskingLibrary.CompiledZMask createEmptyMask()