NSL Harriet Engine Console

This document was last updated: 2020.08.21

Console Access

The Harriet game engine has a hidden operational console. This can assist enthusiasts and active developers by spawning items and debugging existing application specific use cases. The specific key to access a console instance is via the TILDE key also known as a swung dash.

It has the ASCII code: 126. For Microsoft virtual key codes, this is the VK_OEM_3 key (0xBF). On US qwerty keyboards, its typically located to the top left of your keyboard's layout below the ESC key.

This key can be toggled to switch the visibility state of the console. Since the console is the last entity to be rendered in 2d space above the 3d scene, all inputs and key strokes will be directed to the console until its visibility has been set false.

Console Command List

clear	clears the console window command history
dcount	displays the number of video device cards
exit	exits the parent application
fps	reports whether a fps counter is active
fps 1	activates a fps counter if one does not exist
fps 0	disables a fps counter if one exists
fps lowest	displays the lowest observed fps metric
fps highest	displays the highest observed fps metric
free	reports the amount of device ram available
gcard	displays the name of the graphics card
memory	reports the current ram metrics (total, free, used)
vcard	displays the name of the graphics card
vsync	reports whether vsync is active
vsync 0	disabled vsync if it is enabled
vsync 1	enables vsync is it is disabled