Game Development Community

Documentation suggestion..

by Jason Booth · in Torque Game Builder · 01/21/2006 (3:39 pm) · 2 replies

The main thing which is causing me problems right now in T2d is the lack of documentation. Some objects or methods are completely undocumented, while others have brief explanations written by the community. Some aspects of the language itself are not documented, or perhaps they are locked behind one of the other engine licencing areas I don't have access to. While the community and developers are all helpful, it's basically a big mess which makes learning t2d much harder than it should be. Proper reference documentation is sorely needed.

That said, I can think of some things which would help the situation. MaxScript has a command which is exposed on every object:

%obj.getpropnames();

this will return a list of methods available on a given object. Something like this would be extremely useful, as right now I often have to resort to simply guessing at what I might have called the actual method; which is extremely painful.

For instance, right now I'm trying to figure out if I can dynamically change the bitmap on a bitmap ctrl in the UI. I've tried setting the property directly (.bipmap = "blah"), but had more luck with the .setbitmap() method I seemed to have stumbled onto. However, it only seems to cause my bitmap to disapear, so something must be wrong. What? well, who knows.

#1
01/21/2006 (7:03 pm)
%obj.dump();


that will give you all init persist fields, dynamic fields, and method names of an object, including a one sentence description :)
#2
01/21/2006 (9:42 pm)
Wow; thats exactly what I was looking for; thanks!