Template:Function2

Replacement for Template:FunctionPage. Must be used with function pages that follow a specific format.

Template parameters[Edit template data]

Parameter		Description	Type	Status
ASH function name	name	Name of the ASH function. This should match the function page name. Example visit_url	Line	required
Function 1, short description	function1.short_description	Short description for the overloaded function 1 (and so on for functions 2 through 3) Example Visits a web page and returns its HTML source.	Content	optional
Function 1, return type	function1.return_type	Return type of the overloaded function 1. Example buffer	Line	required
Function 1, parameter 1	function1.param1	Name of the parameter 1 of the overloaded function 1 (and so on for parameters 2 through 5). Example url	Line	optional
Function 1, parameter 1 description	function1.param1.description	Description of parameter 1 of the overloaded function 1. Example URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.	Content	optional
Function 1, parameter 1 is optional?	function1.param1.optional	"yes" = optional. Any non-empty string will do, but please use "yes" to make standardization easier. Example yes	Line	optional
Function 1, parameter 1 default value	function1.param1.default	If this is specified, function1.param1.optional must be "yes" Example ""	Line	optional

Examples

{{User:Philmasterplus/TemplateSandbox2
|name=visit_url
|function1.return_type=buffer
|function1.short_description=Returns the original HTML source of the page being overridden inside a relay override script.
|function1.description=Returns the original HTML source of the page being overridden. ''This function works only inside a relay override script.''
|function2.return_type=buffer
|function2.short_description=Visits a web page and returns its HTML source.
|function2.description=Makes an HTTP request to a web page and returns its HTML source.
|function2.param1=url
|function2.param1.type=string
|function2.param1.optional=yes
|function2.param1.default=""
|function2.param1.description=URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.
|function2.param2=use_POST
|function2.param2.type=boolean
|function2.param2.optional=yes
|function2.param2.default=true
|function2.param2.description=If <code>true</code>, makes an HTTP POST request when visiting the URL. Otherwise, makes a GET request.
|function2.param3=encoded
|function2.param3.type=boolean
|function2.param3.optional=yes
|function2.param3.default=false
|function2.param3.description=If <code>true</code>, KoLmafia assumes that <code>url</code> has already been [[wikipedia:Percent-encoding|URL-encoded]] and will not encode it.
}}

Function Syntax

Returns the original HTML source of the page being overridden inside a relay override script.

• string url: URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.
• boolean use_POST: If true, makes an HTTP POST request when visiting the URL. Otherwise, makes a GET request.
• boolean encoded: If true, KoLmafia assumes that url has already been URL-encoded and will not encode it.

Visits a web page and returns its HTML source.