GetLocalInt

Retrieves a local integer variable stored on an object.

int GetLocalInt(
object oObject,
string sVarName
);

Parameters:

oObject

The Object the variable is stored on

sVarName

The name of the integer variable to retrieve

Returns:

Returns the value of the integer variable. Returns 0 on error.

Source:

script.ldf

Description

Returns the value of the integer variable with the name sVarName which is stored on the object oObject. If no such variable is stored on the object oObject, 0 is returned.

To change the value of a local integer value, use SetLocalInt.

Remarks

All local variables must be predefined in the target object's variables 2da file before this function can be used successfully. If a local variable is not predefined this function will fail silently.

See also

SetLocalInt