Package com.planet_ink.coffee_mud.Libraries

Class CMProtocols

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.CMProtocols

All Implemented Interfaces:

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

public class CMProtocols
extends StdLibrary
implements ProtocolLibrary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CMProtocols.MSDPCommand
protected static class	CMProtocols.MSDPConfigurableVar
protected static class	CMProtocols.MSDPListable
protected static class	CMProtocols.MSDPVariable

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

ProtocolLibrary.GMCPCommand, ProtocolLibrary.MCPPackage

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected byte[]	buildGmcpResponse(java.lang.String json)
protected java.util.Map<java.lang.String,java.lang.Object>	buildMsdpMap(char[] data, int dataSize)
protected boolean	containsMcpStarTag(java.util.Map<java.lang.String,java.lang.String> keyValuePairs)
protected java.lang.String	getAbilityGroupName(int code)
java.lang.String	getDefaultMXPImage(CMObject O)	MXP Images for each object can go from very specific to general.
java.lang.String	getHashedMXPImage(java.lang.String key)
java.lang.String	getHashedMXPImage(java.util.Map<java.lang.String,java.lang.String> H, java.lang.String key)
protected java.lang.Object	getMsdpComparable(Session session, CMProtocols.MSDPVariable var)
protected java.util.Map<java.lang.Integer,java.util.List<Ability>>	getSkillGroups(MOB mob)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
byte[]	invokeRoomChangeGmcp(Session session, java.util.Map<java.lang.String,java.lang.Long> reporteds, java.util.Map<java.lang.String,java.lang.Double> supportables)	GMCP appears to support getting a report from the protocol when entering a new room.
protected java.lang.String	makeGMCPAttribs(Item I)
boolean	mcp(Session session, java.lang.StringBuilder str, java.lang.String[] mcpKey, java.util.Map<java.lang.String,float[]> clientSupported, java.util.Map<java.lang.String,java.lang.String> keyValuePairs)	Handles an MCP command from the user, modifying the line of text that contains it.
protected static java.lang.String	MCP_COMMAND_KEY()
protected static java.lang.String	MCP_DATA_TAG()
protected static java.lang.String	MCP_KEYSENT_KEY()
protected byte[]	msdpListToMsdpArray(java.lang.Object[] stuff)
protected java.lang.Object	msdpStringify(java.lang.Object o)
java.lang.String	msp(java.lang.String soundName, int priority)	Generates an MSP sound tag
java.lang.String	msp(java.lang.String soundName, int volume, int priority)
java.lang.String	mxpImage(Environmental E, java.lang.String parms)	Constructs an official MXP image tag for the given object, with the given parms.
java.lang.String	mxpImage(Environmental E, java.lang.String parms, java.lang.String pre, java.lang.String post)	Constructs an official MXP image tag for the given object, with the given parms, and given pre-image and post-image data.
java.lang.String[]	mxpImagePath(java.lang.String fileName)	Returns the path and filename to an MXP image, given the image filename, presumably full path.
protected boolean	parseMcpCont(java.lang.String s, boolean[] exec, java.util.Map<java.lang.String,java.lang.String> keyValuePairs)
protected boolean	parseMcpEnd(java.lang.String s, boolean[] exec, java.util.Map<java.lang.String,java.lang.String> keyValuePairs)
protected boolean	parseMcpStart(java.lang.String s, boolean[] exec, java.util.Map<java.lang.String,java.lang.String> keyValuePairs)
byte[]	pingGmcp(Session session, java.util.Map<java.lang.String,java.lang.Long> reporteds, java.util.Map<java.lang.String,java.lang.Double> supportables)	Called every second from each player session to deal with periodic GMCP reports.
byte[]	pingMsdp(Session session, java.util.Map<java.lang.Object,java.lang.Object> reportables)	Called every second from each player session to deal with periodic MSDP reports.
protected byte[]	possiblePingGmcp(Session session, java.util.Map<java.lang.String,java.lang.Long> reporteds, java.util.Map<java.lang.String,java.lang.Double> supportables, java.lang.String command)
byte[]	processGmcp(Session session, java.lang.String data, java.util.Map<java.lang.String,java.lang.Double> supportables)	Main entry point to handle GMCP commands from the user
protected java.lang.String	processGmcpStr(Session session, java.lang.String jsonData, java.util.Map<java.lang.String,java.lang.Double> supportables)
byte[]	processMsdp(Session session, char[] data, int dataSize, java.util.Map<java.lang.Object,java.lang.Object> reportables)	Main entry point to handle MSDP commands from the user
protected byte[]	processMsdpList(Session session, java.lang.String var, java.util.Map<java.lang.Object,java.lang.Object> reportables)
protected byte[]	processMsdpSend(Session session, java.lang.String var)
protected void	resetMsdpConfigurable(Session session, java.lang.String var, java.util.Map<java.lang.Object,java.lang.Object> reportables)

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

Constructor Detail

CMProtocols

public CMProtocols()

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

msp

public java.lang.String msp(java.lang.String soundName,
                            int volume,
                            int priority)

MCP_KEYSENT_KEY

protected static java.lang.String MCP_KEYSENT_KEY()

