Template:BSLfuncinfo: Difference between revisions
(+docs) |
(+sample call) |
||
| Line 59: | Line 59: | ||
:You don't have to use these unless the function is <u>not</u> available and working on one platform; set the appropriate parameter(s) to "no" if that is the case. | :You don't have to use these unless the function is <u>not</u> available and working on one platform; set the appropriate parameter(s) to "no" if that is the case. | ||
;<tt> | ;<tt>arg1optional</tt>, <tt>arg2optional</tt>, <tt>arg3optional</tt>, <tt>arg4optional</tt> | ||
:If | :If this argument can be omitted, set this to "yes". | ||
;<tt>arg1default</tt>, <tt>arg2default</tt>, <tt>arg3default</tt>, <tt>arg4default</tt> | |||
:Optional arguments have default assumed values that are used when the argument is not used explicitly; give those values here. | |||
;<tt>arg1type</tt>, <tt>arg2type</tt>, <tt>arg3type</tt>, <tt>arg4type</tt> | ;<tt>arg1type</tt>, <tt>arg2type</tt>, <tt>arg3type</tt>, <tt>arg4type</tt> | ||
:If these arguments to the BSL function exist, give their types here. | :If these arguments to the BSL function exist, give their types here. | ||
;<tt> | ;<tt>arg1name</tt>, <tt>arg2name</tt>, <tt>arg3name</tt>, <tt>arg4name</tt> | ||
:If | :If these arguments to the BSL function exist, give their names here. | ||
;<tt> | ;<tt>arg1alttype</tt>, <tt>arg2alttype</tt>, <tt>arg3alttype</tt>, <tt>arg4alttype</tt> | ||
: | :If a BSL function can take more than one kind of data in a given argument position, give the second argument type here. | ||
;<tt>arg1altname</tt>, <tt>arg2altname</tt>, <tt>arg3altname</tt>, <tt>arg4altname</tt> | ;<tt>arg1altname</tt>, <tt>arg2altname</tt>, <tt>arg3altname</tt>, <tt>arg4altname</tt> | ||
: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. | ||
Here's a default blank call with all parameters: | |||
<nowiki>{{</nowiki>BSLfunc | |||
|type= | |||
|name= | |||
|mac= | |||
|win=<br /> | |||
|arg1optional= | |||
|arg1default= | |||
|arg1type= | |||
|arg1name= | |||
|arg1alttype= | |||
|arg1altname=<br /> | |||
|arg2optional= | |||
|arg2default= | |||
|arg2type= | |||
|arg2name= | |||
|arg2alttype= | |||
|arg2altname=<br /> | |||
|arg3optional= | |||
|arg3default= | |||
|arg3type= | |||
|arg3name= | |||
|arg3alttype= | |||
|arg3altname=<br /> | |||
|arg4optional= | |||
|arg4default= | |||
|arg4type= | |||
|arg4name= | |||
|arg4alttype= | |||
|arg4altname= | |||
<nowiki>}}</nowiki> | |||
[[Category:Basic formatting templates]]</noinclude> | [[Category:Basic formatting templates]]</noinclude> | ||
Revision as of 22:27, 13 November 2015
BSLfunc allows for standardized listing of BSL functions. The assumption at the moment is that the most arguments a function can take is four; this will be raised if some functions are discovered to take more arguments.
Parameters:
- type
- Return type of function; should be "int", "string", "float", "bool", or "void".
- 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.
- arg1optional, arg2optional, arg3optional, arg4optional
- If this argument can be omitted, set this to "yes".
- arg1default, arg2default, arg3default, arg4default
- Optional arguments have default assumed values that are used when the argument is not used explicitly; give those values here.
- arg1type, arg2type, arg3type, arg4type
- If these arguments to the BSL function exist, give their types here.
- arg1name, arg2name, arg3name, arg4name
- If these arguments to the BSL function exist, give their names here.
- arg1alttype, arg2alttype, arg3alttype, arg4alttype
- If a BSL function can take more than one kind of data in a given argument position, give the second argument type here.
- arg1altname, arg2altname, arg3altname, arg4altname
- If a BSL function can take more than one kind of data in a given argument position, give the second argument name here.
Here's a default blank call with all parameters:
{{BSLfunc
|type=
|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=
}}