Difference between revisions of "Template:Function2"
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 |
− | + | |name={{{name}}} | |
− | + | |return_type={{{function1.return_type1}}} | |
− | + | |param1={{{function1.param1}}} | |
− | + | |param1.type={{{function1.param1.type}}} | |
− | + | |param1.optional={{{function1.param1.optional}}} | |
− | + | |param1.default={{{function1.param1.default}}} | |
− | + | |param2={{{function1.param2}}} | |
− | + | |param2.type={{{function1.param2.type}}} | |
− | + | |param2.optional={{{function1.param2.optional}}} | |
− | + | |param2.default={{{function1.param2.default}}} | |
− | + | |param3={{{function1.param3}}} | |
− | + | |param3.type={{{function1.param3.type}}} | |
− | + | |param3.optional={{{function1.param3.optional}}} | |
− | + | |param3.default={{{function1.param3.default}}} | |
− | + | |param4={{{function1.param4}}} | |
− | + | |param4.type={{{function1.param4.type}}} | |
− | #if: {{{function1. | + | |param4.optional={{{function1.param4.optional}}} |
− | | | + | |param4.default={{{function1.param4.default}}} |
− | #if: {{{function1. | + | |param5={{{function1.param5}}} |
− | |<li>'''{{{function1. | + | |param5.type={{{function1.param5.type}}} |
− | #if: {{{function1. | + | |param5.optional={{{function1.param5.optional}}} |
− | |<li>'''{{{function1. | + | |param5.default={{{function1.param5.default}}} |
− | #if: {{{function1. | + | }})</code>'''{{ |
+ | #if: {{{function1.param1|}}} | ||
+ | |<ul><li>'''{{{function1.param1.type}}} {{Pspan|{{{function1.param1}}}}}''': {{{function1.param1.description}}}</li>}}{{ | ||
+ | #if: {{{function1.param2|}}} | ||
+ | |<li>'''{{{function1.param2.type}}} {{Pspan|{{{function1.param2}}}}}''': {{{function1.param2.description}}}</li>}}{{ | ||
+ | #if: {{{function1.param3|}}} | ||
+ | |<li>'''{{{function1.param3.type}}} {{Pspan|{{{function1.param3}}}}}''': {{{function1.param3.description}}}</li>}}{{ | ||
+ | #if: {{{function1.param4|}}} | ||
+ | |<li>'''{{{function1.param4.type}}} {{Pspan|{{{function1.param4}}}}}''': {{{function1.param4.description}}}</li>}}{{ | ||
+ | #if: {{{function1.param5|}}} | ||
+ | |<li>'''{{{function1.param5.type}}} {{Pspan|{{{function1.param5}}}}}''': {{{function1.param3.description}}}</li>}}{{ | ||
+ | #if: {{{function1.param1|}}}|</ul>}}{{ | ||
#if: {{{function1.short_description|}}}|: {{{function1.short_description}}}}} | #if: {{{function1.short_description|}}}|: {{{function1.short_description}}}}} | ||
}} | }} | ||
Line 34: | Line 45: | ||
|'''<code>{{{function2.return_type}}} {{{name}}}({{ | |'''<code>{{{function2.return_type}}} {{{name}}}({{ | ||
#if: {{{function2.parameter1|}}} | #if: {{{function2.parameter1|}}} | ||
− | |{{ | + | |{{{User:Philmasterplus/FunctionDeclaration |
− | + | |name={{{name}}} | |
− | + | |return_type={{{function2.return_type1}}} | |
− | + | |param1={{{function2.param1}}} | |
− | + | |param1.type={{{function2.param1.type}}} | |
− | + | |param1.optional={{{function2.param1.optional}}} | |
− | + | |param1.default={{{function2.param1.default}}} | |
− | + | |param2={{{function2.param2}}} | |
− | + | |param2.type={{{function2.param2.type}}} | |
− | + | |param2.optional={{{function2.param2.optional}}} | |
− | + | |param2.default={{{function2.param2.default}}} | |
− | + | |param3={{{function2.param3}}} | |
− | + | |param3.type={{{function2.param3.type}}} | |
− | + | |param3.optional={{{function2.param3.optional}}} | |
− | + | |param3.default={{{function2.param3.default}}} | |
− | + | |param4={{{function2.param4}}} | |
− | + | |param4.type={{{function2.param4.type}}} | |
− | #if: {{{function2. | + | |param4.optional={{{function2.param4.optional}}} |
− | | | + | |param4.default={{{function2.param4.default}}} |
− | #if: {{{function2. | + | |param5={{{function2.param5}}} |
− | |<li>'''{{{function2. | + | |param5.type={{{function2.param5.type}}} |
− | #if: {{{function2. | + | |param5.optional={{{function2.param5.optional}}} |
− | |<li>'''{{{function2. | + | |param5.default={{{function2.param5.default}}} |
− | #if: {{{function2. | + | }})</code>'''{{ |
+ | #if: {{{function2.param1|}}} | ||
+ | |<ul><li>'''{{{function2.param1.type}}} {{Pspan|{{{function2.param1}}}}}''': {{{function2.param1.description}}}</li>}}{{ | ||
+ | #if: {{{function2.param2|}}} | ||
+ | |<li>'''{{{function2.param2.type}}} {{Pspan|{{{function2.param2}}}}}''': {{{function2.param2.description}}}</li>}}{{ | ||
+ | #if: {{{function2.param3|}}} | ||
+ | |<li>'''{{{function2.param3.type}}} {{Pspan|{{{function2.param3}}}}}''': {{{function2.param3.description}}}</li>}}{{ | ||
+ | #if: {{{function2.param4|}}} | ||
+ | |<li>'''{{{function2.param4.type}}} {{Pspan|{{{function2.param4}}}}}''': {{{function2.param4.description}}}</li>}}{{ | ||
+ | #if: {{{function2.param5|}}} | ||
+ | |<li>'''{{{function2.param5.type}}} {{Pspan|{{{function2.param5}}}}}''': {{{function2.param3.description}}}</li>}}{{ | ||
+ | #if: {{{function2.param1|}}}|</ul>}}{{ | ||
#if: {{{function2.short_description|}}}|: {{{function2.short_description}}}}} | #if: {{{function2.short_description|}}}|: {{{function2.short_description}}}}} | ||
}} | }} | ||
− | {{#if: {{{ | + | {{#if: {{{function3.return_type|}}} |
− | |'''<code>{{{ | + | |'''<code>{{{function3.return_type}}} {{{name}}}({{ |
− | #if: {{{ | + | #if: {{{function3.parameter1|}}} |
− | |{{ | + | |{{{User:Philmasterplus/FunctionDeclaration |
− | + | |name={{{name}}} | |
− | + | |return_type={{{function3.return_type1}}} | |
− | + | |param1={{{function3.param1}}} | |
− | + | |param1.type={{{function3.param1.type}}} | |
− | + | |param1.optional={{{function3.param1.optional}}} | |
− | + | |param1.default={{{function3.param1.default}}} | |
− | + | |param2={{{function3.param2}}} | |
− | + | |param2.type={{{function3.param2.type}}} | |
− | + | |param2.optional={{{function3.param2.optional}}} | |
− | + | |param2.default={{{function3.param2.default}}} | |
− | + | |param3={{{function3.param3}}} | |
− | + | |param3.type={{{function3.param3.type}}} | |
− | + | |param3.optional={{{function3.param3.optional}}} | |
− | + | |param3.default={{{function3.param3.default}}} | |
− | + | |param4={{{function3.param4}}} | |
− | + | |param4.type={{{function3.param4.type}}} | |
− | #if: {{{ | + | |param4.optional={{{function3.param4.optional}}} |
− | | | + | |param4.default={{{function3.param4.default}}} |
− | #if: {{{ | + | |param5={{{function3.param5}}} |
− | |<li>'''{{{ | + | |param5.type={{{function3.param5.type}}} |
− | #if: {{{ | + | |param5.optional={{{function3.param5.optional}}} |
− | |<li>'''{{{ | + | |param5.default={{{function3.param5.default}}} |
− | #if: {{{ | + | }})</code>'''{{ |
− | #if: {{{ | + | #if: {{{function3.param1|}}} |
+ | |<ul><li>'''{{{function3.param1.type}}} {{Pspan|{{{function3.param1}}}}}''': {{{function3.param1.description}}}</li>}}{{ | ||
+ | #if: {{{function3.param2|}}} | ||
+ | |<li>'''{{{function3.param2.type}}} {{Pspan|{{{function3.param2}}}}}''': {{{function3.param2.description}}}</li>}}{{ | ||
+ | #if: {{{function3.param3|}}} | ||
+ | |<li>'''{{{function3.param3.type}}} {{Pspan|{{{function3.param3}}}}}''': {{{function3.param3.description}}}</li>}}{{ | ||
+ | #if: {{{function3.param4|}}} | ||
+ | |<li>'''{{{function3.param4.type}}} {{Pspan|{{{function3.param4}}}}}''': {{{function3.param4.description}}}</li>}}{{ | ||
+ | #if: {{{function3.param5|}}} | ||
+ | |<li>'''{{{function3.param5.type}}} {{Pspan|{{{function3.param5}}}}}''': {{{function3.param3.description}}}</li>}}{{ | ||
+ | #if: {{{function3.param1|}}}|</ul>}}{{ | ||
+ | #if: {{{function3.short_description|}}}|: {{{function3.short_description}}}}} | ||
}} | }} | ||
{{#if: {{{code1|}}}|{{{code1}}}}}{{#if: {{{code2|}}}|{{{code2}}}}}{{#if: {{{code3|}}}|{{{code3}}}}}{{#if: {{{code4|}}}|{{{code4}}}}}{{#if: {{{code5|}}}|{{{code5}}}}} | {{#if: {{{code1|}}}|{{{code1}}}}}{{#if: {{{code2|}}}|{{{code2}}}}}{{#if: {{{code3|}}}|{{{code3}}}}}{{#if: {{{code4|}}}|{{{code4}}}}}{{#if: {{{code5|}}}|{{{code5}}}}} | ||
Line 115: | Line 148: | ||
"function1.short_description": { | "function1.short_description": { | ||
"label": "Function 1, short description", | "label": "Function 1, short description", | ||
− | "description": "Short description for the | + | "description": "Short description for the overloaded function 1 (and so on for functions 2 through 3)", |
"type": "content", | "type": "content", | ||
"example": "Visits a web page and returns its HTML source." | "example": "Visits a web page and returns its HTML source." | ||
Line 121: | Line 154: | ||
"function1.return_type": { | "function1.return_type": { | ||
"label": "Function 1, return type", | "label": "Function 1, return type", | ||
− | "description": "Return type of the | + | "description": "Return type of the overloaded function 1.", |
"required": true, | "required": true, | ||
"type": "line", | "type": "line", | ||
"example": "buffer" | "example": "buffer" | ||
}, | }, | ||
− | "function1. | + | "function1.param1": { |
"label": "Function 1, parameter 1", | "label": "Function 1, parameter 1", | ||
− | "description": "Name of the parameter 1 of the | + | "description": "Name of the parameter 1 of the overloaded function 1 (and so on for parameters 2 through 5).", |
"type": "line", | "type": "line", | ||
"example": "url" | "example": "url" | ||
}, | }, | ||
− | "function1. | + | "function1.param1.description": { |
"label": "Function 1, parameter 1 description", | "label": "Function 1, parameter 1 description", | ||
− | "description": "Description of parameter 1 of the | + | "description": "Description of parameter 1 of the overloaded function 1.", |
"type": "content", | "type": "content", | ||
"example": "URL of the page to visit. If a relative URL is provided, it is treated as an in-game page." | "example": "URL of the page to visit. If a relative URL is provided, it is treated as an in-game page." | ||
}, | }, | ||
− | "function1. | + | "function1.param1.optional": { |
"label": "Function 1, parameter 1 is optional?", | "label": "Function 1, parameter 1 is optional?", | ||
− | "description": " | + | "description": "\"yes\" = optional. Any non-empty string will do, but please use \"yes\" to make standardization easier.", |
− | + | "type": "line", | |
− | "type": " | + | "example": "yes" |
− | "example": " | ||
}, | }, | ||
− | "function1. | + | "function1.param1.default": { |
"label": "Function 1, parameter 1 default value", | "label": "Function 1, parameter 1 default value", | ||
− | "description": " | + | "description": "If this is specified, function1.param1.optional must be \"yes\"", |
"type": "line", | "type": "line", | ||
− | "example": " | + | "example": "\"\"" |
} | } | ||
} | } | ||
} | } | ||
</templatedata> | </templatedata> | ||
+ | |||
+ | ==Examples== | ||
</noinclude> | </noinclude> |
Revision as of 17:40, 18 December 2020
Replacement for Template:FunctionPage. Must be used with function pages that follow a specific format.
Parameter | Description | Type | Status | |
---|---|---|---|---|
ASH function name | name | Name of the ASH function. This should match the function page name.
| Line | required |
Function 1, short description | function1.short_description | Short description for the overloaded function 1 (and so on for functions 2 through 3)
| Content | optional |
Function 1, return type | function1.return_type | Return type of the overloaded function 1.
| 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).
| Line | optional |
Function 1, parameter 1 description | function1.param1.description | Description of parameter 1 of the overloaded function 1.
| 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.
| Line | optional |
Function 1, parameter 1 default value | function1.param1.default | If this is specified, function1.param1.optional must be "yes"
| Line | optional |