SetEffectEngineFloat

Sets the specified float on the effect Engine Data structure.

effect SetEffectEngineFloat(
effect efEffect,
int nIndex,
float fValue
);

Parameters:

efEffect

The effect to set the value on

nIndex

The index of the value to set

fValue

The value to be set

Returns:

Returns the modified effect or an invalid effect on error.

Source:

script.ldf

Description

Sets the specified float on the effect.

Remarks

The effect Engine Data structure is used to communicate with the game engine and can only be written to and not read from scripting. It is distinct from general purpose Effect Data structure which was previously used to exchange information.

This function should not be confused with SetEffectFloat.

See also

• EFFECT_FLOAT_*
• effect_constants_h