Ancurio/mkxp-freebird
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Add MKXP.data_directory

Browse source
This commit is contained in:
Amaryllis Kulla 2021-11-06 06:33:25 +01:00
parent 8fa94c0390
commit 5d38b1f813
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/extension_doc.md
View file

@ -19,5 +19,16 @@ returns: Integer
Returns the cumulative amount of scroll events (negative if down, positive if up) inbetween the current and last `Input.update` call.
## MKXP.data_directory()
returns: String
Provides a PC-user-dependant, game-specific path to a writable directory, intended for save states, configuration and similar.
In `mkxp.conf`, both `dataPathOrg` and `dataPathApp` keys need to be set, otherwise it returns a generic directory shared by all mkxp games. It is recommended (though not required) to not put any spaces in the config strings.
Real life example:
```
dataPathOrg=dancingdragon
dataPathApp=skyborn
```
## Arbitrary key states
Use `MKXP.raw_key_states` to get the current byte array of keystates, then call `#getbyte(scancode)` with `scancode` being one of the constants defined in `SDL_scancode_map.rb`. **0** means the key is released, **1** that it is pressed.