mirrors/mkxp-z
1
0
Fork 0
mirror of https://github.com/mkxp-z/mkxp-z.git synced 2025-08-12 18:05:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reference the MKXP module in README

Browse source
This commit is contained in:
Inori 2019-09-06 17:42:31 -04:00
parent 481f23eeef
commit 413e0749d5
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -155,6 +155,17 @@ To smooth over cross-platform compatibility, functionality that you won't find i
* RGSS2 Audio functions and properties are now bound in RGSS1 mode. * RGSS2 Audio functions and properties are now bound in RGSS1 mode.
### MKXP
* `data_directory` returns the assigned directory for saves and other data files.
* `set_window_title` sets the window's title.
* `raw_key_states` returns the raw state of MKXP's keystates in the form of a string.
* `mouse_in_window` returns whether the mouse is currently located within the window.
* `platform` returns the operating system MKXP is running on (e.g. `Windows`).
* `user_language` returns the user's current locale (e.g. `en_US`).
* `game_title` returns the game's title as set in its ini.
* `power_state` returns a hash with the system power state information. Its members are `:discharging` (Boolean), `:percent` (int/nil), and `:seconds` (int/nil)
### Discord ### Discord
* This module is only included if the `discord_sdk_path` option is set to the location of the Discord GameSDK when building. * This module is only included if the `discord_sdk_path` option is set to the location of the Discord GameSDK when building.