The "vngen_option_create_transformed" Function

Syntax

vngen_option_create_transformed(id, text, sprite, spr_hover, spr_select, x, y, z, font, color, hov_x, hov_y, hov_scale, hov_color, sel_x, sel_y, sel_scale, sel_color, sel_duration, transition, duration, [ease]);
ArgumentTypeDescription
idreal/stringThe unique identifier to use for the new option
textstringThe option text to display over the background (or "" for none)
spritespriteThe sprite to display as a background
spr_hoversprite/macroThe sprite to display as a background when hovered (or keyword none for default)
spr_activesprite/macroThe sprite to display as a background when selected (or keyword none for default)
xrealThe horizontal position to display the option
yrealThe vertical position to display the option
zrealThe drawing depth and list order of the option, relative to other options only
fontfontThe font to draw text in, where fnt_default is default
colorcolorThe color to draw text in, where c_white is default
hov_xrealThe horizontal offset to shift the option when hovered
hov_yrealThe vertical offset to shift the option when hovered
hov_scalerealThe scale multiplier to shift the option when hovered
hov_colorcolorThe color to draw text in when hovered
sel_xrealThe horizontal offset to shift the option when selected
sel_yrealThe vertical offset to shift the option when selected
sel_scalerealThe scale multiplier to shift the option when selected
sel_colorcolorThe color to draw text in when selected
sel_durationrealSets the duration of hover/select animations, in seconds
transitionscriptSets the transition animation to perform
durationrealSets the duration of the transition animations, in seconds
[ease]integer/macroOptional: Sets the ease override for all option animations

Description

Creates a new option with hover and select transformations which will be displayed until any option in the current option block has been selected. The chosen option ID will be recorded as the selected choice. Options can selected by mouse/touch, or by other input devices with vngen_option_nav and vngen_option_select.

Unlike other entities, option z-index determines not just drawing depth, but also navigation order. Options with lower z-index will be considered lower in the list of options. If z-index is equal between two or more options, navigation order will automatically be set by reverse creation order, but this may or may not be visually correct. Therefore, it is recommended to always set z-index explicitly. The actual values used are inconsequential so long as they are ordered from highest to lowest.

Note that although this script is an action, it cannot be executed outside of a vngen_option block. In this way, an entire option block can be thought of as a single action.

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

Example

if vngen_event() {
if vngen_option("op_choice", 0, 0, 0.5, 0.5) {
vngen_option_create_transformed("op1", "Option 1", spr_option, spr_option_hover, spr_option_select, 0, 0, -1, fnt_Arial, c_white, 32, 0, 1.25, c_black, 0, 0, 1, c_yellow, 0.1, trans_slide_right, 1);
vngen_option_create_transformed("op2", "Option 2", spr_option, spr_option_hover, spr_option_select, 0, 50, -2, fnt_Arial, c_white, 32, 0, 1.25, c_black, 0, 0, 1, c_yellow, 0.1, trans_slide_right, 1.5);
}
}