• Announcements

    • RagingHobo

      Forum Upgraded!   07/17/2017

      We have successfully upgraded our forum to the latest version! Some things have moved around but don't worry everything is still there, we still need to find updated versions of the plugins we were using previously to restore everything to the way it was. There will be a running topic in the Feedback and Support in case you notice something wrong. Before you do so please clear your browser cache and close your browser completely to rule out a caching issue. Thank you for your patience during the outage and while we get everything back to 150%  
  • entries
    4
  • comments
    27
  • views
    633

Documentation of in-game classes

oichidan

158 views

I noticed recently that there hasn't been any documentation made on the in-game classes, such as Cache, DataManager, BattleManager... I had to move back and forth at the script editor, and print out their instance variables via Yanfly's debug script as well as printing them via a line of code for many purposes.

 

It might have been really, really convenient if one makes such documentation for ease of referencing. I guess I'll put a new blog category of RGSS3 Documentation and see what I can do there.


PhoenixSoul likes this
  Report Entry


9 Comments


What documentation do you need? The code is right there... I mean I know what you mean but...

 

but...what? :3

Share this comment


Link to comment

But what are you gonna do? List all the built-in script's methods and classes? Seems like if I wanted to look at what they did I would look at the code, though I guess the point of documentation is so you don't have to.

Share this comment


Link to comment

That's actually what I'm going to. I mean yes we can just do it, but clicking and scrolling back and forth in the editor is tedious. Think of a handy reference we can use when aliasing or redefining definitions :3 just something to kill time

Share this comment


Link to comment

You know what I think would work better? More comments! I mean the thing about the default scripts is you kinda need to know how they work more or less exactly if you are going to mess with them don't you?

Share this comment


Link to comment

Hmm... Good idea.

Comments about how they work, the return value and its class... That sounds neat. Compile all the comments to a file for neat viewing :3

Share this comment


Link to comment

Hmmm... Isn't that sorta how java documentation works? I am not sure.

 

I was imagining something like the RPG Maker VX Ace's reference in their help files, but this time it documents the classes pre-made in new projects (like Cache, DataManager, BattleManager, etc...)

 

 

Isn't there this thing called Slip Into Ruby which documents this?

 

Slip into ruby? Haven't heard, can you tell me more?

Share this comment


Link to comment