Template:BSLfuncinfo: Difference between revisions
("return_default" is now "default", and now documented as well) |
("default" now in sample call; now shows "--" when no default value is given) |
||
| Line 40: | Line 40: | ||
|- | |- | ||
|default: | |default: | ||
|{{#if:{{{default|}}}|{{#ifeq:{{{type|}}}|void|error: a void function cannot have a return value|{{{default|}}}}}}} | |{{#if:{{{default|}}}|{{#ifeq:{{{type|}}}|void|error: a void function cannot have a return value|{{{default|}}}}}| --}} | ||
|align="center"|{{{arg1default|}}} | |align="center"|{{{arg1default|{{#if:{{{arg1name|}}}| --|}}}}} | ||
|align="center"|{{{arg2default|}}} | |align="center"|{{{arg2default|{{#if:{{{arg2name|}}}| --|}}}}} | ||
|align="center"|{{{arg3default|}}} | |align="center"|{{{arg3default|{{#if:{{{arg3name|}}}| --|}}}}} | ||
|align="center"|{{{arg4default|}}} | |align="center"|{{{arg4default|{{#if:{{{arg4name|}}}| --|}}}}} | ||
|}</includeonly><noinclude> | |}</includeonly><noinclude> | ||
| Line 54: | Line 54: | ||
;<tt>default</tt> | ;<tt>default</tt> | ||
:Default return value of function, if there is one at the time the level starts | :Default return value of function, if there is one at the time the level starts. | ||
;<tt>name</tt> | ;<tt>name</tt> | ||
| Line 84: | Line 84: | ||
<nowiki>{{</nowiki>BSLfunc | <nowiki>{{</nowiki>BSLfunc | ||
|type= | |type= | ||
|default= | |||
|name= | |name= | ||
|mac= | |mac= | ||
Revision as of 22:41, 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".
- 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.
- 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=
|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=
}}