The "sys_effect_perform" Function

Syntax#

sys_effect_perform(index, x, y);
ArgumentTypeDescription
indexintegerThe index of the row containing the target entity
xrealThe global horizontal offset to display all effects
yrealThe global vertical offset to display all effects

Description#

Performs effects which have been initialized with vngen_effect_start. Also returns true or false depending on whether the effect is active.

As this script is run automatically by vngen_object_draw, it is never necessary to run sys_effect_perform manually.

Note that the offsets supplied here only provide input values to effect scripts. Actually using these offsets is voluntary.

See Effects for a list of included animation scripts and how to make your own.