Game Development Community

Where on TDN is the complete documentation for Console Functions

by Arthur Ogawa · in Torque Game Builder · 02/23/2007 (12:41 pm) · 12 replies

I am looking to supplement the TDN documentation for the Console Functions, but I am at a loss to how these are organized. I found the TGB Reference Utility Functions, but that part of the tree appears not to contain complete documentation for the console functions.

I'd appreciate help from anyone who has a clearer picture of how TDN is organized. Thanks for reading!
NextNext Thread
PrevPrevious Thread
More from Torque Game Builder


Torque Owner Thomas Buscaglia
#1
02/23/2007 (2:15 pm)
You can get a list of all console methods (and whatever descriptions are available) using the dumpConsoleFunctions() console method.

Torque Owner Arthur Ogawa
#2
02/23/2007 (2:45 pm)
@Thomas: Thanks for the reply! In fact, I have done just this and now have notes on the 400+ console functions and am working on docs for them (see my plan). Now that I am preparing to add documentation for some of the console functions to TDN, I need to find the existing portion of the TDN tree devoted to that information.

I have already found a place for my documentation of the TGB Console Classes and my revision of the TorqueScript_Quick_Reference. I'm now looking for the corrseponding place for the console functions, you see.

Torque 3D Owner Stephen Zepp
#3
02/23/2007 (3:24 pm)
It might be easy to overlook I guess, but the landing page for TGB on TDN:

TGB Home

Has a one click link to TorqueScript Console Functions.

Torque Owner Arthur Ogawa
#4
02/23/2007 (4:57 pm)
@Stephen: Excellent! That will be my starting point. Thank you!

I knew I saw it at one point, but then the knowledge evaporated from my head. Just having a senior moment, I guess.

Torque Owner Thomas Buscaglia
#5
02/24/2007 (5:03 pm)
Excellent work. You really went above and beyond, Arthur.

Torque Owner Arthur Ogawa
#6
02/24/2007 (6:53 pm)
@Thomas, thanks for the compliment! It's nice to be appreciated.

Torque Owner Arthur Ogawa
#7
02/26/2007 (9:16 pm)
I am now looking closely at the TorqueScript_Console_Functions. It appears that they would more accurately be called the TGE Console Functions. That is, they are more oriented towards the Torque Game Engine than Torque Game Builder, which has, I believe, a more restrictive set of console functions.

One thing strange I noticed: there is no table of contents or index, so that if you know the name of the function, you will not be able to find its web page among the 21 unless you already know something about the function. Weird. Also, there do not seem to be any "A" tags, so you cannot quote a URL pointing directly to a function. Shocking. 8-{

Would it be a problem if I prepared a TOC for these pages?

Torque Owner Thomas Buscaglia
#8
02/27/2007 (6:14 am)
Quote:Would it be a problem if I prepared a TOC for these pages?

Absolutely not. TDN exists just for that purpose - to allow the community to contribute. One of our many downfalls as a company is that we don't have a lot of resources to throw at documentation, and as a result things can become out-dated. Any addition to TDN is more than welcome! :)

Torque Owner Arthur Ogawa
#9
02/27/2007 (7:39 am)
Okay!

Torque Owner Arthur Ogawa
#10
03/15/2007 (1:51 am)
I have created a cross reference of all the Console Functions of TGE and TGB. In it are links to the TorqueScript Console Functions for those functions with documentation.

Well over 50% of the 800 or so functions lack documentation! Please consider adding documentation for a function you have used in your code.

Torque 3D Owner Matthew Langley
Torque
#11
03/15/2007 (10:07 am)
Great cross reference Arthur!

Torque Owner Arthur Ogawa
#12
03/15/2007 (2:53 pm)
Thanks, Matt!