MCP_COMMAND_KEY

protected static java.lang.String MCP_COMMAND_KEY()

MCP_DATA_TAG

protected static java.lang.String MCP_DATA_TAG()

containsMcpStarTag

protected boolean containsMcpStarTag(java.util.Map<java.lang.String,java.lang.String> keyValuePairs)

parseMcpStart

protected boolean parseMcpStart(java.lang.String s,
                                boolean[] exec,
                                java.util.Map<java.lang.String,java.lang.String> keyValuePairs)

parseMcpCont

protected boolean parseMcpCont(java.lang.String s,
                               boolean[] exec,
                               java.util.Map<java.lang.String,java.lang.String> keyValuePairs)

parseMcpEnd

protected boolean parseMcpEnd(java.lang.String s,
                              boolean[] exec,
                              java.util.Map<java.lang.String,java.lang.String> keyValuePairs)

mcp

public boolean mcp(Session session,
                   java.lang.StringBuilder str,
                   java.lang.String[] mcpKey,
                   java.util.Map<java.lang.String,float[]> clientSupported,
                   java.util.Map<java.lang.String,java.lang.String> keyValuePairs)

Description copied from interface: ProtocolLibrary

Handles an MCP command from the user, modifying the line of text that contains it.

Specified by:

mcp in interface ProtocolLibrary

Parameters:

session - the session of the user

str - the string containing the command

mcpKey - the MCP key

clientSupported - map of supported features and their versions

keyValuePairs - protocol-specific key value pairs

Returns:

true if all went well, false otherwise

mxpImagePath

public java.lang.String[] mxpImagePath(java.lang.String fileName)

Description copied from interface: ProtocolLibrary

Returns the path and filename to an MXP image, given the image filename, presumably full path.

Specified by:

mxpImagePath in interface ProtocolLibrary

Parameters:

fileName - the full image path

Returns:

an array with the path, then the filename

See Also:

ProtocolLibrary.getDefaultMXPImage(CMObject), ProtocolLibrary.mxpImage(Environmental, String, String, String), ProtocolLibrary.mxpImage(Environmental, String), ProtocolLibrary.mxpImagePath(String)

mxpImage

public java.lang.String mxpImage(Environmental E,
                                 java.lang.String parms)

Description copied from interface: ProtocolLibrary

Constructs an official MXP image tag for the given object, with the given parms.

Specified by:

mxpImage in interface ProtocolLibrary

Parameters:

E - the object to generate an image tag for

parms - MXP image parms

Returns:

"" or a complete MXP image tag

See Also:

ProtocolLibrary.getDefaultMXPImage(CMObject), ProtocolLibrary.mxpImage(Environmental, String, String, String), ProtocolLibrary.mxpImage(Environmental, String), ProtocolLibrary.mxpImagePath(String)

mxpImage

public java.lang.String mxpImage(Environmental E,
                                 java.lang.String parms,
                                 java.lang.String pre,
                                 java.lang.String post)

Description copied from interface: ProtocolLibrary

Constructs an official MXP image tag for the given object, with the given parms, and given pre-image and post-image data.

Specified by:

mxpImage in interface ProtocolLibrary

Parameters:

E - the object to generate an image tag for

parms - MXP image parms

pre - something to put in front of the IMAGE tag itself

post - something to put after it, usually a space

Returns:

"" or a complete MXP image tag

See Also:

ProtocolLibrary.getDefaultMXPImage(CMObject), ProtocolLibrary.mxpImage(Environmental, String, String, String), ProtocolLibrary.mxpImage(Environmental, String), ProtocolLibrary.mxpImagePath(String)

getHashedMXPImage

public java.lang.String getHashedMXPImage(java.lang.String key)

msp

public java.lang.String msp(java.lang.String soundName,
                            int priority)

Description copied from interface: ProtocolLibrary

Generates an MSP sound tag

Specified by:

msp in interface ProtocolLibrary

Parameters:

soundName - the name of the MSP sound

priority - a bias number for the sound priority

Returns:

the MSP sound tag

getHashedMXPImage

public java.lang.String getHashedMXPImage(java.util.Map<java.lang.String,java.lang.String> H,
                                          java.lang.String key)

getDefaultMXPImage

public java.lang.String getDefaultMXPImage(CMObject O)

Description copied from interface: ProtocolLibrary

MXP Images for each object can go from very specific to general. This function goes through all the various image layers available to a given game object, and returns the most specific one that is defined.

Specified by:

getDefaultMXPImage in interface ProtocolLibrary

Parameters:

O - the object to get an image for

Returns:

"", or the http image sub-path

See Also:

ProtocolLibrary.getDefaultMXPImage(CMObject), ProtocolLibrary.mxpImage(Environmental, String, String, String), ProtocolLibrary.mxpImage(Environmental, String), ProtocolLibrary.mxpImagePath(String)

msdpStringify

protected java.lang.Object msdpStringify(java.lang.Object o)

buildMsdpMap

protected java.util.Map<java.lang.String,java.lang.Object> buildMsdpMap(char[] data,
                                                                        int dataSize)

getMsdpComparable

