Game Development Community

Info on objects

by vsrini29 · in Torque Game Engine · 09/29/2009 (10:37 am) · 1 replies

Where do I find full documentation for the classes and their members (I will give an example in just a second). Generally, the documentation is partial and when available (online or from the offline documentation downloaded when yo buy TGA) is very consise and often simply a single line. I am looking for more details such as "what is the significance of this data member, what does it affect, how does it affect, where is it used, what additional interesting things can happen when I tweak this value, what are the variour other ways I can achieve the same effect . . . . kind of info.

Here is an example:
pitchForce is a member of class RigidShapeData (see file rigidShape.h). Where is the documentation for this? It is not there anywhere in the official html documentation suplid with TGA purchase. HoverVehicle related classes have a member with same name, but RigidShapeData is not derived from any of these classes. I looked on TDN; didn't fnd it. Searched the garage games book "The Game Programmer's Guide to Torque", did not find it.

The documentation I found for this member in HoverVehicleData (an unrelated class) is rather simple:
"A force applied forward or backward, depending on the amount of vehicle pitch."

About the author

Recent Threads

  • World editor for end user

  • #1
    09/29/2009 (11:30 am)
    I'm reasonably sure that kind of documentation does not exist in TGE/A. Mostly you find out about things by modifying them and seeing what happens, or reading the source.

    I think it'd be great to have a community project for this sort of stuff (maybe make TDN useful?). See my resource about WheeledVehicles for an example of what I'd love to see. But obviously it'd be a huge undertaking.