Difference between revisions of "Template:Function2"

From Kolmafia
Jump to navigation Jump to search
Line 5: Line 5:
 
   |'''<code>{{{function1.return_type}}} {{{name}}}({{
 
   |'''<code>{{{function1.return_type}}} {{{name}}}({{
 
     #if: {{{function1.parameter1|}}}
 
     #if: {{{function1.parameter1|}}}
−
     |{{{User:Philmasterplus/FunctionDeclaration
+
     |{{User:Philmasterplus/FunctionDeclaration
 
       |name={{{name}}}
 
       |name={{{name}}}
−
       |return_type={{{function1.return_type1}}}
+
       |return_type={{{function1.return_type}}}
−
       |param1={{{function1.param1}}}
+
       |param1={{{function1.param1|}}}
−
       |param1.type={{{function1.param1.type}}}
+
       |param1.type={{{function1.param1.type|}}}
−
       |param1.optional={{{function1.param1.optional}}}
+
       |param1.optional={{{function1.param1.optional|}}}
−
       |param1.default={{{function1.param1.default}}}
+
       |param1.default={{{function1.param1.default|}}}
−
       |param2={{{function1.param2}}}
+
       |param2={{{function1.param2|}}}
−
       |param2.type={{{function1.param2.type}}}
+
       |param2.type={{{function1.param2.type|}}}
−
       |param2.optional={{{function1.param2.optional}}}
+
       |param2.optional={{{function1.param2.optional|}}}
−
       |param2.default={{{function1.param2.default}}}
+
       |param2.default={{{function1.param2.default|}}}
−
       |param3={{{function1.param3}}}
+
       |param3={{{function1.param3|}}}
−
       |param3.type={{{function1.param3.type}}}
+
       |param3.type={{{function1.param3.type|}}}
−
       |param3.optional={{{function1.param3.optional}}}
+
       |param3.optional={{{function1.param3.optional|}}}
−
       |param3.default={{{function1.param3.default}}}
+
       |param3.default={{{function1.param3.default|}}}
−
       |param4={{{function1.param4}}}
+
       |param4={{{function1.param4|}}}
−
       |param4.type={{{function1.param4.type}}}
+
       |param4.type={{{function1.param4.type|}}}
−
       |param4.optional={{{function1.param4.optional}}}
+
       |param4.optional={{{function1.param4.optional|}}}
−
       |param4.default={{{function1.param4.default}}}
+
       |param4.default={{{function1.param4.default|}}}
−
       |param5={{{function1.param5}}}
+
       |param5={{{function1.param5|}}}
−
       |param5.type={{{function1.param5.type}}}
+
       |param5.type={{{function1.param5.type|}}}
−
       |param5.optional={{{function1.param5.optional}}}
+
       |param5.optional={{{function1.param5.optional|}}}
−
       |param5.default={{{function1.param5.default}}}
+
       |param5.default={{{function1.param5.default|}}}
 
     }})</code>'''{{
 
     }})</code>'''{{
 
   #if: {{{function1.param1|}}}
 
   #if: {{{function1.param1|}}}
Line 45: Line 45:
 
   |'''<code>{{{function2.return_type}}} {{{name}}}({{
 
   |'''<code>{{{function2.return_type}}} {{{name}}}({{
 
     #if: {{{function2.parameter1|}}}
 
     #if: {{{function2.parameter1|}}}
−
     |{{{User:Philmasterplus/FunctionDeclaration
+
     |{{User:Philmasterplus/FunctionDeclaration
 
       |name={{{name}}}
 
       |name={{{name}}}
−
       |return_type={{{function2.return_type1}}}
+
       |return_type={{{function2.return_type}}}
−
       |param1={{{function2.param1}}}
+
       |param1={{{function2.param1|}}}
−
       |param1.type={{{function2.param1.type}}}
+
       |param1.type={{{function2.param1.type|}}}
−
       |param1.optional={{{function2.param1.optional}}}
+
       |param1.optional={{{function2.param1.optional|}}}
−
       |param1.default={{{function2.param1.default}}}
+
       |param1.default={{{function2.param1.default|}}}
−
       |param2={{{function2.param2}}}
+
       |param2={{{function2.param2|}}}
−
       |param2.type={{{function2.param2.type}}}
+
       |param2.type={{{function2.param2.type|}}}
−
       |param2.optional={{{function2.param2.optional}}}
+
       |param2.optional={{{function2.param2.optional|}}}
−
       |param2.default={{{function2.param2.default}}}
+
       |param2.default={{{function2.param2.default|}}}
−
       |param3={{{function2.param3}}}
+
       |param3={{{function2.param3|}}}
−
       |param3.type={{{function2.param3.type}}}
+
       |param3.type={{{function2.param3.type|}}}
−
       |param3.optional={{{function2.param3.optional}}}
+
       |param3.optional={{{function2.param3.optional|}}}
−
       |param3.default={{{function2.param3.default}}}
+
       |param3.default={{{function2.param3.default|}}}
−
       |param4={{{function2.param4}}}
+
       |param4={{{function2.param4|}}}
−
       |param4.type={{{function2.param4.type}}}
+
       |param4.type={{{function2.param4.type|}}}
−
       |param4.optional={{{function2.param4.optional}}}
+
       |param4.optional={{{function2.param4.optional|}}}
−
       |param4.default={{{function2.param4.default}}}
+
       |param4.default={{{function2.param4.default|}}}
−
       |param5={{{function2.param5}}}
+
       |param5={{{function2.param5|}}}
−
       |param5.type={{{function2.param5.type}}}
+
       |param5.type={{{function2.param5.type|}}}
−
       |param5.optional={{{function2.param5.optional}}}
+
       |param5.optional={{{function2.param5.optional|}}}
−
       |param5.default={{{function2.param5.default}}}
+
       |param5.default={{{function2.param5.default|}}}
 
     }})</code>'''{{
 
     }})</code>'''{{
 
   #if: {{{function2.param1|}}}
 
   #if: {{{function2.param1|}}}
Line 85: Line 85:
 
   |'''<code>{{{function3.return_type}}} {{{name}}}({{
 
   |'''<code>{{{function3.return_type}}} {{{name}}}({{
 
     #if: {{{function3.parameter1|}}}
 
     #if: {{{function3.parameter1|}}}
−
     |{{{User:Philmasterplus/FunctionDeclaration
+
     |{{User:Philmasterplus/FunctionDeclaration
 
       |name={{{name}}}
 
       |name={{{name}}}
−
       |return_type={{{function3.return_type1}}}
+
       |return_type={{{function3.return_type}}}
−
       |param1={{{function3.param1}}}
+
       |param1={{{function3.param1|}}}
−
       |param1.type={{{function3.param1.type}}}
+
       |param1.type={{{function3.param1.type|}}}
−
       |param1.optional={{{function3.param1.optional}}}
+
       |param1.optional={{{function3.param1.optional|}}}
−
       |param1.default={{{function3.param1.default}}}
+
       |param1.default={{{function3.param1.default|}}}
−
       |param2={{{function3.param2}}}
+
       |param2={{{function3.param2|}}}
−
       |param2.type={{{function3.param2.type}}}
+
       |param2.type={{{function3.param2.type|}}}
−
       |param2.optional={{{function3.param2.optional}}}
+
       |param2.optional={{{function3.param2.optional|}}}
−
       |param2.default={{{function3.param2.default}}}
+
       |param2.default={{{function3.param2.default|}}}
−
       |param3={{{function3.param3}}}
+
       |param3={{{function3.param3|}}}
−
       |param3.type={{{function3.param3.type}}}
+
       |param3.type={{{function3.param3.type|}}}
−
       |param3.optional={{{function3.param3.optional}}}
+
       |param3.optional={{{function3.param3.optional|}}}
−
       |param3.default={{{function3.param3.default}}}
+
       |param3.default={{{function3.param3.default|}}}
−
       |param4={{{function3.param4}}}
+
       |param4={{{function3.param4|}}}
−
       |param4.type={{{function3.param4.type}}}
+
       |param4.type={{{function3.param4.type|}}}
−
       |param4.optional={{{function3.param4.optional}}}
+
       |param4.optional={{{function3.param4.optional|}}}
−
       |param4.default={{{function3.param4.default}}}
+
       |param4.default={{{function3.param4.default|}}}
−
       |param5={{{function3.param5}}}
+
       |param5={{{function3.param5|}}}
−
       |param5.type={{{function3.param5.type}}}
+
       |param5.type={{{function3.param5.type|}}}
−
       |param5.optional={{{function3.param5.optional}}}
+
       |param5.optional={{{function3.param5.optional|}}}
−
       |param5.default={{{function3.param5.default}}}
+
       |param5.default={{{function3.param5.default|}}}
 
     }})</code>'''{{
 
     }})</code>'''{{
 
   #if: {{{function3.param1|}}}
 
   #if: {{{function3.param1|}}}

Revision as of 17:50, 18 December 2020

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 overloaded function 1 (and so on for functions 2 through 3)

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

Return type of the overloaded function 1.

Example
buffer
Linerequired
Function 1, parameter 1function1.param1

Name of the parameter 1 of the overloaded function 1 (and so on for parameters 2 through 5).

Example
url
Lineoptional
Function 1, parameter 1 descriptionfunction1.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.
Contentoptional
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
Lineoptional
Function 1, parameter 1 default valuefunction1.param1.default

If this is specified, function1.param1.optional must be "yes"

Example
""
Lineoptional

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

{{#if: buffer 

 |buffer visit_url(

{{#if: buffer 

 |buffer visit_url(

{{#if: 

 |{{{function3.return_type}}} visit_url(


Retrieved from "https://wiki.kolmafia.us/index.php?title=Template:Function2&oldid=8715"