Jump to content

Template:BSLfuncinfo: Difference between revisions

replaced Pipe template with built-in {{!}} magic word
m (replaced font style underlined with heavy)
(replaced Pipe template with built-in {{!}} magic word)
 
Line 4: Line 4:
|{{{type|}}}<!--
|{{{type|}}}<!--
-->{{#if:{{{arg1name|}}}|<br />
-->{{#if:{{{arg1name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg1optional|}}}|''|}}{{{arg1type|}}} {{#if:{{{arg1alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg1alttype|}}}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg1optional|}}}|''|}}{{{arg1type|}}} {{#if:{{{arg1alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg1alttype|}}}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}<!--
-->{{#if:{{{arg2name|}}}|<br />
-->{{#if:{{{arg2name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg2optional|}}}|''|}}{{{arg2type|}}} {{#if:{{{arg2alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg2alttype|}}}}}|{{#if:{{{arg1name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg2optional|}}}|''|}}{{{arg2type|}}} {{#if:{{{arg2alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg2alttype|}}}}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg3name|}}}|<br />
-->{{#if:{{{arg3name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg3optional|}}}|''|}}{{{arg3type|}}} {{#if:{{{arg3alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg3alttype|}}}}}|{{#if:{{{arg2name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg3optional|}}}|''|}}{{{arg3type|}}} {{#if:{{{arg3alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg3alttype|}}}}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg4name|}}}|<br />
-->{{#if:{{{arg4name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg4optional|}}}|''|}}{{{arg4type|}}} {{#if:{{{arg4alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg4alttype|}}}}}|{{#if:{{{arg3name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg4optional|}}}|''|}}{{{arg4type|}}} {{#if:{{{arg4alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg4alttype|}}}}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg5name|}}}|<br />
-->{{#if:{{{arg5name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg5optional|}}}|''|}}{{{arg5type|}}} {{#if:{{{arg5alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg5alttype|}}}}}|{{#if:{{{arg4name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg5optional|}}}|''|}}{{{arg5type|}}} {{#if:{{{arg5alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg5alttype|}}}}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg6name|}}}|<br />
-->{{#if:{{{arg6name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg6optional|}}}|''|}}{{{arg6type|}}} {{#if:{{{arg6alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg6alttype|}}}}}|{{#if:{{{arg5name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg6optional|}}}|''|}}{{{arg6type|}}} {{#if:{{{arg6alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg6alttype|}}}}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg7name|}}}|<br />
-->{{#if:{{{arg7name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg7optional|}}}|''|}}{{{arg7type|}}} {{#if:{{{arg7alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg7alttype|}}}}}|{{#if:{{{arg6name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg7optional|}}}|''|}}{{{arg7type|}}} {{#if:{{{arg7alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg7alttype|}}}}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg8name|}}}|<br />
-->{{#if:{{{arg8name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg8optional|}}}|''|}}{{{arg8type|}}} {{#if:{{{arg8alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg8alttype|}}}}}|{{#if:{{{arg7name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg8optional|}}}|''|}}{{{arg8type|}}} {{#if:{{{arg8alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg8alttype|}}}}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}
|-
|-
|'''{{{name}}}('''<!--
|'''{{{name}}}('''<!--
-->{{#if:{{{arg1name|}}}|<br /><!--                                  if this arg exists... -->
-->{{#if:{{{arg1name|}}}|<br /><!--                                  if this arg exists... -->
{{Pipe}}align="center"{{Pipe}}'''<!--                                create a cell, then...
{{!}}align="center"{{!}}'''<!--                                create a cell, then...
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              start italics if optional arg
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              start italics if optional arg
-->{{{arg1name|}}}<!--                                              print arg name
-->{{{arg1name|}}}<!--                                              print arg name
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
{{!}}''' );}}<!--                                                else if no args, just close parentheses
-->{{#if:{{{arg2name|}}}|<br />
-->{{#if:{{{arg2name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{{arg2name|}}}<!--
-->{{{arg2name|}}}<!--
Line 44: Line 44:
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg3name|}}}|, |}}|{{#if:{{{arg1name|}}}|<br />
-->{{#if:{{{arg3name|}}}|, |}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}}''' ); |}}}}<!--
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg3name|}}}|<br />
-->{{#if:{{{arg3name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{{arg3name|}}}<!--
-->{{{arg3name|}}}<!--
Line 52: Line 52:
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg4name|}}}|, |}}|{{#if:{{{arg2name|}}}|<br />
-->{{#if:{{{arg4name|}}}|, |}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}}''' ); |}}}}<!--
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg4name|}}}|<br />
-->{{#if:{{{arg4name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{{arg4name|}}}<!--
-->{{{arg4name|}}}<!--
Line 60: Line 60:
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg5name|}}}|, |}}|{{#if:{{{arg3name|}}}|<br />
-->{{#if:{{{arg5name|}}}|, |}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}}''' ); |}}}}<!--
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg5name|}}}|<br />
-->{{#if:{{{arg5name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{{arg5name|}}}<!--
-->{{{arg5name|}}}<!--
Line 68: Line 68:
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg6name|}}}|, |}}|{{#if:{{{arg4name|}}}|<br />
-->{{#if:{{{arg6name|}}}|, |}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}}''' ); |}}}}<!--
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg6name|}}}|<br />
-->{{#if:{{{arg6name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{{arg6name|}}}<!--
-->{{{arg6name|}}}<!--
Line 76: Line 76:
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg7name|}}}|, |}}|{{#if:{{{arg5name|}}}|<br />
-->{{#if:{{{arg7name|}}}|, |}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}}''' ); |}}}}<!--
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg7name|}}}|<br />
-->{{#if:{{{arg7name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{{arg7name|}}}<!--
-->{{{arg7name|}}}<!--
Line 84: Line 84:
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg8name|}}}|, |}}|{{#if:{{{arg6name|}}}|<br />
-->{{#if:{{{arg8name|}}}|, |}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}}''' ); |}}}}<!--
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg8name|}}}|<br />
-->{{#if:{{{arg8name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}'''<!--
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg8optional|}}}|''|}}<!--
-->{{#if:{{{arg8optional|}}}|''|}}<!--
-->{{{arg8name|}}}<!--
-->{{{arg8name|}}}<!--
-->{{#if:{{{arg8altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg8altname|}}}}}<!--
-->{{#if:{{{arg8altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg8altname|}}}}}<!--
-->{{#if:{{{arg8optional|}}}|''|}}|{{#if:{{{arg7name|}}}|<br />
-->{{#if:{{{arg8optional|}}}|''|}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}''' ); |}}}}
{{!}}''' ); |}}}}
|-
|-
|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
-->{{#if:{{{arg1default|}}}|<br />
-->{{#if:{{{arg1default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg1default|}}}|{{#if:{{{arg1name|}}}|<br />
{{!}}align="center"{{!}}{{{arg1default|}}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg2default|}}}|<br />
-->{{#if:{{{arg2default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg2default|}}}|{{#if:{{{arg2name|}}}|<br />
{{!}}align="center"{{!}}{{{arg2default|}}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg3default|}}}|<br />
-->{{#if:{{{arg3default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg3default|}}}|{{#if:{{{arg3name|}}}|<br />
{{!}}align="center"{{!}}{{{arg3default|}}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg4default|}}}|<br />
-->{{#if:{{{arg4default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg4default|}}}|{{#if:{{{arg4name|}}}|<br />
{{!}}align="center"{{!}}{{{arg4default|}}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg5default|}}}|<br />
-->{{#if:{{{arg5default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg5default|}}}|{{#if:{{{arg5name|}}}|<br />
{{!}}align="center"{{!}}{{{arg5default|}}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg6default|}}}|<br />
-->{{#if:{{{arg6default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg6default|}}}|{{#if:{{{arg6name|}}}|<br />
{{!}}align="center"{{!}}{{{arg6default|}}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg7default|}}}|<br />
-->{{#if:{{{arg7default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg7default|}}}|{{#if:{{{arg7name|}}}|<br />
{{!}}align="center"{{!}}{{{arg7default|}}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
-->{{#if:{{{arg8default|}}}|<br />
-->{{#if:{{{arg8default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg8default|}}}|{{#if:{{{arg8name|}}}|<br />
{{!}}align="center"{{!}}{{{arg8default|}}}|{{#if:{{{arg8name|}}}|<br />
{{Pipe}}align="center"{{Pipe}} --|}}|}}
{{!}}align="center"{{!}} --|}}|}}
|}</includeonly><noinclude>'''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.
|}</includeonly><noinclude>'''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.