Skip to main content

The "vngen_prompt_replace_ext" Function

Syntax#

vngen_prompt_replace_ext(id, trigger, sprite_idle, sprite_active, sprite_auto xorig, yorig, scaling, duration, ease);
ArgumentTypeDescription
idreal/stringThe ID of the prompt to replace
triggerstringThe character name to use as a new trigger for displaying the prompt (or keyword any for all characters)
sprite_idlespriteThe new sprite to draw as a prompt when waiting for user input
sprite_activespriteThe new sprite to draw as a prompt when the typewriter effect is active (or keyword none for none)
sprite_autospriteThe new sprite to draw when auto mode is enabled (or keyword none for none)
xorigreal/macroThe new horizontal sprite offset, or origin point, relative to the top-left corner
yorigreal/macroThe new vertical sprite offset, or origin point, relative to the top-left corner
scalinginteger/macroSets the new automatic scaling mode for the prompt
durationrealSets the duration of the fade transition, in seconds
easeinteger/macroSets the ease mode to perform the fade transition in

Description#

Replaces the input entity ID with new sprites and extra sprite properties and fades the old sprites to the new ones over the input duration.

As with other types of modifications, replacements made with this script are permanent and will persist until another replacement is performed. This script cannot be performed simultaneously with other replacement actions operating on the same entity ID.

See Macros & Keywords for a list of available origin points, scaling modes, and ease modes.

Example#

vngen_event() {
vngen_prompt_replace_ext("prompt", "John Doe", spr_prompt_idle, spr_prompt_active, spr_prompt_auto, orig_left, orig_center, scale_none, 1, ease_sin_in_out);
}