Par (deprecated since 4.9.10.14 [355] LC)

Category: Script
Since engine version: 4.6.5.0 CP

Description

Returns the value of a parameter passed to the function.

Syntax

any Par (int iIndex);

Parameter

iIndex:
0-9: index of the requested parameter

Remark

This function was the only way to query the function parameters in the old (< gwe4) function syntax. With the new syntax the parameters can be assigned names, which is recommended in most cases. An exception is the use to form an index e.g. for iterations (see example)

Examples

private Multiply3:
  return(Par() * Par(1) * Par(2));
A function Multiply3, which multiplies its three parameters.
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)

Changelog

Date Author Version Description
14th September 2022 DerTod 4.9.10.14 [355] LC Deprecated: Instead of Par() the new function syntax should be used.
Sven2, August 2002