Game Development Community

Simgroup/Simset Documentation

by Jaybill · in Torque Game Builder · 02/12/2006 (6:25 pm) · 6 replies

Is there documentation in for the T2D Simgroup/Simset somewhere that I am not seeing? There's TGE stuff I can't get at, but that obviously doesn't help much. ;-)

I'm just looking for the list of available methods and params and whatnot.
NextNext Thread
PrevPrevious Thread
More from Torque Game Builder


Torque Owner Kyle Kronyak
#1
02/12/2006 (10:27 pm)
This would be nice! In fact, documentation on most of the core features of the engine would also be nice (I spent several hours trying to get something simple with ScriptObjects to work in 1.1B1). Some things can be found easily by looking through the engine C++, but others are not as obvious.

So far the T2D engine seems pretty powerful (I've only been using it for a few days) but finding out about aspects of the engine that are not specific to T2D (and hence not in the reference guide) is a total nightmare since all of the pages on TDN are locked out!

BTW these may be helpful for those who are trying to find them:

ConsoleMethod(SimSet, listObjects, void, 2, 2, "set.listObjects();")
ConsoleMethod(SimSet, add, void, 3, 0, "set.add(obj1,...)")
ConsoleMethod(SimSet, remove, void, 3, 0, "set.remove(obj1,...)")
ConsoleMethod(SimSet, clear, void, 2, 2, "set.clear()")
ConsoleMethod(SimSet, getCount, S32, 2, 2, "set.getCount()")
ConsoleMethod(SimSet, getObject, S32, 3, 3, "set.getObject(objIndex)")
ConsoleMethod(SimSet, isMember, bool, 3, 3, "set.isMember(object)")
ConsoleMethod(SimSet, bringToFront, void, 3, 3, "set.bringToFront(object)")
ConsoleMethod(SimSet, pushToBack, void, 3, 3, "set.pushToBack(object)")

I think most of these are self-explanatory. If they're not, I can't help much as I haven't played with them all and there are no comments in the code!

I think the console commands for SimSet and SimGroup are the same, except for the way group handles object membership (i.e. an object can only be a member of one group).

Torque Owner Jaybill
#2
02/12/2006 (10:35 pm)
Agreed. Is there not some way we could have some version of the core documentation? At least the parts that are relevant to t2d?

Torque Owner Jason Cahill
Default Studio Name
#3
02/12/2006 (10:58 pm)
You can run dOxygen on the T2D source code. That will give you everything that TGE customers have. There isn't some magical missing docs. The comments in the source code make up the doc set that's available for core TAP, whether you own TGE, T2D, or TSE. An even better offering is coming soon, according to Stephen Zep.

Torque 3D Owner Joseph Albon
#4
02/13/2006 (9:17 am)
Another handy method that you may not be aware of is dump(). It will display all an object's methods (usually with required parameters) and variables, including dynamic ones.

Torque Owner Kyle Kronyak
#5
02/13/2006 (6:11 pm)
@Jason: Good call on Doxygen. Didn't think of that one!

BTW would you happen to know of any Windows Doxygen processors? I just did it on my Linux laptop but I'm sure there are plenty of people here who don't have a few extra linux / BSD machines sitting around.

I think Drupal (open source PHP CMS) has built-in doxygen support if anyone working in a game company with several people would like to host a server with it.

Torque Owner Jaybill
#6
02/13/2006 (6:14 pm)
@Kyle - There's a windows version on the doxygen site. Even has a GUI wizard. Link is right below the Linux version.

www.stack.nl/~dimitri/doxygen/download.html#latestsrc