From e8a9873125a624655831a0606c7d27477b55b013 Mon Sep 17 00:00:00 2001 From: Jonas Kulla Date: Wed, 4 Sep 2013 18:43:40 +0200 Subject: [PATCH] Document nonstandard RGSS extensions --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cd69e4c..dd39531 100644 --- a/README.md +++ b/README.md @@ -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 "pitch" parameter * The Win32API ruby class (for obvious reasons) -* Loading Bitmaps with sizes greater than the OpenGL texture size limit (around 8192 on modern cards) \ No newline at end of file +* 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).