OniGalore

Template:BSLfuncinfo: Difference between revisions

Template Discussion

Template:BSLfuncinfo (view source)

Revision as of 21:37, 22 April 2025

4,344 bytes removed ,  22 April
replaced Pipe template with built-in {{!}} magic word
No edit summary
(replaced Pipe template with built-in {{!}} magic word)
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{Anchor|{{{name|placeholder}}}}}<only<noinclude></noinclude>include>
<includeonly>{{Anchor|{{{name|placeholder}}}}}
{| class="BSLFuncInfo"
|-
|-
|style="font-family:cursive; font-weight:bold" align="center"|f
|{{{type|}}}<!--
|{{{type|}}}
-->{{#if:{{{arg1name|}}}|<br />
|[[Group Name#{{{name|}}}|{{{name|}}}]]
{{!}}align="center"{{!}}{{#if:{{{arg1optional|}}}|''|}}{{{arg1type|}}} {{#if:{{{arg1alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg1alttype|}}}}}|<br />
|align="center" data-sort-value="wm"|[[Image:Platform-Win.png|20px]] [[Image:Platform-Mac.png|20px]]
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}<!--
</only<noinclude></noinclude>include>{|
-->{{#if:{{{arg2name|}}}|<br />
!<!--"type" label, OS icons, "default" label-->
{{!}}align="center"{{!}}{{#if:{{{arg2optional|}}}|''|}}{{{arg2type|}}} {{#if:{{{arg2alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg2alttype|}}}}}|{{#if:{{{arg1name|}}}|<br />
!<!--func type, name, default return value-->
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
!<!--arg 1 type, name, default value-->
-->{{#if:{{{arg3name|}}}|<br />
!<!--arg 2 type, name, default value-->
{{!}}align="center"{{!}}{{#if:{{{arg3optional|}}}|''|}}{{{arg3type|}}} {{#if:{{{arg3alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg3alttype|}}}}}|{{#if:{{{arg2name|}}}|<br />
!<!--arg 3 type, name, default value-->
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
!<!--arg 4 type, name, default value-->
-->{{#if:{{{arg4name|}}}|<br />
!<!--arg 5 type, name, default value-->
{{!}}align="center"{{!}}{{#if:{{{arg4optional|}}}|''|}}{{{arg4type|}}} {{#if:{{{arg4alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg4alttype|}}}}}|{{#if:{{{arg3name|}}}|<br />
!<!--arg 6 type, name, default value-->
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
!<!--arg 7 type, name, default value-->
-->{{#if:{{{arg5name|}}}|<br />
!<!--arg 8 type, name, default value-->
{{!}}align="center"{{!}}{{#if:{{{arg5optional|}}}|''|}}{{{arg5type|}}} {{#if:{{{arg5alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg5alttype|}}}}}|{{#if:{{{arg4name|}}}|<br />
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg6name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg6optional|}}}|''|}}{{{arg6type|}}} {{#if:{{{arg6alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg6alttype|}}}}}|{{#if:{{{arg5name|}}}|<br />
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg7name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg7optional|}}}|''|}}{{{arg7type|}}} {{#if:{{{arg7alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg7alttype|}}}}}|{{#if:{{{arg6name|}}}|<br />
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg8name|}}}|<br />
{{!}}align="center"{{!}}{{#if:{{{arg8optional|}}}|''|}}{{{arg8type|}}} {{#if:{{{arg8alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg8alttype|}}}}}|{{#if:{{{arg7name|}}}|<br />
{{!}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}
|-
|-
|type:
|'''{{{name}}}('''<!--
|{{{type|}}}
-->{{#if:{{{arg1name|}}}|<br /><!--                                  if this arg exists... -->
|align="center"|{{{arg1type|}}} {{#if:{{{arg1alttype|}}}|<u>or</u> {{{arg1alttype|}}}}} {{#if:{{{arg1optional|}}}|(optional)|}}
{{!}}align="center"{{!}}'''<!--                                create a cell, then...
|align="center"|{{{arg2type|}}} {{#if:{{{arg2alttype|}}}|<u>or</u> {{{arg2alttype|}}}}} {{#if:{{{arg2optional|}}}|(optional)|}}
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              start italics if optional arg
|align="center"|{{{arg3type|}}} {{#if:{{{arg3alttype|}}}|<u>or</u> {{{arg3alttype|}}}}} {{#if:{{{arg3optional|}}}|(optional)|}}
-->{{{arg1name|}}}<!--                                              print arg name
|align="center"|{{{arg4type|}}} {{#if:{{{arg4alttype|}}}|<u>or</u> {{{arg4alttype|}}}}} {{#if:{{{arg4optional|}}}|(optional)|}}
-->{{#if:{{{arg1altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg1altname|}}}}}<!-- print " or " and alternate arg name if supplied
|align="center"|{{{arg5type|}}} {{#if:{{{arg5alttype|}}}|<u>or</u> {{{arg5alttype|}}}}} {{#if:{{{arg5optional|}}}|(optional)|}}
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              end italics if optional arg
|align="center"|{{{arg6type|}}} {{#if:{{{arg6alttype|}}}|<u>or</u> {{{arg6alttype|}}}}} {{#if:{{{arg6optional|}}}|(optional)|}}
-->{{#if:{{{arg2name|}}}|, |}}|<br /><!--                            and if there is a next arg, print a comma -->
|align="center"|{{{arg7type|}}} {{#if:{{{arg7alttype|}}}|<u>or</u> {{{arg7alttype|}}}}} {{#if:{{{arg7optional|}}}|(optional)|}}
{{!}}''' );}}<!--                                                else if no args, just close parentheses
|align="center"|{{{arg8type|}}} {{#if:{{{arg8alttype|}}}|<u>or</u> {{{arg8alttype|}}}}} {{#if:{{{arg8optional|}}}|(optional)|}}
-->{{#if:{{{arg2name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{{arg2name|}}}<!--
-->{{#if:{{{arg2altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg2altname|}}}}}<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg3name|}}}|, |}}|{{#if:{{{arg1name|}}}|<br />
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg3name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{{arg3name|}}}<!--
-->{{#if:{{{arg3altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg3altname|}}}}}<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg4name|}}}|, |}}|{{#if:{{{arg2name|}}}|<br />
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg4name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{{arg4name|}}}<!--
-->{{#if:{{{arg4altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg4altname|}}}}}<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg5name|}}}|, |}}|{{#if:{{{arg3name|}}}|<br />
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg5name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{{arg5name|}}}<!--
-->{{#if:{{{arg5altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg5altname|}}}}}<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg6name|}}}|, |}}|{{#if:{{{arg4name|}}}|<br />
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg6name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{{arg6name|}}}<!--
-->{{#if:{{{arg6altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg6altname|}}}}}<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg7name|}}}|, |}}|{{#if:{{{arg5name|}}}|<br />
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg7name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{{arg7name|}}}<!--
-->{{#if:{{{arg7altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg7altname|}}}}}<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg8name|}}}|, |}}|{{#if:{{{arg6name|}}}|<br />
{{!}}''' ); |}}}}<!--
-->{{#if:{{{arg8name|}}}|<br />
{{!}}align="center"{{!}}'''<!--
-->{{#if:{{{arg8optional|}}}|''|}}<!--
-->{{{arg8name|}}}<!--
-->{{#if:{{{arg8altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg8altname|}}}}}<!--
-->{{#if:{{{arg8optional|}}}|''|}}|{{#if:{{{arg7name|}}}|<br />
{{!}}''' ); |}}}}
|-
|-
|{{#ifeq:{{{mac|yes}}}|no|{{#ifeq:{{{win|yes}}}|no|[[Image:Cmbox deletion.png|20px]]                                <!--if neither platform, show error icon
|default: {{#if:{{{default|}}}|{{{default|}}}| --}}<!-- print "--" if there is no default return value for function
                                              -->|[[Image:Platform-Win.png|20px]] [[Image:Platform-empty.png|20px]] <!--if only Win, show Win and blank icon
-->{{#if:{{{arg1default|}}}|<br />
                      -->}}<!--
{{!}}align="center"{{!}}{{{arg1default|}}}|{{#if:{{{arg1name|}}}|<br />
                      -->|{{#ifeq:{{{win|yes}}}|no|[[Image:Platform-empty.png|20px]] [[Image:Platform-Mac.png|20px]] <!--if only Mac, show blank and Mac icon
{{!}}align="center"{{!}} --|}}|}}<!--
                                              -->|[[Image:Platform-Win.png|20px]] [[Image:Platform-Mac.png|20px]]  <!--if both platforms, show both icons
-->{{#if:{{{arg2default|}}}|<br />
                      -->}}<!--
{{!}}align="center"{{!}}{{{arg2default|}}}|{{#if:{{{arg2name|}}}|<br />
-->}}
{{!}}align="center"{{!}} --|}}|}}<!--
|style="font-size:166%; vertical-align:bottom"|{{{name}}}(
-->{{#if:{{{arg3default|}}}|<br />
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
{{!}}align="center"{{!}}{{{arg3default|}}}|{{#if:{{{arg3name|}}}|<br />
                                            -->{{#if:{{{arg1name|}}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
                                                -->|{{#if:{{{arg1optional|}}}|''|}}<!--        start italics if optional arg
-->{{#if:{{{arg4default|}}}|<br />
                                                  -->{{{arg1name|}}}<!--                        print arg 1 name if supplied
{{!}}align="center"{{!}}{{{arg4default|}}}|{{#if:{{{arg4name|}}}|<br />
                                                  -->{{#if:{{{arg1altname|}}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg1altname|}}}<!--print alternative arg 1 if present
-->{{#if:{{{arg5default|}}}|<br />
                                                      -->|<!--
{{!}}align="center"{{!}}{{{arg5default|}}}|{{#if:{{{arg5name|}}}|<br />
                                                  -->}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
                                                  -->{{#if:{{{arg1optional|}}}|''|}}<!--        end italics if optional arg
-->{{#if:{{{arg6default|}}}|<br />
                                                  -->{{#if:{{{arg2name|}}}|, |}}<!--             if there is a next arg, print comma
{{!}}align="center"{{!}}{{{arg6default|}}}|{{#if:{{{arg6name|}}}|<br />
                                                -->| );<!--                                     if no args, just close parentheses
{{!}}align="center"{{!}} --|}}|}}<!--
                                            -->}}
-->{{#if:{{{arg7default|}}}|<br />
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
{{!}}align="center"{{!}}{{{arg7default|}}}|{{#if:{{{arg7name|}}}|<br />
                                            -->{{#if:{{{arg2name|}}}<!--
{{!}}align="center"{{!}} --|}}|}}<!--
                                                -->|{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg8default|}}}|<br />
                                                  -->{{{arg2name|}}}<!--
{{!}}align="center"{{!}}{{{arg8default|}}}|{{#if:{{{arg8name|}}}|<br />
                                                  -->{{#if:{{{arg2altname|}}}<!--
{{!}}align="center"{{!}} --|}}|}}
                                                      -->|&nbsp;<u>or</u> {{{arg2altname|}}}<!--
|}</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.
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg2optional|}}}|''|}}<!--
                                                  -->{{#if:{{{arg3name|}}}|, |}}<!--
                                                -->|{{#if:{{{arg1name|}}}| ); |}}<!--          if this was last arg, close parentheses
                                            -->}}
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
                                            -->{{#if:{{{arg3name|}}}<!--
                                                -->|{{#if:{{{arg3optional|}}}|''|}}<!--
                                                  -->{{{arg3name|}}}<!--
                                                  -->{{#if:{{{arg3altname|}}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg3altname|}}}<!--
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg3optional|}}}|''|}}<!--
                                                  -->{{#if:{{{arg4name|}}}|, |}}<!--
                                                -->|{{#if:{{{arg2name|}}}| ); |}}<!--
                                            -->}}
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
                                            -->{{#if:{{{arg4name|}}}<!--
                                                -->|{{#if:{{{arg4optional|}}}|''|}}<!--
                                                  -->{{{arg4name|}}}<!--
                                                  -->{{#if:{{{arg4altname|}}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg4altname|}}}<!--
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg4optional|}}}|''|}}<!--
                                                  -->{{#if:{{{arg5name|}}}|, |}}<!--
                                                -->|{{#if:{{{arg3name|}}}| ); |}}<!--
                                            -->}}
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
                                            -->{{#if:{{{arg5name|}}}<!--
                                                -->|{{#if:{{{arg5optional|}}}|''|}}<!--
                                                  -->{{{arg5name|}}}<!--
                                                  -->{{#if:{{{arg5altname|}}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg5altname|}}}<!--
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg5optional|}}}|''|}}<!--
                                                  -->{{#if:{{{arg6name|}}}|, |}}<!--
                                                -->|{{#if:{{{arg4name|}}}| ); |}}<!--
                                            -->}}
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
                                            -->{{#if:{{{arg6name|}}}<!--
                                                -->|{{#if:{{{arg6optional|}}}|''|}}<!--
                                                  -->{{{arg6name|}}}<!--
                                                  -->{{#if:{{{arg6altname|}}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg6altname|}}}<!--
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg6optional|}}}|''|}}<!--
                                                  -->{{#if:{{{arg7name|}}}|, |}}<!--
                                                -->|{{#if:{{{arg5name|}}}| ); |}}<!--
                                            -->}}
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
                                            -->{{#if:{{{arg7name|}}}<!--
                                                -->|{{#if:{{{arg7optional|}}}|''|}}<!--
                                                  -->{{{arg7name|}}}<!--
                                                  -->{{#if:{{{arg7altname|}}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg7altname|}}}<!--
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg7optional|}}}|''|}}<!--
                                                  -->{{#if:{{{arg8name|}}}|, |}}<!--
                                                -->|{{#if:{{{arg6name|}}}| ); |}}<!--
                                            -->}}
|align="center" style="font-size:166%; vertical-align:bottom"|<!--
                                            -->{{#if:{{{arg8name|}}}<!--
                                                -->|{{#if:{{{arg8optional|}}}|''|}}<!--
                                                  -->{{{arg8name|}}}<!--
                                                  -->{{#if:{{{arg8altname|}}}<!--
                                                      -->|&nbsp;<u>or</u> {{{arg8altname|}}}<!--
                                                      -->|<!--
                                                  -->}}<!--
                                                  -->{{#if:{{{arg8optional|}}}|''|}}<!-- no check for comma after this since this is the last possible arg
                                                -->|{{#if:{{{arg7name|}}}| ); |}}<!--
                                            -->}}
|-
|default:
|              {{#if:{{{default|}}}    |{{{default|}}}| --}}                              <!-- print "--" if there is no default return value for function -->
|align="center"|{{#if:{{{arg1default|}}}|{{{arg1default|}}}|{{#if:{{{arg1name|}}}| --|}}|}} <!-- print "--" if there is arg in this position with no default -->
|align="center"|{{#if:{{{arg2default|}}}|{{{arg2default|}}}|{{#if:{{{arg2name|}}}| --|}}|}}
|align="center"|{{#if:{{{arg3default|}}}|{{{arg3default|}}}|{{#if:{{{arg3name|}}}| --|}}|}}
|align="center"|{{#if:{{{arg4default|}}}|{{{arg4default|}}}|{{#if:{{{arg4name|}}}| --|}}|}}
|align="center"|{{#if:{{{arg5default|}}}|{{{arg5default|}}}|{{#if:{{{arg5name|}}}| --|}}|}}
|align="center"|{{#if:{{{arg6default|}}}|{{{arg6default|}}}|{{#if:{{{arg6name|}}}| --|}}|}}
|align="center"|{{#if:{{{arg7default|}}}|{{{arg7default|}}}|{{#if:{{{arg7name|}}}| --|}}|}}
|align="center"|{{#if:{{{arg8default|}}}|{{{arg8default|}}}|{{#if:{{{arg8name|}}}| --|}}|}}
|}</includeonly><noinclude>'''BSLfunc''' 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 '''BSLfunc''' 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:
Parameters:
Line 175: Line 151:
:If a BSL function can take more than one kind of data in a given argument position, give the second argument name here.
: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]].
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.


  <nowiki>{{</nowiki>BSLfunc
  <nowiki>{{</nowiki>BSLfuncinfo
  |type=
  |type=
  |default=
  |default=
Line 209: Line 185:
  <nowiki>}}</nowiki>
  <nowiki>}}</nowiki>


[[Category:Basic formatting templates]]</noinclude>
[[Category:Table templates]]</noinclude>
Retrieved from "https://wiki.oni2.net/Special:MobileDiff/24675...44779"