GetLocalEffect

Gets a local effect variable on an object.

effect GetLocalEffect(
object oObject,
string sVarName
);

Parameters:

oObject

Object to get the variable from

sVarName

The name of the variable to retrieve

Returns:

Returns an effect variable, returns an invalid effect on error.

Source:

script.ldf

Description

Gets a local effect variable sVarName on the specified object.

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.

It should be noted that effects taken from current effects on an object are just copies of those effects, not references to them.

See also

SetLocalEffect