Template:Function2: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
No edit summary
No edit summary
Line 15: Line 15:
   #if: {{{function1.parameter3|}}}
   #if: {{{function1.parameter3|}}}
   |{{#if: {{{function1.parameter3.optional|}}}|<nowiki>[</nowiki>}}
   |{{#if: {{{function1.parameter3.optional|}}}|<nowiki>[</nowiki>}}
   |, {{{function1.parameter3.type|{{error|Parameter 'function1.parameter3.type' is missing for User:Philmasterplus/TemplateSandbox2}}}}} {{Pspan|{{{function1.parameter3}}}}}
   , {{{function1.parameter3.type|{{error|Parameter 'function1.parameter3.type' is missing for User:Philmasterplus/TemplateSandbox2}}}}} {{Pspan|{{{function1.parameter3}}}}}
   {{#if: {{{function1.parameter3.optional|}}}|<nowiki>]</nowiki>}}
   {{#if: {{{function1.parameter3.optional|}}}|<nowiki>]</nowiki>}}
   }})'''{{
   }})'''{{
Line 40: Line 40:
   #if: {{{function2.parameter3|}}}
   #if: {{{function2.parameter3|}}}
   |{{#if: {{{function2.parameter3.optional|}}}|<nowiki>[</nowiki>}}
   |{{#if: {{{function2.parameter3.optional|}}}|<nowiki>[</nowiki>}}
   |, {{{function2.parameter3.type|{{error|Parameter 'function2.parameter3.type' is missing for User:Philmasterplus/TemplateSandbox2}}}}} {{Pspan|{{{function2.parameter3}}}}}
   , {{{function2.parameter3.type|{{error|Parameter 'function2.parameter3.type' is missing for User:Philmasterplus/TemplateSandbox2}}}}} {{Pspan|{{{function2.parameter3}}}}}
   {{#if: {{{function2.parameter3.optional|}}}|<nowiki>]</nowiki>}}
   {{#if: {{{function2.parameter3.optional|}}}|<nowiki>]</nowiki>}}
   }})'''{{
   }})'''{{
Line 65: Line 65:
   #if: {{{function3.parameter3|}}}
   #if: {{{function3.parameter3|}}}
   |{{#if: {{{function3.parameter3.optional|}}}|<nowiki>[</nowiki>}}
   |{{#if: {{{function3.parameter3.optional|}}}|<nowiki>[</nowiki>}}
   |, {{{function3.parameter3.type|{{error|Parameter 'function3.parameter3.type' is missing for User:Philmasterplus/TemplateSandbox2}}}}} {{Pspan|{{{function3.parameter3}}}}}
   , {{{function3.parameter3.type|{{error|Parameter 'function3.parameter3.type' is missing for User:Philmasterplus/TemplateSandbox2}}}}} {{Pspan|{{{function3.parameter3}}}}}
   {{#if: {{{function3.parameter3.optional|}}}|<nowiki>]</nowiki>}}
   {{#if: {{{function3.parameter3.optional|}}}|<nowiki>]</nowiki>}}
   }})'''{{
   }})'''{{

Revision as of 15:56, 18 December 2020

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

Template parameters[Edit template data]

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