Template:BSLfuncinfo

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=
}}