com.planet_ink.coffee_mud.WebMacros
Class MUDGrinder

java.lang.Object
  com.planet_ink.coffee_mud.WebMacros.StdWebMacro
      com.planet_ink.coffee_mud.WebMacros.MUDGrinder

All Implemented Interfaces:

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

public class MUDGrinder
extends StdWebMacro

Constructor Summary

MUDGrinder()

Method Summary

protected int[]	getAppropriateXY(Area A, java.lang.String mapStyle)
static Area	getAreaObject(java.lang.String ID)
protected Area	getLoggedArea(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, MOB mob)
static Room	getRoomObject(com.planet_ink.coffee_web.interfaces.HTTPRequest req, java.lang.String ID)
static Room	getRoomObject(java.lang.String AREA, java.lang.String ID)
protected java.lang.String	gridRoomID(Area A, int x, int y)
boolean	isAdminMacro() Whether this macro is restricted to the admin web server.
java.lang.String	name() The public name of this macro
protected java.lang.String	quickfind(Area A, java.lang.String find)
java.lang.String	runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String parm, com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp) This method is executed only if this macro returns false for preferBinary().

Methods inherited from class com.planet_ink.coffee_mud.WebMacros.StdWebMacro

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getHTTPFileData, grabFile, helpHelp, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAWebPath, L, newInstance, parseOrderedParms, parseParms, parseParms, preferBinary, runBinaryMacro, safeIncomingfilter, webify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MUDGrinder

public MUDGrinder()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface CMObject

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

See Also:

Environmental.Name()

isAdminMacro

public boolean isAdminMacro()

Description copied from interface: WebMacro

Whether this macro is restricted to the admin web server.

Specified by:

isAdminMacro in interface WebMacro

Overrides:

isAdminMacro in class StdWebMacro

Returns:

true if the macro is restricted to the admin web server

getAreaObject

public static Area getAreaObject(java.lang.String ID)

getRoomObject

public static Room getRoomObject(java.lang.String AREA,
                                 java.lang.String ID)

getRoomObject

public static Room getRoomObject(com.planet_ink.coffee_web.interfaces.HTTPRequest req,
                                 java.lang.String ID)

runMacro

public java.lang.String runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.lang.String parm,
                                 com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)

Description copied from interface: WebMacro

This method is executed only if this macro returns false for preferBinary(). It will execute the macro and return its results as a string, which is then substituted for the macro reference in the web page where the macro was found. The response object is used to set cookies and headers only. Any response body is in the return object. Since 99% of macros are only filling in an existing page, nothing will be done with that anyway, and is only important when isAWebPath return true.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strings given to the macro

httpResp - the response, with headers

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), HTTPRequest

gridRoomID

protected java.lang.String gridRoomID(Area A,
                                      int x,
                                      int y)

getAppropriateXY

protected int[] getAppropriateXY(Area A,
                                 java.lang.String mapStyle)

getLoggedArea

protected Area getLoggedArea(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                             MOB mob)

quickfind

protected java.lang.String quickfind(Area A,
                                     java.lang.String find)