|real/string||The unique identifier to use for the new button|
|string||The button text to display over the background (or "" for none)|
|sprite||The sprite to display as a button background|
|sprite/macro||The sprite to display as a background when hovered (or keyword 'none' for default)|
|sprite/macro||The sprite to display as a background when selected (or keyword 'none' for default)|
|real/macro||The horizontal sprite offset, or origin point, relative to the top-left corner|
|real/macro||The vertical sprite offset, or origin point, relative to the top-left corner|
|real||The horizontal position to display the button, relative to the GUI layer|
|real||The vertical position to display the button, relative to the GUI layer|
|real||The drawing depth and list order of the button, relative to other log buttons only|
|real/macro||The horizontal position to display text, relative to the button sprite top-left corner (or keyword 'auto' for center)|
|real/macro||The vertical position to display text, relative to the button sprite top-left corner (or keyword 'auto' for center)|
|integer/macro||Sets the automatic scaling mode for the button|
|font||The font to draw text in, where |
|color||The color to draw text in, where |
|sound||The sound to play when the button is hovered (Optional, use keyword 'none' for none)|
|sound||The sound to play when the button is selected (Optional, use keyword 'none' for none)|
|integer/macro||Sets the ease override for the button animations|
Creates a new button with extra options which will be displayed while the backlog is open. The chosen button ID will be recorded as the selected choice until cleared with
vngen_log_button_clear. Buttons can selected by mouse/touch, or by other input devices with
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.
Note that although this script resembles an action, it is not and should not be executed within VNgen events. Instead, log buttons should ideally be created in the Create Event of a dedicated backlog object.
See Macros & Keywords for a list of available ease modes.