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

Document nonstandard RGSS extensions

This commit is contained in:
Jonas Kulla 2013-09-04 18:43:40 +02:00
parent efa55ce6c2
commit e8a9873125
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -92,4 +92,12 @@ If a requested font is not found, no error is generated. Instead, a built-in fon
* Audio formats other than ogg/wav (this might change in the future) * Audio formats other than ogg/wav (this might change in the future)
* Audio "pitch" parameter * Audio "pitch" parameter
* The Win32API ruby class (for obvious reasons) * The Win32API ruby class (for obvious reasons)
* Loading Bitmaps with sizes greater than the OpenGL texture size limit (around 8192 on modern cards) * Loading Bitmaps with sizes greater than the OpenGL texture size limit (around 8192 on modern cards)
## Nonstandard RGSS extensions
To alleviate possible porting of heavily Win32API reliant scripts, I have added certain functionality that you won't find in the RGSS spec. Currently this amounts to the following:
* The `Input.press?` family of functions accepts three additional button constants: `::MOUSELEFT`, `::MOUSEMIDDLE` and `::MOUSERIGHT` for the respective mouse buttons.
* The `Input` module has two additional functions, `#mouse_x` and `#mouse_y` to query the mouse pointer position relative to the game window.
* The `Graphics` module has an additional property `fullscreen`, which represents the current fullscreen mode (`true` = fullscreen, `false` = windowed).