Category: Script
Since engine version: 1.0 OC
Par
Description
Returns the value of a parameter passed to the function.
Syntax
any Par(int index);
Parameter
- index:
- 0-9: index of the requested parameter
Remark
In old times, this was the only method to access function parameters. The new script style allows naming of parameters which makes declaration and access much more convenient.
Example
private func Multiply3(v1, v2, v3)
{
return v1 * v2 * v3;
}
The same function with new style syntax.
private func MultiplyX(cnt)
{
var x = 1;
for(var i = 0; i < cnt; i++)
x *= Par(i + 1);
return x;
}
An example for mixed use of named and indexed parameters: this function can multiply up to 0 numbers. The first parameter is the count of following parameters to be multiplied (e.g. MultiplyX(4, 10, 3, 4, 7) = 10 * 3 * 4 * 7 = 840)