Construct 3 icon

Construct 3

Documentation

Effect instance script interface

Published 27 Apr, 2020
150 words
<1 min

The IEffectInstance script interface represents the parameters for a single effect on a IWorldInstance. It is typically accessed through the IWorldInstance effects property.

Effect APIs

index

The zero-based index of this effect, which is its index in the effects array on IWorldInstance.

name

A read-only string of the effect name.

isActive

A boolean indicating whether this effect is enabled or not. Inactive effects act the same as the effect being deleted, but the effect can later be reactivated if it is needed again. Note making effects inactive if they are not needed improves performance.

setParameter(index, value)

getParameter(index)

Set or get an effect parameter by the zero-based parameter index. Most parameters use a number as the value. Note however that color parameters are represented by an array with three elements, i.e. [r, g, b]. The R, G and B values are normalized to floats in the [0, 1] range.