#RW Code Documentation
1 messages · Page 1 of 1 (latest)
im yoinkin creatures
you can contribute in https://github.com/RWModding/RainWorldDocs, ping me or @left solstice if you need access, the generated outputs will be hosted somewhere when I have the time to set it up
oh, just thought of something, I might make a script to copy the rain world xmldocs over to the IL and ON namespaces so orig and the hook event/delegate also show the documentation
Started Player.cs docs without even realizing it
Guess this is my document hell for the next year. Started with Tongue class stuff and some things related to Saint
you can always just get the important stuff and leave the rest for later
a decent number of members have self explanatory names
I’m assuming really big methods like the Update method would be best explained in an html thing rather then be confined to just the xml things, when I eventually get to doing that
you don't really have to explain methods line by line
at least not in the xmldocs
could be useful for some of the most complex and very used ones, but that would probably be a separate article instead of part of the xmldoc for the method
explaining update logic flow block by block sounds like something the wiki should have
is it just me or is there nothing here
it's giving me a 404 page
it is private
oh ok 
for legal reasons 
the xmldocs themselves and the documentation will be public, though
there's nothing there right now, though, just the class definitions
we're still setting it up
no way, https://rwmodding.github.io/api/Global.Player.html has all the player's properties and methods?! this is gonna be a gigantic help, no more searching Escort's code again!
now all I need is a list of all the hookable methods and I'll be golden
all methods are hookable
and I'd recommend just looking at the game's code instead, since you can see what each thing does
at least until stuff is properly documented, which will probably take a while
I tried opening RainWorld.exe and there's nothing there at all
whoops
check RainWorld_Data/Managed/Assembly-CSharp.dll
now I really have infinite cosmic power

Whenever someone has to look through my code I feel sorry for that person
The amount of jank and redundant stuff I throw in is probably enough to confuse people
@native ingot here is the thread on documentation, just in case you were interested in helping out