CoffeeFilter
public interface TelnetFilter extends CMLibrary
Modifier and Type | Interface | Description |
---|---|---|
static class |
TelnetFilter.Pronoun |
One of the most useful enums in the game, this
reminds us of all the pronoun placeholder tags
that get replaced at runtime by this very filter
library by the contextually appropriate word.
|
idConverter
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
colorOnlyFilter(java.lang.String msg,
Session S) |
Does MXP and normal CM ^ color codes, and that's about it.
|
java.lang.String |
fullInFilter(java.lang.String input) |
Safety filter for user input.
|
java.lang.String |
fullOutFilter(Session S,
MOB mob,
Physical source,
Environmental target,
Environmental tool,
java.lang.String msg,
boolean wrapOnly) |
The real workhorse of this library, which does ALL filtering,
including word wrap, MXP and MSP tags, % and \\ escape codes,
pronoun tags, (s), and all the rest.
|
java.util.Set<java.lang.String> |
getPronounSuffixes() |
Returns the suffix strings for the various pronoun tags.
|
java.lang.String |
mxpSafetyFilter(java.lang.String msg,
Session S) |
Does MXP tag correction if MXP is on, and that's it.
|
java.lang.String |
safetyInFilter(java.lang.String s) |
Removes carriage returns, linefeeds, and converts ' to `
|
java.lang.String |
secondaryUserInputFilter(java.lang.String s) |
Converts pronoun tags and at-sign variables
to neutral characters, rendering them useless.
|
java.lang.String |
simpleInFilter(java.lang.StringBuilder input) |
Safety filter for user input.
|
java.lang.String |
simpleInFilter(java.lang.StringBuilder input,
boolean permitMXPTags,
boolean isArchon) |
Safety filter for user input.
|
java.lang.String |
simpleOutFilter(java.lang.String msg) |
Simplest, least things done filter.
|
java.lang.String[] |
wrapOnlyFilter(java.lang.String msg,
int wrap) |
Does word wrapping, % and backslash \\ escape codes.
|
activate, getServiceClient, L, propertiesLoaded, shutdown
copyOf, ID, initializeClass, name, newInstance
java.util.Set<java.lang.String> getPronounSuffixes()
java.lang.String simpleOutFilter(java.lang.String msg)
msg
- the filtered messagejava.lang.String colorOnlyFilter(java.lang.String msg, Session S)
msg
- the message to translateS
- null, or the session object, for color codesjava.lang.String mxpSafetyFilter(java.lang.String msg, Session S)
msg
- the string to translateS
- null, or the session for MXP statusjava.lang.String[] wrapOnlyFilter(java.lang.String msg, int wrap)
msg
- the string to filterwrap
- the column to wrap atjava.lang.String fullOutFilter(Session S, MOB mob, Physical source, Environmental target, Environmental tool, java.lang.String msg, boolean wrapOnly)
S
- null, or the session for wrap, tags, other infomob
- the mob who will see the messagesource
- the source for S-pronounstarget
- the target for T-pronounstool
- the tool for O-pronounsmsg
- the string to filterwrapOnly
- true to skip pronouns, and (s)java.lang.String safetyInFilter(java.lang.String s)
s
- the string to filterjava.lang.String simpleInFilter(java.lang.StringBuilder input, boolean permitMXPTags, boolean isArchon)
input
- the input stringpermitMXPTags
- true to allow mxp tags from usersisArchon
- true to allow certain escape codes from usersjava.lang.String simpleInFilter(java.lang.StringBuilder input)
input
- the input stringjava.lang.String fullInFilter(java.lang.String input)
input
- the input stringjava.lang.String secondaryUserInputFilter(java.lang.String s)
s
- the input string to filter