reframework

Contains some utility functions and callback creators.

Methods

reframework:save_config()

Triggers REFramework to save its configuration.

reframework:is_drawing_ui()

Returns true if the REFramework menu is open.

reframework:get_game_name()

Returns the name of the game this REFramework was compiled for.

e.g. "dmc5" or "re2"

reframework:is_key_down(key)

key is a Windows virtual key code.

reframework:get_version_string()

Returns the version as "major.minor.patch" string (e.g., "1.15.0").

reframework:get_version_major()

Returns the major version as int.

reframework:get_version_minor()

Returns the minor version as int.

reframework:get_version_patch()

Returns the patch version as int.

reframework:get_keyboard_state()

Returns the keyboard state array (256 entries, one per virtual key code). Each entry is non-zero if the key is pressed.

reframework:get_first_key_down()

Returns the first virtual key code (0-255) that is currently down, or nil if no key is pressed. Scans keyboard state in ascending order.

reframework:get_commit_count()

Returns the total number of commits on the current branch of the REFramework build.

reframework:get_branch()

Returns the branch name of the REFramework build.

ex: "master"

reframework:get_commit_hash()

Returns the commit hash of the REFramework build.

reframework:get_tag()

Returns the last tag of the REFramework build on its current branch.

ex: "v1.5.4"

reframework:get_tag_long()

reframework:get_commits_past_tag()

Returns the number of commits past the last tag.

reframework:get_build_date()

Returns the date that REFramework was built (mm/dd/yyyy).

reframework:get_build_time()

Returns the time that REFramework was built.