SetLocal (deprecated)

Category: Variables
Since engine version: 4.6.5.0 CP (extended in 4.9.1.0 GWE)

Description

Sets a Local variable in an object (if no object is specified the variable is set in the calling object) and returns the set value on success (otherwise 0).

Syntax

any& SetLocal (int iVarIndex, any Value, object pObj);

Parameters

iVarIndex:
Index of the variable to be accessed. Any non-negative number is allowed.
Value:
New value of the variable.
pObj:
[optional] Object in which the variable is to be set

Remark

Instead of SetLocal the notation Local(x) = y should be used to access local variables.

Changelog

Date Author Version Description
24th December 2022 Funni unknown Deprecated: Instead of SetLocal the notation Local(x) = y should be used to access local variables.
See also: Global, GlobalN, Local, LocalN, SetGlobal, SetVar, Var, VarN
PeterW, December 2001