Template:Function2

From Kolmafia
Revision as of 15:42, 18 December 2020 by Philmasterplus (talk | contribs)
Jump to navigation Jump to search

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

Template parameters

ParameterDescriptionTypeStatus
ASH function namename

Name of the ASH function. This should match the function page name.

Example
visit_url
Linerequired
Function 1, short descriptionfunction1.short_description

Short description for the 1st overloaded form of the function

Example
Visits a web page and returns its HTML source.
Contentoptional
Function 1, return typefunction1.return_type

Return type of the 1st overloaded form of the function.

Example
buffer
Linerequired
Function 1, parameter 1function1.parameter1

Name of the parameter 1 of the 1st overloaded form of the function.

Example
url
Lineoptional
Function 1, parameter 1 descriptionfunction1.parameter1.description

Description of parameter 1 of the 1st overloaded form of the function.

Example
URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.
Contentoptional
Function 1, parameter 1 is optional?function1.parameter1.optional

Whether parameter 1 of the 1st overloaded form of the function is optional. Note that ASH does not support truly optional parameters; a function with optional parameters is actually multiple overloaded functions.

Default
0
Example
1
Booleanoptional
Function 1, parameter 1 default valuefunction1.parameter1.default

The default value of parameter 1 of the 1st overloaded form of the function. This should be used in conjunction with function1.parameter1.optional

Example
0
Lineoptional