EffectVar

Category: Effects
Since engine version: 4.9.5.0 CE

Description

Returns a reference to an effect local variable. This reference can be used to read or write values.

Syntax

&EffectVar (int iVarIndex, object pTarget, int iNumber);

Parameters

iVarIndex:
Index of the variable. Theoretically, any number of variables can be used. As, however, any newly accessed variable has to internally allocated first, you should only use as many variables as really necessary.
pTarget:
[opt] Target object of the effect the of which you want to access variables. 0 for global effects.
iNumber:
Effect number. Effect numbers are passed to effect callback functions, they are the return values of AddEffect and can be determined from an effect name via GetEffect.

Remark

For examples and more information see the effects documentation.
See also: AddEffect, ChangeEffect, CheckEffect, EffectCall, Effects Documentation, GetEffect, GetEffectCount, RemoveEffect
Sven2, März 2004