Template:BSLfuncinfo: Difference between revisions
Jump to navigation
Jump to search
(and to final row) |
(fixing bold markup, and removing an unclosed comment) |
||
| Line 36: | Line 36: | ||
-->{{#if:{{{arg1optional|}}}|''|}}<!-- end italics if optional arg | -->{{#if:{{{arg1optional|}}}|''|}}<!-- end italics if optional arg | ||
-->{{#if:{{{arg2name|}}}|, |}}|<br /><!-- and if there is a next arg, print a comma --> | -->{{#if:{{{arg2name|}}}|, |}}|<br /><!-- and if there is a next arg, print a comma --> | ||
{{Pipe}} );}}<!-- else if no args, just close parentheses | {{Pipe}}''' );}}<!-- else if no args, just close parentheses | ||
-->{{#if:{{{arg2name|}}}|<br /> | -->{{#if:{{{arg2name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 44: | Line 44: | ||
-->{{#if:{{{arg2optional|}}}|''|}}<!-- | -->{{#if:{{{arg2optional|}}}|''|}}<!-- | ||
-->{{#if:{{{arg3name|}}}|, |}}|<br /> | -->{{#if:{{{arg3name|}}}|, |}}|<br /> | ||
{{Pipe}}{{#if:{{{arg1name|}}}| ); |}}}}<!-- if this was last arg, close parentheses | {{Pipe}}{{#if:{{{arg1name|}}}|''' ); |}}}}<!-- if this was last arg, close parentheses | ||
-->{{#if:{{{arg3name|}}}|<br /> | -->{{#if:{{{arg3name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 52: | Line 52: | ||
-->{{#if:{{{arg3optional|}}}|''|}}<!-- | -->{{#if:{{{arg3optional|}}}|''|}}<!-- | ||
-->{{#if:{{{arg4name|}}}|, |}}|<br /> | -->{{#if:{{{arg4name|}}}|, |}}|<br /> | ||
{{Pipe}}{{#if:{{{arg2name|}}}| ); |}}}}<!-- | {{Pipe}}{{#if:{{{arg2name|}}}|''' ); |}}}}<!-- | ||
-->{{#if:{{{arg4name|}}}|<br /> | -->{{#if:{{{arg4name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 60: | Line 60: | ||
-->{{#if:{{{arg4optional|}}}|''|}}<!-- | -->{{#if:{{{arg4optional|}}}|''|}}<!-- | ||
-->{{#if:{{{arg5name|}}}|, |}}|<br /> | -->{{#if:{{{arg5name|}}}|, |}}|<br /> | ||
{{Pipe}}{{#if:{{{arg3name|}}}| ); |}}}}<!-- | {{Pipe}}{{#if:{{{arg3name|}}}|''' ); |}}}}<!-- | ||
-->{{#if:{{{arg5name|}}}|<br /> | -->{{#if:{{{arg5name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 68: | Line 68: | ||
-->{{#if:{{{arg5optional|}}}|''|}}<!-- | -->{{#if:{{{arg5optional|}}}|''|}}<!-- | ||
-->{{#if:{{{arg6name|}}}|, |}}|<br /> | -->{{#if:{{{arg6name|}}}|, |}}|<br /> | ||
{{Pipe}}{{#if:{{{arg4name|}}}| ); |}}}}<!-- | {{Pipe}}{{#if:{{{arg4name|}}}|''' ); |}}}}<!-- | ||
-->{{#if:{{{arg6name|}}}|<br /> | -->{{#if:{{{arg6name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 76: | Line 76: | ||
-->{{#if:{{{arg6optional|}}}|''|}}<!-- | -->{{#if:{{{arg6optional|}}}|''|}}<!-- | ||
-->{{#if:{{{arg7name|}}}|, |}}|<br /> | -->{{#if:{{{arg7name|}}}|, |}}|<br /> | ||
{{Pipe}}{{#if:{{{arg5name|}}}| ); |}}}}<!-- | {{Pipe}}{{#if:{{{arg5name|}}}|''' ); |}}}}<!-- | ||
-->{{#if:{{{arg7name|}}}|<br /> | -->{{#if:{{{arg7name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 84: | Line 84: | ||
-->{{#if:{{{arg7optional|}}}|''|}}<!-- | -->{{#if:{{{arg7optional|}}}|''|}}<!-- | ||
-->{{#if:{{{arg8name|}}}|, |}}|<br /> | -->{{#if:{{{arg8name|}}}|, |}}|<br /> | ||
{{Pipe}}{{#if:{{{arg6name|}}}| ); |}}}}<!-- | {{Pipe}}{{#if:{{{arg6name|}}}|''' ); |}}}}<!-- | ||
-->{{#if:{{{arg8name|}}}|<br /> | -->{{#if:{{{arg8name|}}}|<br /> | ||
{{Pipe}}align="center"{{Pipe}}'''<!-- | {{Pipe}}align="center"{{Pipe}}'''<!-- | ||
| Line 90: | Line 90: | ||
-->{{{arg8name|}}}<!-- | -->{{{arg8name|}}}<!-- | ||
-->{{#if:{{{arg8altname|}}}| <u>or</u> {{{arg8altname|}}}}}<!-- | -->{{#if:{{{arg8altname|}}}| <u>or</u> {{{arg8altname|}}}}}<!-- | ||
-->{{#if:{{{arg8optional|}}}|''|}}|<br /> | -->{{#if:{{{arg8optional|}}}|''|}}|<br /> | ||
{{Pipe}}{{#if:{{{arg7name|}}}| ); |}}}} | {{Pipe}}{{#if:{{{arg7name|}}}|''' ); |}}}} | ||
|- | |- | ||
|default: {{#if:{{{default|}}}|{{{default|}}}| --}}<!-- print "--" if there is no default return value for function | |default: {{#if:{{{default|}}}|{{{default|}}}| --}}<!-- print "--" if there is no default return value for function | ||
Revision as of 05:05, 22 December 2015
BSLfuncinfo allows for standardized listing of BSL functions. Since BSL allows for functions to take up to eight arguments, and each argument can be described here by up to six parameters, this makes BSLfuncinfo the most complex template on the wiki. However, you'll rarely need to use more than a few of these parameters to describe an average function.
Parameters:
- type
- Return type of function; should be "int", "string", "float", "bool", or "void".
- default
- Default return value of function, if there is one at the time the level starts.
- name
- Name of function.
- mac, win
- You don't have to use these unless the function is not available and working on one platform; set the appropriate parameter(s) to "no" if that is the case.
- arg[1-8]optional
- If this argument can be omitted, set this to "yes".
- arg[1-8]default
- Optional arguments have default assumed values that are used when the argument is not provided; give those values here.
- arg[1-8]type
- If these arguments to the BSL function exist, give their types here.
- arg[1-8]name
- If these arguments to the BSL function exist, give their names here.
- arg[1-8]alttype
- If a BSL function can take more than one kind of data in a given argument position, give the second argument type here.
- arg[1-8]altname
- If a BSL function can take more than one kind of data in a given argument position, give the second argument name here.
Below is a default blank call for all parameters up through the fourth function argument, to save some time. You can omit any parameters you don't need when adding this template to a page. However, you may find it easier to use the GUI for this template that is provided by XEB.
{{BSLfuncinfo
|type=
|default=
|name=
|mac=
|win=
|arg1optional=
|arg1default=
|arg1type=
|arg1name=
|arg1alttype=
|arg1altname=
|arg2optional=
|arg2default=
|arg2type=
|arg2name=
|arg2alttype=
|arg2altname=
|arg3optional=
|arg3default=
|arg3type=
|arg3name=
|arg3alttype=
|arg3altname=
|arg4optional=
|arg4default=
|arg4type=
|arg4name=
|arg4alttype=
|arg4altname=
}}