Skip to main content

The "vngen_effect_start" Function

Syntax#

vngen_effect_start(id, effect, duration, loop, reverse, [ease]);
ArgumentTypeDescription
idreal/stringThe unique identifier to use for the new effect
effectscriptThe effect script to perform
durationrealSets the duration of the entire effect
loopbooleanEnables or disables looping the effect
reversebooleanEnables or disables performing the effect in reverse keyframe order
[ease]integer/macroOptional: Sets the ease override for the effect script

Description#

Performs a keyframe effect script with the input duration. As effects are independent, unlike animations and modifications, multiple effects can be performed simultaneously.

See Included Effects for a list of included effect scripts and how to create your own, and Macros & Keywords for a list of available ease modes.

Example#

vngen_event() {
vngen_effect_start("ef", ef_scrn_flash, 0.5, false, false);
}