PDA

View Full Version : [UScript]Online Classes Reference?


Piddu
11-20-2009, 10:12 AM
I have read the UnrealScript Reference, and i saw that it explain how to write code in UScript, like how to set up an if statement, loops etc..
since i have some experience with other languages ( c/java/python ) i think i can script, but i would like a class reference like this i.e.

http://java.sun.com/javase/7/docs/api/

this are java Docs, you can see every class builded in there, read wich methods you can use with every class object, and you have a clear path for the class inheritance. when you need to know something about a class in java you can watch that doc, point the class u need and u get everything.
This is usefull since probably when someone write a class he extends an existing one.
And i think it's the same in UScript...
So does a doc like the java's one exist for UScript?

twoflyingpigs
11-20-2009, 10:29 AM
Yes, you can use UnCodeX (http://wiki.beyondunreal.com/Legacy:UnCodeX) to generate the class docs of UnrealScript sources. It's very Java-doc alike.

docmorbid
11-20-2009, 11:49 AM
Apparently no such document exists, such a basic necessity for any programming language, for it not to exist is just unbelievable.

I tried doing this with UnCodeX, original install of UDK, but I get this error message when trying to build the HTML output:

Unhandled exception: Key cannot be an empty string
History:
htmlClassOverview

Piddu
11-20-2009, 12:37 PM
i have build that
i have used as source directory the udk\deveolopment\src, i got some errors too but in the end i got the output

the HTML output is not optimal but is better than nothing...

docmorbid
11-20-2009, 12:50 PM
Well, due to the error I get when trying to do the HTML output the output ends up being incomplete so I can only view a few classes.

Piddu
11-20-2009, 12:56 PM
yes it's the same here i checked and some classes miss

DarzgL
11-20-2009, 12:59 PM
http://wiki.beyondunreal.com/Category:UDK-specific_classes

docmorbid
11-20-2009, 01:03 PM
What DarzgL posted is a new addition to the Wiki and definitely helpful although not a full API.

From another thread: Just for anyone who tries to use UnCodeX, make sure to get the beta, version 237. I tried with the last release (v232) and it gets stuck in a few places for whatever reason.

Beyond that, it makes an amazing sudo API thingy. If you want to see what kind of output it gives, here is one using UT3. http://www.codekisk.com/unreal/ut3/scriptref/

So be sure to get the development release of UnCodeX and you should be able to generate a full HTML output.

It worked for me at least.

Blade[UG]
11-20-2009, 06:05 PM
This is why I use WOTgreal. If I want to find out what a function does, I type in it's name, hold ctrl-click it, and am taken to it's definition. The output of UnCodeX, and most of the new content on the Wiki i find to be largely unhelpful.

"Search Files For" is your friend.

Wormbo
11-20-2009, 07:25 PM
TBH, I never used my wikified class pages or the UnCodeX output to really figure out what's going on. Whenever I want to find out stuff, I browse or full-text-search the source files with UnCodeX.