The "vngen_textbox_create" Function

Syntax

vngen_textbox_create(id, sprite, x, y, z, transition, duration, [ease]);
ArgumentTypeDescription
idreal/stringThe unique identifier to use for the new textbox
spritespriteThe sprite to draw as a textbox
xrealThe horizontal position to display the textbox, relative to the global offset
yrealThe vertical position to display the textbox, relative to the global offset
zrealThe drawing depth of the textbox, relative to other textboxes only
transitionscriptSets the transition animation to perform
durationrealSets the duration of the transition animation, in seconds
[ease]integer/macroOptional: Sets the ease override for the transition script

Description

Creates a new textbox which will be displayed until vngen_textbox_destroy is run. Multiple textboxes can exist simultaneously, however no two textboxes 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.

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

Example

vngen_event() {
vngen_textbox_create("tb", spr_textbox, 0, 1080, 0, trans_wipe_right, 2);
}