Save-Point
RGSS Roadguide - Printable Version

+- Save-Point (https://www.save-point.org)
+-- Forum: Games Development (https://www.save-point.org/forum-4.html)
+--- Forum: Tutorials (https://www.save-point.org/forum-19.html)
+--- Thread: RGSS Roadguide (/thread-2901.html)



RGSS Roadguide - Trickster - 12-07-2008

RGSS Roadguide
Your Detailed Roadmap to the RGSS library
By Trickster
Proofreading by PK8 and BloodSpawn.

Introduction
First and foremost RGSS is not a programming langauge. Many are confused on what RGSS actually is. RGSS is a library written in C that extends the programming langauge Ruby, and RGSS is an acronym for Ruby Game Scripting System. It is used within RMXP and provides Graphics, Audio, and Input functions for Ruby.

How to use this guide
Reading this will not teach you how to script. However, if you know how to script then this guide will improve your scripting for RMXP. This guide just goes over the classes, methods, and limitations of RGSS. I will state each class and all of its methods example calls and common pitfalls that you should look out for when using. This is intended to explain the RMXP helpfile for this information.

Method documentation will appear as follows:
method: method_name(<required parameters>, optional parameters)
description: This is a method RAWR!
parameters: An explanation of what class each parameter needs to be and what it does.
example calls: Acceptable calls to the method with visuals when necessary
comments: Comments from the wise one Trickster himself. I will tell you how useful or how crappy the method is. Things to watch out for and other stuff.
So what's included in RGSS?
  • Classes
    • Bitmap
    • Color
    • Font
    • Plane
    • Rect
    • Sprite
    • Table
    • Tilemap
    • Tone
    • Viewport
    • Window
    • RGSSError
    • RPG::Sprite
    • RPG::Weather

  • Modules
    • Audio
    • Graphics
    • Input
    • RPG
    • RPG::Cache

  • Methods
    • load_data
    • save_data


Bitmap

Color

Font