protected java.lang.Object getMsdpComparable(Session session,
                                             CMProtocols.MSDPVariable var)

processMsdpSend

protected byte[] processMsdpSend(Session session,
                                 java.lang.String var)
                          throws java.io.UnsupportedEncodingException,
                                 java.io.IOException

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

msdpListToMsdpArray

protected byte[] msdpListToMsdpArray(java.lang.Object[] stuff)
                              throws java.io.UnsupportedEncodingException,
                                     java.io.IOException

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

processMsdpList

protected byte[] processMsdpList(Session session,
                                 java.lang.String var,
                                 java.util.Map<java.lang.Object,java.lang.Object> reportables)
                          throws java.io.UnsupportedEncodingException,
                                 java.io.IOException

Throws:

java.io.UnsupportedEncodingException

java.io.IOException

getAbilityGroupName

protected java.lang.String getAbilityGroupName(int code)

resetMsdpConfigurable

protected void resetMsdpConfigurable(Session session,
                                     java.lang.String var,
                                     java.util.Map<java.lang.Object,java.lang.Object> reportables)

pingMsdp

public byte[] pingMsdp(Session session,
                       java.util.Map<java.lang.Object,java.lang.Object> reportables)

Description copied from interface: ProtocolLibrary

Called every second from each player session to deal with periodic MSDP reports.

Specified by:

pingMsdp in interface ProtocolLibrary

Parameters:

session - the session of the mob to report to

reportables - the 'subscriptions' of the given session

Returns:

null, or bytes to send to the user

See Also:

ProtocolLibrary.processMsdp(Session, char[], int, Map)

processMsdp

public byte[] processMsdp(Session session,
                          char[] data,
                          int dataSize,
                          java.util.Map<java.lang.Object,java.lang.Object> reportables)

Description copied from interface: ProtocolLibrary

Main entry point to handle MSDP commands from the user

Specified by:

processMsdp in interface ProtocolLibrary

Parameters:

session - the session of the mob to report to

data - the users MSDP sending

dataSize - the size of the sending?

reportables - the 'subscriptions' of the given session

Returns:

null, or bytes to send to the user

See Also:

ProtocolLibrary.pingMsdp(Session, Map)

buildGmcpResponse

protected byte[] buildGmcpResponse(java.lang.String json)

getSkillGroups

protected java.util.Map<java.lang.Integer,java.util.List<Ability>> getSkillGroups(MOB mob)

makeGMCPAttribs

protected java.lang.String makeGMCPAttribs(Item I)

processGmcpStr

protected java.lang.String processGmcpStr(Session session,
                                          java.lang.String jsonData,
                                          java.util.Map<java.lang.String,java.lang.Double> supportables)

processGmcp

public byte[] processGmcp(Session session,
                          java.lang.String data,
                          java.util.Map<java.lang.String,java.lang.Double> supportables)

Description copied from interface: ProtocolLibrary

Main entry point to handle GMCP commands from the user

Specified by:

processGmcp in interface ProtocolLibrary

Parameters:

session - the session of the mob to report to

data - the command sent by the user

supportables - map of supported GMCP features

Returns:

null, or bytes to send to the user

See Also:

ProtocolLibrary.pingGmcp(Session, Map, Map), ProtocolLibrary.invokeRoomChangeGmcp(Session, Map, Map), ProtocolLibrary.GMCPCommand

possiblePingGmcp

protected byte[] possiblePingGmcp(Session session,
                                  java.util.Map<java.lang.String,java.lang.Long> reporteds,
                                  java.util.Map<java.lang.String,java.lang.Double> supportables,
                                  java.lang.String command)

invokeRoomChangeGmcp

public byte[] invokeRoomChangeGmcp(Session session,
                                   java.util.Map<java.lang.String,java.lang.Long> reporteds,
                                   java.util.Map<java.lang.String,java.lang.Double> supportables)

Description copied from interface: ProtocolLibrary

GMCP appears to support getting a report from the protocol when entering a new room. This method is called to handle those reports.

Specified by:

invokeRoomChangeGmcp in interface ProtocolLibrary

Parameters:

session - the session of the mob to report to

reporteds - the 'subscriptions' of the given session

supportables - map of supported GMCP features

Returns:

null, or bytes to send to the user

See Also:

ProtocolLibrary.processGmcp(Session, String, Map), ProtocolLibrary.pingGmcp(Session, Map, Map), ProtocolLibrary.GMCPCommand

pingGmcp

public byte[] pingGmcp(Session session,
                       java.util.Map<java.lang.String,java.lang.Long> reporteds,
                       java.util.Map<java.lang.String,java.lang.Double> supportables)

Description copied from interface: ProtocolLibrary

Called every second from each player session to deal with periodic GMCP reports.

Specified by:

pingGmcp in interface ProtocolLibrary

Parameters:

session - the session of the mob to report to

reporteds - the 'subscriptions' of the given session

supportables - map of supported GMCP features

Returns:

null, or bytes to send to the user

See Also:

ProtocolLibrary.processGmcp(Session, String, Map), ProtocolLibrary.invokeRoomChangeGmcp(Session, Map, Map), ProtocolLibrary.GMCPCommand