X1The "vngen_log_draw" Function
Syntax#
| Argument | Type | Description |
|---|---|---|
spr_background | sprite/macro | Sprite to draw as a fullscreen background while the log is open (or keyword 'none' for none) |
spr_divider | sprite/macro | Sprite to draw as a divider between logged entries (or keyword 'none' for none) |
spr_paused | sprite/macro | Sprite to draw as paused audio icon (or keyword 'none' for none) |
spr_playing | sprite/macro | Sprite to draw as playing audio icon (or keyword 'none' for none) |
sep | real | Distance in pixels between log entries and dividers (if any) |
linebreak | real | Width in pixels before text is wrapped into a new line |
font | font/macro | Override font to draw logged text in (or keyword 'inherit' for logged style) |
color | color/macro | Override color to draw logged text in (or keyword 'inherit' for logged style) |
Description#
Draws the backlog with the given stylization, when visible. By default, the log is not visible and must be toggled with vngen_toggle_log to be displayed even while this script is running. This script is intended to be run in the Draw GUI Event.
Backlog elements are designed to be responsive and can adapt to real-time changes in resolution and aspect ratio, provided the linebreak setting allows it. For this reason, it is highly recommended to use a linebreak setting relative to the dimensions of the GUI layer itself. The GUI layer can then be scaled to match the display resolution with the GameMaker Studio function display_set_gui_maximise.
note
As vngen_set_scale already scales the GUI along with other elements, if this script is active it is not necessary to run display_set_gui_maximise manually.