com.planet_ink.coffee_mud.WebMacros
Class AreaScriptData

java.lang.Object
  com.planet_ink.coffee_mud.WebMacros.StdWebMacro
      com.planet_ink.coffee_mud.WebMacros.AreaScriptNext
          com.planet_ink.coffee_mud.WebMacros.AreaScriptData

All Implemented Interfaces:

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

public class AreaScriptData
extends AreaScriptNext

Nested Class Summary

Nested classes/interfaces inherited from class com.planet_ink.coffee_mud.WebMacros.AreaScriptNext

AreaScriptNext.AreaScriptInstance

Constructor Summary

AreaScriptData()

Method Summary

java.lang.String

runMacro(ExternalHTTPRequests httpReq, java.lang.String parm) This method is executed only if this macro returns false for preferBinary().

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

addScript, addScripts, addShopScripts, getAreaScripts, isAdminMacro, name

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

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getFilename, getSpecialContentHeader, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAWebPath, newInstance, parseOrderedParms, parseParms, preferBinary, runBinaryMacro, webify

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaScriptData

public AreaScriptData()

Method Detail

runMacro

public java.lang.String runMacro(ExternalHTTPRequests httpReq,
                                 java.lang.String parm)

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.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class AreaScriptNext

Parameters:

httpReq - the external requests object

parm - any parameter strigs given to the macro

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), ExternalHTTPRequests