#RW Code Documentation

1 messages · Page 1 of 1 (latest)

scarlet iron
#

This thread is for documenting RW's codebase!

left solstice
#

monkdevious im yoinkin creatures

mortal estuary
cursive ice
#

oh my godd

#

i completely forgot i was doing that on modding wiki

mortal estuary
#

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

novel crater
#

Started Player.cs docs without even realizing it hunterkek Guess this is my document hell for the next year. Started with Tongue class stuff and some things related to Saint

mortal estuary
#

you can always just get the important stuff and leave the rest for later

cursive ice
#

a decent number of members have self explanatory names

novel crater
#

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

mortal estuary
#

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

cursive ice
#

explaining update logic flow block by block sounds like something the wiki should have

wet badge
#

it's giving me a 404 page

mortal estuary
#

it is private

wet badge
#

oh ok gourmthumbsup

mortal estuary
#

for legal reasons hunterkek

#

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

wet badge
#

now all I need is a list of all the hookable methods and I'll be golden

mortal estuary
#

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

wet badge
#

I tried opening RainWorld.exe and there's nothing there at all

mortal estuary
#

RainWorld.exe is just the unity executable

#

there's no game code there

wet badge
#

whoops

mortal estuary
#

check RainWorld_Data/Managed/Assembly-CSharp.dll

wet badge
#

now I really have infinite cosmic power

trim pawn
#

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

scarlet iron
#

@native ingot here is the thread on documentation, just in case you were interested in helping out