The "vngen_button_create_ext_transformed" Function

Syntax

vngen_button_create_ext_transformed(id, text, sprite, spr_hover, spr_select, xorig, yorig, x, y, z, tx, ty, scaling, font, color, hov_x, hov_y, hov_xscale, hov_yscale, hov_color, sel_x, sel_y, sel_xscale, sel_yscale, sel_color, sel_duration, snd_hover, snd_select, transition, duration, ease);

Argument	Type	Description
id	real/string	The unique identifier to use for the new button
text	string	The button text to display over the background (or "" for none)
sprite	sprite	The sprite to display as a button background
spr_hover	sprite/macro	The sprite to display as a background when hovered (or keyword none for default)
spr_active	sprite/macro	The sprite to display as a background when selected (or keyword none for default)
xorig	real/macro	The horizontal sprite offset, or origin point, relative to the top-left corner
yorig	real/macro	The vertical sprite offset, or origin point, relative to the top-left corner
x	real	The horizontal position to display the button
y	real	The vertical position to display the button
z	real	The drawing depth and list order of the button, relative to other buttons only
tx	real/macro	The horizontal position to display text, relative to the button sprite top-left corner (or keyword auto for center)
ty	real/macro	The vertical position to display text, relative to the button sprite top-left corner (or keyword auto for center)
scaling	integer/macro	Sets the automatic scaling mode for the button
font	font	The font to draw text in, where fnt_default is default
color	color	The color to draw text in, where c_white is default
hov_x	real	The horizontal offset to shift the button when hovered
hov_y	real	The vertical offset to shift the button when hovered
hov_xscale	real	The horizontal scale multiplier to shift the button when hovered
hov_yscale	real	The vertical scale multiplier to shift the button when hovered
hov_color	color	The color to draw text in when hovered
sel_x	real	The horizontal offset to shift the button when selected
sel_y	real	The vertical offset to shift the button when selected
sel_xscale	real	The horizontal scale multiplier to shift the button when selected
sel_yscale	real	The vertical scale multiplier to shift the button when selected
sel_color	color	The color to draw text in when selected
sel_duration	real	Sets the duration of hover/select animations, in seconds
snd_hover	sound	The sound to play when the button is hovered (or keyword none for none)
snd_select	sound	The sound to play when the button is selected (or keyword none for none)
transition	script	Sets the transition animation to perform
duration	real	Sets the duration of the transition animations, in seconds
ease	integer/macro	Sets the ease override for all button animations

Description

Creates a new button with extra features and hover and select transformations which will be displayed until vngen_button_destroy is run. The chosen button ID will be recorded as the selected choice until cleared with vngen_get_button or vngen_button_clear. Buttons can selected by mouse/touch, or by other input devices with vngen_button_nav and vngen_button_select.

Unlike other entities, button z-index determines not just drawing depth, but also navigation order. Buttons with lower z-index will be considered lower in the list of buttons. If z-index is equal between two or more buttons, 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.

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

Example

vngen_button_create_ext_transformed("btn", "Click me!", spr_btn, spr_btn_hover, spr_btn_active, orig_center, orig_center, 256, 512, -1, 72, 16, fnt_Arial, c_white, 32, 0, 1.25, 1.25, c_black, 0, 0, 1, 1, c_yellow, 0.1, snd_hover, snd_select, trans_fade, 1, ease_sin_out);