Jump to content






Documentation of in-game classes

Posted by oichidan, 18 May 2017 · 84 views

rgss3
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.




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

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

 

but...what? :3

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.

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

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?

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

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

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

May 2017

S M T W T F S
 123456
78910111213
14151617181920
21222324 25 2627
28293031