The "vngen_prompt_create" Function

Syntax#

vngen_prompt_create(id, sprite_idle, sprite_active, sprite_auto, x, y, z, transition, duration, [ease]);

Argument	Type	Description
`id`	real/string	The unique identifier to use for the new prompt
`sprite_idle`	sprite	The sprite to draw as a prompt when waiting for user input
`sprite_active`	sprite	The sprite to draw as a prompt when the typewriter effect is active (or keyword `none` for none)
`sprite_auto`	sprite	The sprite to draw when auto mode is enabled (or keyword `none` for none)
`x`	real/macro	The horizontal position to display the prompt, relative to the global offset (or keyword `auto` to position by text)
`y`	real/macro	The vertical position to display the prompt, relative to the global offset (or keyword `auto` to position by text)
`z`	real	The drawing depth of the prompt, relative to other prompts only
`transition`	script	Sets the transition animation to perform
`duration`	real	Sets the duration of the transition animation, in seconds
`[ease]`	integer/macro	Optional: Sets the ease override for the transition script

Description#

Creates a new prompt icon which will be displayed until vngen_prompt_destroy is run. Multiple prompts can exist simultaneously, however no two prompts may share the same ID. VNgen entity IDs are arbitrary and most can be either numbers or strings, but bear in mind that -1 is reserved as 'null' and cannot be used as an ID.

Unlike other entities, prompts feature an automatic position mode which will display prompts next to text--even while the typewriter effect is active.

See Included Animations and Macros & Keywords for a list of available transition animations and ease modes.

Example#

vngen_event() {
   vngen_prompt_create("prompt", spr_prompt_idle, spr_prompt_active, spr_prompt_auto, auto, auto, 0, trans_fade, 1);
}